A Python client for accessing OpenNeuro datasets.
# via conda:
conda install -c conda-forge openneuro-py
# or via pip:
pip install openneuro-pyTo get basic support for Jupyter Lab, Jupyter Notebook, IPython interactive
sessions, and VS Code's interactive Jupyter interface, you will also need to
install ipywidgets:
# via conda:
conda install -c conda-forge ipywidgets
# or via pip:
pip install ipywidgetsopenneuro-py --help
openneuro-py download --help
openneuro-py login --helpopenneuro-py download --dataset=ds000246To store the downloaded files in a specific directory, use the
--target_dir switch. The directory will be created if it doesn't exist
already.
openneuro-py download --dataset=ds000246 \
--target_dir=data/bidsInterrupted downloads will resume where they left off when you run the command again.
openneuro-py download --dataset=ds000246 \
--exclude=sub-emptyroomopenneuro-py download --dataset=ds000246 \
--include=sub-0001/meg/sub-0001_coordsystem.jsonNote that a few essential BIDS files are always downloaded in addition.
--include and --exclude can be passed multiple times:
openneuro-py download --dataset=ds000246 \
--include=sub-0001/meg/sub-0001_coordsystem.json \
--include=sub-0001/meg/sub-0001_acq-LPA_photo.jpgTo download private datasets, you will need an API key that grants you access permissions. Go to OpenNeuro.org, My Account → Obtain an API Key. Copy the key, and run:
openneuro-py loginPaste the API key and press return.
import openneuro as on
on.download(dataset='ds000246', target_dir='data/bids')
![dependabot[bot]](https://avatars.githubusercontent.com/u/49699333?size=120)
![pre-commit-ci[bot]](https://avatars.githubusercontent.com/u/66853113?size=120)
