Skip to main content

A Python client for OpenNeuro.

Project description

openneuro-py

A leightweight Python client for accessing OpenNeuro datasets.

Installation

via pip

pip install openneuro-py

via conda

conda install -c conda-forge openneuro-py

Basic usage

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

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

Project details


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-2020.0.tar.gz (16.8 kB view details)

Uploaded Source

File details

Details for the file openneuro-py-2020.0.tar.gz.

File metadata

  • Download URL: openneuro-py-2020.0.tar.gz
  • Upload date:
  • Size: 16.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.6.0.post20201009 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.6

File hashes

Hashes for openneuro-py-2020.0.tar.gz
Algorithm Hash digest
SHA256 2c4af2325a569b84867e65e7efc9c892e36308c31bf55f420e108b7c54d67c1e
MD5 fc4b5c3944564474e75d540a808b077e
BLAKE2b-256 9738d6dcf9ab2ede9358037864cf131d84c277d327b2fef74f639f9671f4bc59

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page