Building & Installation

This page covers contributor and maintainer build and local installation flows.

Build From Source

git clone https://github.com/nf-neuro/nf-bids.git
cd nf-bids
git submodule update --init --recursive
./gradlew assemble

Expected output artifact:

  • build/libs/nf-bids-0.3.0.jar

Install Into Local Nextflow Cache

./gradlew install
# or
make install

This installs under ~/.nextflow/plugins/nf-bids-0.3.0/.

Verify Local Build Is Used

Run any workflow that declares id 'nf-bids@0.3.0' and uses include { fromBIDS } from 'plugin/nf-bids'.

If changes do not appear at runtime, reinstall with make install after rebuilding.