Installation Guide

Install nf-bids from the Nextflow Plugin Registry and verify the runtime prerequisites for workflow execution.

See also Dependency Matrix and libBIDS.sh Dependency for version and compatibility details.

End-User Installation (Nextflow Plugin Registry)

The plugin is published to the Nextflow Plugin Registry. No build tools are required; Nextflow downloads and caches the plugin automatically on first run.

MacOS users

MacOS ships an outdated version of BASH. To use nf-bids, update it using Homebrew :

brew update
brew install bash

Add the following block to your nextflow.config:

plugins {
    id 'nf-bids@{plugin-version}'
}

Then import the Channel.fromBIDS factory in your workflow:

include { fromBIDS }                      from 'plugin/nf-bids'

What this gives you: Nextflow resolves and caches the plugin JAR under ~/.nextflow/plugins/nf-bids-0.3.0/ the first time the workflow runs. Failure mode: If the registry is unreachable or the version string is wrong, Nextflow aborts before execution starts with a plugin-resolution error. Re-check the version string against the registry listing.

For plugin development and local source installation, use Development Building & Installation.

Next Step

Continue with Channel.fromBIDS Usage & Parameters.