nipoppy pipeline install

Note

This command calls the nipoppy.workflows.pipeline_store.install.PipelineInstallWorkflow class from the Python API internally.

nipoppy pipeline install

Install a new pipeline into a dataset.

The source of the pipeline can be a local directory or a Zenodo ID.

nipoppy pipeline install [OPTIONS] SOURCE [DATASET_ARGUMENT]

Options

--sandbox

Use the Zenodo sandbox API for tests.

--dataset <dpath_root>

Path to the root of the dataset (default is current working directory).

-f, --force, --overwrite

Overwrite existing pipeline directory if it exists.

-n, --dry-run

Print commands but do not execute them.

-v, --verbose

Verbose mode (Show DEBUG messages).

--layout <fpath_layout>

Path to a custom layout specification file, to be used instead of the default layout.

-y, --assume-yes, --yes

Assume yes to all questions.

Arguments

SOURCE

Required argument

DATASET_ARGUMENT

Optional argument