The `fw export bids` Command

If you have a project that follows the BIDS format, you can use the CLI to download the project so it stays in the BIDS format.

Prefer videos?

We also have a collection of webinars on using BIDS and Flywheel:

Prerequisites

It is required that your project is already in the BIDS format to use the export bids command. If your project isn't yet in BIDS format, see our resources for help transitioning to BIDS. This also includes running the BIDS curation gear on your project.

Usage

fw export bids [Project in Flywheel] [Destination folder] [optional flags]

Required Arguments

Required Argument	Description
`-p`, `--project`	The Project label in Flywheel. If the project label includes spaces, make sure to use quotes. For example, `"My Project"`.
`[dest folder]`	The path to the folder on your computer to where you want to export the data.

Optional Arguments

Export Bids

Optional Argument	Description
`-p \<label>`, `--project \<label>`	Sets the label for the project
`--subject SUBJECT`	Exports data for a single subject (ex. sub-01)
`--session SESSION`	Exports data from a single session (ex. ses-01)
`--data-type DATA TYPE`	Exports only the given data type (ex. func). For multiple data types, use this flag multiple times. For example: `fw export bids ... --data-type func --data-type anat`
`--source-data`	Includes source data

General

Optional Argument	Description
`-h`, `--help`	Show help message and exit.
`-C PATH`, `--config-file`	Specify configuration options via config file.*
`--no-config`	Do NOT load the default configuration file.
`-y`, `--yes`	Assume the answer is yes to all prompts.
`--ca-certs CA_CERTS`	Path to a local Certificate Authority certificate bundle file. This option may be required when using a private Certificate Authority.
`--timezone TIMEZONE`	Set the effective local timezone to use when uploading data.
`-q`, `--quiet`	Squelch log messages to the console.
`-d`, `--debug`	Turn on debug logging.
`-v`, `--verbose`	Get more detailed output.

* Learn more about how to create this file.

Examples

fw export bids -p "Project Name" [Destination folder]

$ fw export bids -p "Anxiety Study" ~/Documents/FlywheelData
INFO: Verify download directory exists
INFO: Processing project files
INFO: Processing session files
INFO: Processing acquisition files
INFO: Downloading project files
INFO: Downloading session files
INFO: Downloading acquisition files
INFO: Downloading acquisition file: sub-13_inplaneT2.nii.gz
...

Your data is downloaded to your computer, and your project maintains its BIDS format.

The fw export bids Command