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

Uploaded Source

File details

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

File metadata

  • Download URL: openneuro-py-2020.1.tar.gz
  • Upload date:
  • Size: 16.9 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.1.tar.gz
Algorithm Hash digest
SHA256 21522be2d5f89df5e22c82afc85651d768b63d5184679546a34b8d56bd24eeeb
MD5 be9bfc0d648dd12f8a4aa171720c0505
BLAKE2b-256 5ef2a6a6fcb6c1217883b3adc8967cfd58bbfc8f4a220f3ba1d4ab7319d0b42d

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