CLI Reference#
brainsets#
Command line interface for downloading and processing neural data with brainsets.
Usage
brainsets [OPTIONS] [COMMAND] [ARGS]
Commands
Manage brainsets configuration.
List available brainsets.
Download and process a single brainset.
Options
--install-completion
Install shell tab-completion for the
brainsetscommand.
brainsets config#
Manage brainsets configuration.
Usage
brainsets config [OPTIONS] COMMAND [ARGS]
Commands
brainsets config set [OPTIONS]
Set raw and processed data directories.
brainsets config show
Show previously set raw and processed data directories.
Options
--raw-dir path
Path for storing raw data.
--processed-dir path
Path for storing processed brainsets.
If no options are provided, you will be prompted to enter the paths interactively.
brainsets list#
List all pipelines provided by the installed package.
Usage
brainsets list
brainsets prepare#
Download and process a single brainset.
brainsets prepare [OPTIONS] BRAINSET
Arguments
BRAINSET
Name of the brainset to prepare (see
brainsets list). When used with--local, this should be the path to a local pipeline directory.
Options
-c, --cores number
Number of parallel jobs. Default: 4.
--raw-dir path
Path for storing raw data. Overrides config.
--processed-dir path
Path for storing processed brainset. Overrides config.
--list
Print the manifest for the brainset and exit.
-s, --single manifest index id
Prepare a single item from the manifest if provided.
--local
Prepare a brainset from a local pipeline directory instead of the built-in registry.
--download-only
Only download raw data, skip processing.
--use-active-env
Developer flag. Do not create an isolated environment for the pipeline.
-v, --verbose
Print debugging information.
Any additional arguments are passed through to the pipeline.