Quickstart

Run your first enzyme design request in about 5 minutes. You'll need a free account — create one here.

1

Install the SDK

Python 3.8+ required. Install via pip:

Shell 
pip install fermvyne-sdk

The SDK installs the fermvyne Python package and its dependencies (httpx, pydantic, optional pandas for DataFrame output).

2

Authenticate with your API key

Get your API key from the dashboard after creating a free account. Keep it in an environment variable — never commit to source control.

Shell 
export FERMVYNE_API_KEY="fvyn_your_key_here"
Python 
import os
import fermvyne

client = fermvyne.Client(
  api_key=os.environ["FERMVYNE_API_KEY"]
)
3

Run your first design request

Provide substrate and product SMILES strings, your optimization targets, and the expression host. The platform returns ranked candidates with biophysical predictions.

Python 
# Design a thermostable reductase for E. coli expression
result = client.design(
  substrate="CC(=O)Nc1ccc(O)cc1",  # substrate SMILES
  product="CC(O)Nc1ccc(O)cc1",    # product SMILES
  targets={
    "tm_min": 60,         # minimum Tm target in °C
    "host": "ecoli",      # expression host
    "n_candidates": 12   # number of candidates to return
  }
)

# Print ranked results
for seq in result.candidates:
  print(
    f"Rank {seq.rank}: Tm={seq.tm_estimate}°C, "
    f"expr={seq.expression_score}, "
    f"solubility={seq.solubility_prob:.2f}"
  )

# Save top candidate as FASTA
result.candidates[0].save_fasta("top_candidate.fasta")

Next steps

Once your first design runs successfully: