mcpField
B
boltzgen

boltzgen

github.com/adaptyvbioOther17235 installsUpdated 20w ago
Repository

About boltzgen

BoltzGen is a tool for all-atom protein design, intended for research workflows involving protein, peptide, nanobody, or antibody binders. It uses YAML specifications and multiple design protocols to generate structures, sequences, and metrics, and can run locally or through Modal.

Key features

  1. 01Defines design specifications in YAML
  2. 02Supports five protein and binder protocols
  3. 03Produces structures, sequences, and confidence metrics
  4. 04Checks configuration files before running
  5. 05Runs locally or through Modal

Use cases

  1. 01Design protein or peptide binders
  2. 02Generate proteins that bind small molecules
  3. 03Design nanobody or antibody CDRs
  4. 04Generate and rank batches of structure candidates

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/adaptyvbio/protein-design-skills --skill boltzgen

After installing, type/boltzgenin Claude Code to confirm it loaded.

Bundled filesreferences/yaml-spec.md

Details

From the project README

BoltzGen All-Atom Design

Prerequisites

RequirementMinimumRecommended
Python3.11+3.12
CUDA12.0+12.1+
GPU VRAM24GB48GB (L40S)
RAM32GB64GB

How to run

First time? See Getting started to set up Modal and biomodals.

Option 1: Modal (recommended)
# Clone biomodals
git clone https://github.com/hgbrian/biomodals && cd biomodals

# Run BoltzGen (requires YAML config file)
modal run modal_boltzgen.py \
  --input-yaml binder_config.yaml \
  --protocol protein-anything \
  --num-designs 50

# With custom GPU
GPU=L40S modal run modal_boltzgen.py \
  --input-yaml binder_config.yaml \
  --protocol protein-anything \
  --num-designs 100

GPU: L40S (48GB) recommended | Timeout: 120min default

Available protocols: protein-anything, peptide-anything, protein-small_molecule, nanobody-anything, antibody-anything

Option 2: Local installation
git clone https://github.com/HannesStark/boltzgen.git
cd boltzgen
pip install boltzgen   # or: pip install -e .

# Driven by the boltzgen CLI with a YAML design spec
boltzgen run binder_config.yaml \
  --output out/ \
  --protocol protein-anything \
  --num_designs 50

The first run downloads model weights (~6GB) to ~/.cache. Verify a spec with boltzgen check binder_config.yaml before a full run.

GPU: L40S (48GB) | Time: ~30-60s per design

Key parameters (CLI)

ParameterDefaultDescription
--input-yamlrequiredPath to YAML design specification
--protocolprotein-anythingDesign protocol
--num-designs10Number of designs to generate
--stepsallPipeline steps to run (e.g., design inverse_folding)

YAML configuration

BoltzGen uses an entity-based YAML format where you specify designed proteins and target structures as entities.

Important notes:

  • Residue indices use label_seq_id (1-indexed), not author residue numbers
  • File paths are relative to the YAML file location
  • Target files should be in CIF format (PDB also works but CIF preferred)
  • Run boltzgen check config.yaml to verify your specification before running
Basic Binder Config
entities:
  # Designed protein (variable length 80-140 residues)
  - protein:
      id: B
      sequence: 80..140

  # Target from structure file
  - file:
      path: target.cif
      include:
        - chain:
            id: A
      # Specify binding site residues (optional but recommended)
      binding_types:
        - chain:
            id: A
            binding: 45,67,89
Binder with Specific Binding Site
entities:
  - protein:
      id: G
      sequence: 60..100

  - file:
      path: 5cqg.cif
      include:
        - chain:
            id: A
      binding_types:
        - chain:
            id: A
            binding: 343,344,251
      structure_groups: "all"
Peptide Design (Cyclic)
entities:
  - protein:
      id: S
      sequence: 10..14C6C3  # With cysteines for disulfide

  - file:
      path: target.cif
      include:
        - chain:
            id: A

constraints:
  - bond:
      atom1: [S, 11, SG]
      atom2: [S, 18, SG]  # Disulfide bond

Design protocols

ProtocolUse Case
protein-anythingDesign proteins to bind proteins or peptides
peptide-anythingDesign cyclic peptides to bind proteins
protein-small_moleculeDesign proteins to bind small molecules
nanobody-anythingDesign nanobody CDRs
antibody-anythingDesign antibody CDRs

Output format

output/
├── sample_0/
│   ├── design.cif         # All-atom structure (CIF format)
│   ├── metrics.json       # Confidence scores
│   └── sequence.fasta     # Sequence
├── sample_1/
│   └── ...
└── summary.csv

Note: BoltzGen outputs CIF format. Convert to PDB if needed:

from Bio.PDB import MMCIFParser, PDBIO
parser = MMCIFParser()
structure = parser.get_structure("design", "design.cif")
io = PDBIO()
io.set_structure(structure)
io.save("design.pdb")

Sample output

Successful run
$ modal run modal_boltzgen.py --input-yaml binder.yaml --protocol protein-anything --num-designs 10
Running: boltzgen run binder.yaml --output /tmp/out --protocol protein-anything --num_designs 10
[INFO] Loading BoltzGen model...
[INFO] Generating designs...
[INFO] Running inverse folding...
[INFO] Running structure prediction...
[INFO] Filtering and ranking...
[INFO] Pipeline complete

Results saved to: ./out/boltzgen/2501161234/

Output directory structure:

out/boltzgen/2501161234/
├── intermediate_designs/           # Raw diffusion outputs
│   ├── design_0.cif
│   └── design_0.npz
├── intermediate_designs_inverse_folded/
│   ├── refold_cif/                 # Refolded complexes
│   └── aggregate_metrics_analyze.csv
└── final_ranked_designs/
    ├── final_10_designs/           # Top designs
    └── results_overview.pdf        # Summary plots

What good output looks like:

  • Refolding RMSD < 2.0A (design folds as predicted)
  • ipTM > 0.5 (confident interface)
  • All designs complete pipeline without errors

Decision tree

Should I use BoltzGen?
│
├─ What type of design?
│  ├─ All-atom precision needed → BoltzGen ✓
│  ├─ Ligand binding pocket → BoltzGen ✓
│  └─ Standard miniprotein → RFdiffusion (faster)
│
├─ What matters most?
│  ├─ Side-chain packing → BoltzGen ✓
│  ├─ Speed / diversity → RFdiffusion
│  ├─ Highest success rate → BindCraft
│  └─ AF2 optimization → ColabDesign
│
└─ Compute resources?
   ├─ Have L40S/A100 (48GB+) → BoltzGen ✓
   └─ Only A10G (24GB) → Consider RFdiffusion

Typical performance

Campaign SizeTime (L40S)Cost (Modal)Notes
50 designs30-45 min~$8Quick exploration
100 designs1-1.5h~$15Standard campaign
500 designs5-8h~$70Large campaign

Per-design: ~30-60s for typical binder.

Adaptyv's own tests of these models showed BoltzGen costing about $1.80 per accepted design, averaged across 7 targets (the generation estimates above do not include the extra sampling and refolding needed to reach an accepted design).


Verify

find output -name "*.cif" | wc -l  # Should match num_samples

Troubleshooting

Verify config first: Always run boltzgen check config.yaml before running the full pipeline Slow generation: Use fewer designs for initial testing, then scale up OOM errors: Use A100-80GB or reduce --num-designs Wrong binding site: Residue indices use label_seq_id (1-indexed), check in Molstar viewer

Error interpretation
ErrorCauseFix
RuntimeError: CUDA out of memoryLarge design or long proteinUse A100-80GB or reduce designs
FileNotFoundError: *.cifTarget file not foundFile paths are relative to YAML location
ValueError: invalid chainChain not in targetVerify chain IDs with Molstar or PyMOL
modal: command not foundModal CLI not installedRun pip install modal && modal setup

Next: Validate with boltz or chai → protein-qc for filtering.

Comments

Markdown supported