Concepts
Key ideas grouped for quick orientation. Each page is short and practical.
- Projects & Paths: what a project is and how paths are based.
- Context (ctx) Model: what goes into
ctx
and how templates use it. - Templates & Rendering: descriptor, files, Jinja, and ad‑hoc rules.
- Parameters & Precedence: defaults, project, CLI
--param
. - Run Lifecycle & Hooks: render → hooks → run → hooks.
- Publishing & Resolvers: name key outputs and store them.
- Workflows vs Templates: when to use each.
- Project vs Ad‑hoc: base directories and state differences.
- Stores & Cache: add/activate/update and local cache.
- State & Versioning:
project.yaml
andstores.yaml
. - Reproducibility & Environments: pin tools and record context.
- Path Resolution Rules: placeholders and resolved locations.
- Error Handling & Diagnostics: quick troubleshooting.
- Naming & IDs: conventions for ids and publish keys.
- Performance & Caching: efficient renders and reuse.
- Security & Trust: safe usage of BRS code and scripts.
- Interop with Workflow Engines: Nextflow/Snakemake/CWL patterns.
Table of contents
- Projects & Paths
- Context (ctx) Model
- Templates & Rendering
- Parameters & Precedence
- Run Lifecycle & Hooks
- Publishing & Resolvers
- Workflows vs Templates
- Project vs Ad‑hoc
- Stores & Cache
- State & Versioning
- Reproducibility & Environments
- Path Resolution Rules
- Error Handling & Diagnostics
- Naming & IDs
- Security & Trust
- Interop with Workflow Engines