A Python client for OpenNeuro.
Project description
openneuro-py
A Python client for accessing OpenNeuro datasets.
Installation
via conda
conda install -c conda-forge openneuro-py
via pip
pip install openneuro-py
Basic usage – Python interface
import openneuro as on
on.download(dataset='ds000246', target_dir='data/bids')
Basic usage – command line interface
Download an entire dataset
openneuro-py download --dataset=ds000246
Specify a target directory
To 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/bids
Continue an interrupted download
Interrupted downloads will resume where they left off when you run the command again.
Advanced usage – command line interface
Exclude a directory from the download
openneuro-py download --dataset=ds000246 \
--exclude=sub-emptyroom
Download only a single file
openneuro-py download --dataset=ds000246 \
--include=sub-0001/meg/sub-0001_coordsystem.json
Note that a few essential BIDS files are always downloaded in addition.
Download or exclude multiple files
--include and --exclude can be passed mulitple times:
openneuro-py download --dataset=ds000246 \
--include=sub-0001/meg/sub-0001_coordsystem.json \
--include=sub-0001/meg/sub-0001_acq-LPA_photo.jpg
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
openneuro-py-2021.4.tar.gz
(21.4 kB
view details)
File details
Details for the file openneuro-py-2021.4.tar.gz.
File metadata
- Download URL: openneuro-py-2021.4.tar.gz
- Upload date:
- Size: 21.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 217e1e703505b8cdcc2a9328f56cbff9fa53cdf36393bc57754abb2d66a984b5 |
|
| MD5 | c5e355c9f84edea24369a508f89bd03a |
|
| BLAKE2b-256 | cb1822befc6db4e03dffeffd8dfd1b0c976428508db654655ee4589f0de3b08d |
