Repository navigation
feat(diann): DIA-NN Enterprise 2.5.1 support (--kb knowledge base + --license) - #102
Conversation
…-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 reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
…terprise:2.5.1 (hyphen)
… the enterprise profile
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
diann_v2_5_1_enterprise(conf/diann_versions/v2_5_1_enterprise.config):diann_version=2.5.1,diann_enterprise=true, containerghcr.io/bigbio/diann_enterprise:2.5.1(separate repo from the academicdiann:2.5.1). The image bundles the binary + KB model (base232.nnkb); no license.--enable_kb(default false): adds--kbonly toPRELIMINARY_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 ondiann_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).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 inquantms-containers. Nothing license- or binary-related is in this PR (diff is pipeline code + docs only).Verification (local)
nextflow configparses for the default anddiann_v2_5_1_enterpriseprofiles (resolvesdiann_version=2.5.1,diann_enterprise=true, enterprise container).nextflow lintshows no real DSL errors;nf-core pipelines lint0 failures; prettier/eof/whitespace clean.Out of scope
--auto-aff(CPU affinity, Windows-only) — reachable via--extra_argsif ever needed.Not runnable in standard CI
A full Enterprise run needs the private
diann_enterprise:2.5.1image 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.