Skip to content
Merged

Dev #61

Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,32 @@ nextflow run bigbio/quantmsdiann \
```

> [!NOTE]
> DIA-NN 2.x images are hosted on `ghcr.io/bigbio` and may require authentication for private registries. The `diann_v2_1_0` and `diann_v2_2_0` profiles force Docker mode by default; for Singularity, override with your own config.
> DIA-NN 1.8.1 uses a public BioContainers image (no auth). DIA-NN 2.x images are on `ghcr.io/bigbio` and require GHCR authentication. You can also build containers yourself from [quantms-containers](https://github.com/bigbio/quantms-containers).

### Using custom containers on HPC

For HPC/Singularity deployments with local `.sif` files, create a config that overrides the container:

```groovy
// hpc_diann.config
process {
withLabel: diann {
container = '/path/to/sif/diann-2.5.0.sif'
}
}
```

```bash
nextflow run bigbio/quantmsdiann \
-profile singularity -c hpc_diann.config \
--diann_version '2.5.0' \
--input sdrf.tsv --database db.fasta --outdir results
```

> [!IMPORTANT]
> Set `--diann_version` to match your container. Do **not** combine with `-profile diann_v2_5_0` (it would override your local path).
Comment on lines +374 to +375

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Broaden the profile conflict warning beyond diann_v2_5_0.

The override conflict applies to any diann_v* profile that sets process.withLabel: diann.container, not just diann_v2_5_0. Narrow wording can lead users to combine other version profiles and unintentionally override their local .sif path.

✏️ Suggested doc fix
 > [!IMPORTANT]
-> Set `--diann_version` to match your container. Do **not** combine with `-profile diann_v2_5_0` (it would override your local path).
+> Set `--diann_version` to match your container. Do **not** combine this with any `diann_v*` profile (for example `diann_v2_5_0`), because those profiles set `withLabel: diann` container values and will override your local path.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
> [!IMPORTANT]
> Set `--diann_version` to match your container. Do **not** combine with `-profile diann_v2_5_0` (it would override your local path).
> [!IMPORTANT]
> Set `--diann_version` to match your container. Do **not** combine this with any `diann_v*` profile (for example `diann_v2_5_0`), because those profiles set `withLabel: diann` container values and will override your local path.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/usage.md` around lines 374 - 375, The warning about profile conflicts is
too narrow: instead of calling out only `-profile diann_v2_5_0`, update the doc
text to warn that any `diann_v*` profile which sets `process.withLabel:
diann.container` will override a local `.sif` path, and tell users to avoid
combining `--diann_version` with any `diann_v*` profile; reference the
`--diann_version` flag, the `-profile diann_v2_5_0` example, and the
`process.withLabel: diann.container` setting in the paragraph so the guidance
covers all versioned diann profiles.


For the full guide on building containers, GHCR authentication, version switching, and SLURM deployment, see the [Containers documentation](https://quantmsdiann.quantms.org/containers/).

## Fine-Tuning Deep Learning Models (DIA-NN 2.0+)

Expand Down
Loading