Skip to content

Commit 6877f44

Browse files
author
Seqera AI
committed
Fix documentation: remove non-existent modes references and fix Mermaid diagram
- Remove all references to non-existent modes/overview.md page from documentation - Update usage.md to accurately reflect current pipeline implementation (design mode only) - Simplify samplesheet format documentation to match actual implementation - Update all example workflows to use correct YAML-based design approach - Fix Mermaid diagram syntax in index.md (changed flowchart to graph, added stroke styles) - Replace broken modes links with relevant existing pages (Basic Usage, Analysis Modules) - Correct documentation URLs in README.md (flouwuenne -> seqeralabs domain) Files modified: - README.md - docs/index.md - docs/getting-started/usage.md - docs/getting-started/installation.md - docs/getting-started/quick-reference.md - docs/quick-start.md
1 parent cab9436 commit 6877f44

File tree

6 files changed

+94
-93
lines changed

6 files changed

+94
-93
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -105,14 +105,13 @@ nextflow run seqeralabs/nf-proteindesign \
105105

106106
### Key Documentation Pages
107107

108-
- **[Quick Start Guide](https://flouwuenne.github.io/nf-proteindesign-2025/quick-start/)** - Get started in minutes
109-
- **[Installation](https://flouwuenne.github.io/nf-proteindesign-2025/getting-started/installation/)** - Setup and requirements
110-
- **[Usage Guide](https://flouwuenne.github.io/nf-proteindesign-2025/getting-started/usage/)** - Detailed usage instructions
111-
- **[Pipeline Modes](https://flouwuenne.github.io/nf-proteindesign-2025/modes/overview/)** - Design, Target modes
112-
- **[Analysis Tools](https://flouwuenne.github.io/nf-proteindesign-2025/analysis/ipsae/)** - Optional analysis modules
113-
- **[Parameters Reference](https://flouwuenne.github.io/nf-proteindesign-2025/reference/parameters/)** - Complete parameter list
114-
- **[Output Files](https://flouwuenne.github.io/nf-proteindesign-2025/reference/outputs/)** - Understanding results
115-
- **[Examples](https://flouwuenne.github.io/nf-proteindesign-2025/reference/examples/)** - Real-world use cases
108+
- **[Quick Start Guide](https://seqeralabs.github.io/nf-proteindesign/quick-start/)** - Get started in minutes
109+
- **[Installation](https://seqeralabs.github.io/nf-proteindesign/getting-started/installation/)** - Setup and requirements
110+
- **[Usage Guide](https://seqeralabs.github.io/nf-proteindesign/getting-started/usage/)** - Detailed usage instructions
111+
- **[Analysis Modules](https://seqeralabs.github.io/nf-proteindesign/analysis/proteinmpnn-protenix/)** - Optional analysis tools (ProteinMPNN, Protenix, ipSAE, PRODIGY, Foldseek)
112+
- **[Parameters Reference](https://seqeralabs.github.io/nf-proteindesign/reference/parameters/)** - Complete parameter list
113+
- **[Output Files](https://seqeralabs.github.io/nf-proteindesign/reference/outputs/)** - Understanding results
114+
- **[Examples](https://seqeralabs.github.io/nf-proteindesign/reference/examples/)** - Real-world use cases
116115

117116
## Samplesheet Format
118117

docs/getting-started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ Once installed, check out:
234234

235235
- [Quick Start Guide](../quick-start.md)
236236
- [Basic Usage](usage.md)
237-
- [Pipeline Modes](../modes/overview.md)
237+
- [Analysis Modules](../analysis/proteinmpnn-protenix.md)
238238

239239
---
240240

docs/getting-started/quick-reference.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,9 +309,10 @@ grep "Succeeded" results/pipeline_info/execution_trace.txt | wc -l
309309
## :material-link: Quick Links
310310

311311
- [Full Documentation](../index.md)
312-
- [Pipeline Modes](../modes/overview.md)
312+
- [Basic Usage](usage.md)
313313
- [Parameter Reference](../reference/parameters.md)
314314
- [Example Workflows](../reference/examples.md)
315+
- [Analysis Modules](../analysis/proteinmpnn-protenix.md)
315316
- [GitHub Repository](https://github.com/seqeralabs/nf-proteindesign)
316317

317318
---

docs/getting-started/usage.md

Lines changed: 68 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -21,42 +21,32 @@ nextflow run seqeralabs/nf-proteindesign \
2121

2222
## :material-file-table: Samplesheet Format
2323

24-
The samplesheet determines which mode the pipeline runs in.
25-
26-
### Mode Auto-Detection
27-
28-
The pipeline automatically detects the mode based on column headers:
29-
30-
| Column Present | Mode | Description |
31-
|----------------|------|-------------|
32-
| `design_yaml` | Design | Use pre-made YAML files |
33-
| `target_structure` | Target/Binder | Generate design variants |
34-
### Required Columns by Mode
35-
36-
=== "Design Mode"
37-
| Column | Required | Description |
38-
|--------|----------|-------------|
39-
| `sample` | ✅ | Unique sample identifier |
40-
| `design_yaml` | ✅ | Path to design YAML file |
41-
42-
=== "Target Mode"
43-
| Column | Required | Description |
44-
|--------|----------|-------------|
45-
| `sample` | ✅ | Unique sample identifier |
46-
| `target_structure` | ✅ | Path to target structure (PDB/CIF) |
47-
| `target_residues` | Optional | Binding site residues (comma-separated) |
48-
| `chain_type` | Optional | Type: `protein`, `peptide`, `nanobody` |
49-
| `min_length` | Optional | Minimum binder length |
50-
| `max_length` | Optional | Maximum binder length |
51-
52-
=== "Binder Mode"
53-
| Column | Required | Description |
54-
|--------|----------|-------------|
55-
| `sample` | ✅ | Unique sample identifier |
56-
| `target_structure` | ✅ | Path to target structure (PDB/CIF) |
57-
| `chain_type` | Optional | Type: `protein`, `peptide`, `nanobody` |
58-
| `min_length` | Optional | Minimum binder length |
59-
| `max_length` | Optional | Maximum binder length |
24+
The pipeline uses a CSV samplesheet to specify design jobs. Each row represents a separate design run.
25+
26+
### Required Columns
27+
28+
| Column | Required | Description |
29+
|--------|----------|-------------|
30+
| `sample` || Unique sample identifier |
31+
| `design_yaml` || Path to design YAML file (see below) |
32+
33+
### Optional Columns
34+
35+
Additional columns can override default parameters per sample:
36+
37+
| Column | Type | Description |
38+
|--------|------|-------------|
39+
| `num_designs` | Integer | Number of designs to generate (overrides `--num_designs`) |
40+
| `budget` | Integer | Number of final designs to keep (overrides `--budget`) |
41+
42+
### Example Samplesheet
43+
44+
```csv
45+
sample,design_yaml,num_designs,budget
46+
protein_binder,designs/egfr_binder.yaml,10000,50
47+
nanobody_design,designs/spike_nanobody.yaml,5000,20
48+
peptide_binder,designs/il6_peptide.yaml,3000,10
49+
```
6050

6151
## :material-file-document: Design YAML Format
6252

@@ -149,14 +139,14 @@ results/
149139

150140
## :material-play-circle: Example Workflows
151141

152-
### Example 1: Simple Design Mode
142+
### Example 1: Basic Protein Design
153143

154144
```bash
155145
# 1. Create design YAML
156-
cat > my_design.yaml << EOF
157-
name: antibody_target
146+
cat > protein_design.yaml << EOF
147+
name: egfr_binder
158148
target:
159-
structure: data/target.pdb
149+
structure: data/egfr.pdb
160150
residues: [10, 11, 12, 45, 46]
161151
designed:
162152
chain_type: protein
@@ -168,7 +158,7 @@ EOF
168158
# 2. Create samplesheet
169159
cat > samples.csv << EOF
170160
sample,design_yaml
171-
design1,my_design.yaml
161+
egfr_binder,protein_design.yaml
172162
EOF
173163

174164
# 3. Run pipeline
@@ -178,43 +168,54 @@ nextflow run seqeralabs/nf-proteindesign \
178168
--outdir results
179169
```
180170

181-
### Example 2: Target Mode with Analysis
171+
### Example 2: Multiple Designs with Analysis
182172

183173
```bash
184-
# 1. Create samplesheet
185-
cat > targets.csv << EOF
186-
sample,target_structure,target_residues,chain_type,min_length,max_length
187-
egfr,data/egfr.pdb,"10,11,12,45,46",protein,60,120
188-
spike,data/spike.cif,"417,484,501",nanobody,110,130
174+
# 1. Create design YAMLs for different targets
175+
cat > egfr_design.yaml << EOF
176+
name: egfr_binder
177+
target:
178+
structure: data/egfr.pdb
179+
residues: [10, 11, 12, 45, 46]
180+
designed:
181+
chain_type: protein
182+
length: [60, 120]
189183
EOF
190184

191-
# 2. Run with affinity prediction
185+
cat > spike_design.yaml << EOF
186+
name: spike_nanobody
187+
target:
188+
structure: data/spike.cif
189+
residues: [417, 484, 501]
190+
designed:
191+
chain_type: nanobody
192+
length: [110, 130]
193+
EOF
194+
195+
# 2. Create samplesheet
196+
cat > samples.csv << EOF
197+
sample,design_yaml,num_designs,budget
198+
egfr_binder,egfr_design.yaml,10000,50
199+
spike_nanobody,spike_design.yaml,5000,20
200+
EOF
201+
202+
# 3. Run with analysis modules
192203
nextflow run seqeralabs/nf-proteindesign \
193204
-profile docker \
194-
--mode target \
195-
--input targets.csv \
205+
--input samples.csv \
196206
--outdir results \
197-
--n_samples 30 \
198-
--run_prodigy
207+
--run_proteinmpnn \
208+
--run_protenix_refold \
209+
--run_prodigy \
210+
--run_consolidation
199211
```
200212

201-
### Example 3: Binder Mode (No Binding Site)
213+
### Example 3: Test Run
202214

203215
```bash
204-
# 1. Create samplesheet
205-
cat > binders.csv << EOF
206-
sample,target_structure,chain_type,min_length,max_length
207-
binder1,data/target1.pdb,protein,50,100
208-
binder2,data/target2.pdb,nanobody,110,130
209-
EOF
210-
211-
# 2. Run pipeline
216+
# Use built-in test profile
212217
nextflow run seqeralabs/nf-proteindesign \
213-
-profile docker \
214-
--mode binder \
215-
--input binders.csv \
216-
--outdir results \
217-
--n_samples 20
218+
-profile test_design_protein,docker
218219
```
219220

220221
## :material-refresh: Resume Failed Runs
@@ -348,9 +349,9 @@ nextflow run ... --n_samples 10 # Reduce batch size
348349

349350
## :material-arrow-right: Next Steps
350351

351-
- Learn about [Pipeline Modes](../modes/overview.md) in detail
352352
- Check the [Quick Reference](quick-reference.md) for common commands
353353
- Explore [Analysis Tools](../analysis/prodigy.md) integration
354+
- Review [Pipeline Parameters](../reference/parameters.md) for advanced configuration
354355

355356
---
356357

docs/index.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -67,34 +67,34 @@
6767
## :material-pipeline: Pipeline Workflow
6868

6969
```mermaid
70-
flowchart LR
71-
A[Samplesheet] --> B[Boltzgen]
70+
graph LR
71+
A[Samplesheet] --> B[Boltzgen Design]
7272
B --> C[Budget Designs]
7373
7474
C --> D{ProteinMPNN?}
75-
D -->|Yes| E[Optimize]
75+
D -->|Yes| E[Sequence Optimization]
7676
E --> F{Protenix?}
77-
F -->|Yes| G[Refold]
77+
F -->|Yes| G[Structure Refold]
7878
79-
C --> H[Analysis]
79+
C --> H[Analysis Modules]
8080
G --> H
8181
82-
H --> I[ipSAE]
83-
H --> J[PRODIGY]
84-
H --> K[Foldseek]
82+
H --> I[ipSAE Scoring]
83+
H --> J[PRODIGY Affinity]
84+
H --> K[Foldseek Search]
8585
8686
I --> L{Consolidate?}
8787
J --> L
8888
K --> L
89-
L -->|Yes| M[Report]
89+
L -->|Yes| M[Unified Report]
9090
91-
M --> N[Results]
91+
M --> N[Final Results]
9292
C --> N
9393
94-
style B fill:#9C27B0,color:#fff
95-
style E fill:#8E24AA,color:#fff
96-
style G fill:#7B1FA2,color:#fff
97-
style M fill:#6A1B9A,color:#fff
94+
style B fill:#9C27B0,stroke:#9C27B0,color:#fff
95+
style E fill:#8E24AA,stroke:#8E24AA,color:#fff
96+
style G fill:#7B1FA2,stroke:#7B1FA2,color:#fff
97+
style M fill:#6A1B9A,stroke:#6A1B9A,color:#fff
9898
```
9999

100100
## :material-rocket-launch: Quick Start

docs/quick-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -247,9 +247,9 @@ cat covid_binders/prodigy/spike_nb1_prodigy_predictions.csv
247247

248248
Now that you're up and running:
249249

250-
1. **Learn More About Modes**: Check the [Pipeline Modes](modes/overview.md) documentation
250+
1. **Learn Basic Usage**: Check the [Usage Guide](getting-started/usage.md) for detailed instructions
251251
2. **Optimize Parameters**: See the [Parameters Reference](reference/parameters.md)
252-
3. **Analyze Results**: Learn about [PRODIGY](analysis/prodigy.md) and [ipSAE](analysis/ipsae.md)
252+
3. **Enable Analysis Modules**: Learn about [ProteinMPNN/Protenix](analysis/proteinmpnn-protenix.md), [PRODIGY](analysis/prodigy.md), and [ipSAE](analysis/ipsae.md)
253253
4. **Advanced Usage**: Explore [Architecture](architecture/design.md) details
254254

255255
---

0 commit comments

Comments
 (0)