Skip to content

feat(diann): DIA-NN Enterprise 2.5.1 support (--kb knowledge base + --license) - #102

Merged
ypriverol merged 4 commits into
devfrom
feat/diann-enterprise
Jun 3, 2026
Merged

ypriverol merged 4 commits into
devfrom
feat/diann-enterprise

Conversation

@ypriverol

Copy link
Copy Markdown
Contributor

Summary

Adds support for the DIA-NN Enterprise build (v2.5.1 preview). Its headline feature is the Knowledge Base (--kb), which boosts identifications — primarily on human data. Enterprise also needs a license key at runtime.

What's included

  • New profile diann_v2_5_1_enterprise (conf/diann_versions/v2_5_1_enterprise.config): diann_version=2.5.1, diann_enterprise=true, container ghcr.io/bigbio/diann_enterprise:2.5.1 (separate repo from the academic diann:2.5.1). The image bundles the binary + KB model (base232.nnkb); no license.
  • --enable_kb (default false): adds --kb only to PRELIMINARY_ANALYSIS (the first-pass search vs the predicted library). Per Vadim it's ignored in the second pass and doesn't belong in library creation. Gated on diann_enterprise (hard error otherwise); warns if set without a license.
  • --diann_license <file> (default null): staged into all 6 DIA-NN binary processes and passed as --license. If unset, DIA-NN falls back to a key placed next to the binary in a private local build (both mechanisms confirmed by Vadim).
  • Schema, docs/usage.md (Enterprise section), docs/parameters.md, README support row, CHANGELOG, design spec.

Security

The Enterprise license key is a per-user secret and is never committed or baked into the shared image — it's supplied only at runtime via --diann_license. The Enterprise binary is not redistributable; the container recipe lives in quantms-containers. Nothing license- or binary-related is in this PR (diff is pipeline code + docs only).

Verification (local)

  • nextflow config parses for the default and diann_v2_5_1_enterprise profiles (resolves diann_version=2.5.1, diann_enterprise=true, enterprise container).
  • All 11 DIA-NN call sites pass the license channel (arity verified); nextflow lint shows no real DSL errors; nf-core pipelines lint 0 failures; prettier/eof/whitespace clean.

Out of scope

  • --auto-aff (CPU affinity, Windows-only) — reachable via --extra_args if ever needed.
  • Extra Enterprise QC metrics (Empirical.Quality, peak-shape) are emitted automatically; downstream parsing selects columns by name, so it tolerates them.

Not runnable in standard CI

A full Enterprise run needs the private diann_enterprise:2.5.1 image and a valid license key, so it can't run in public CI. End-to-end validation is a maintainer-run integration test. Academic-profile CI is unaffected.

Depends on: building/publishing ghcr.io/bigbio/diann_enterprise:2.5.1 in quantms-containers from the Enterprise Dockerfile.

ypriverol added 2 commits June 3, 2026 10:07
…-license)

- New profile diann_v2_5_1_enterprise + conf/diann_versions/v2_5_1_enterprise.config
  (diann_version=2.5.1, diann_enterprise=true, container
  ghcr.io/bigbio/diann_enterprise:2.5.1; bundles binary+KB, no license).
- New params: diann_enterprise (false), enable_kb (false), diann_license (null).
- --enable_kb adds DIA-NN --kb only to PRELIMINARY_ANALYSIS (first-pass search);
  ignored in second pass / library creation. Gated on diann_enterprise (errors
  otherwise); warns if enabled without a license.
- --diann_license stages the key into all 6 DIA-NN binary processes as --license,
  with fallback to a key next to the binary when unset. The key is a per-user
  secret and is never committed or bundled into the shared image.
- Schema, parameters.md, usage.md (Enterprise section), README support row, CHANGELOG.

Verified: config parses for default + enterprise profiles, resolver/guards wired,
nextflow lint (no real DSL errors), nf-core lint 0 failures, format hooks clean.
@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@coderabbitai

coderabbitai Bot commented Jun 3, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6704d576-c032-41fd-a7a6-fd8d09704830

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/diann-enterprise

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions

github-actions Bot commented Jun 3, 2026 •

Copy link
Copy Markdown

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 6695c86

+| ✅ 108 tests passed       |+
#| ❔  18 tests were ignored |#
#| ❔   1 tests had warnings |#
!| ❗   4 tests had warnings |!
Details

❗ Test warnings:

  • files_exist - File not found: conf/igenomes.config
  • files_exist - File not found: conf/igenomes_ignored.config
  • files_exist - File not found: .github/workflows/awstest.yml
  • files_exist - File not found: .github/workflows/awsfulltest.yml

❔ Tests ignored:

❔ Tests fixed:

✅ Tests passed:

Run details

  • nf-core/tools version 4.0.2
  • Run at 2026-06-03 10:45:10

@ypriverol
ypriverol merged commit 2d61859 into dev Jun 3, 2026
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant