Skip to main content

bids: interface with datasets conforming to BIDS

Project description

PyBIDS

DOI DOI

Binder PyPI version Conda version

PyBIDS is a Python library to centralize interactions with datasets conforming BIDS (Brain Imaging Data Structure) format. For more information about BIDS visit https://bids.neuroimaging.io.

PyBIDS currently supports Python 3 on POSIX operating systems (including Mac OS). Windows is not officially supported, though most PyBIDS functionality will probably work fine.

Installation

PyBIDS is most easily installed from pip. To install the latest official release:

pip install pybids

Or, alternatively via conda:

conda install -c conda-forge pybids

If you want to live on the bleeding edge, you can install from master:

pip install git+https://github.com/bids-standard/pybids.git

Dependencies

PyBIDS has a number of dependencies. The core querying functionality requires only the BIDS-Validator package. However, most other modules require the core Python neuroimaging stack: numpy, scipy, pandas, and nibabel. The reports module additionally requires num2words. By default, all dependencies will be installed with pybids (if they aren't already available).

Usage

Get started by checking out the documentation!

Or you can start at our tutorial! You can run it interactively without installing anything via binder. Click on the link and then navigate to doc/examples/pybids_tutorial.md to explore.

Development and testing

PyBIDS uses tox to manage testing environments and ensure that the same commands can easily be run locally and in CI.

Install tox with:

pip install tox

To run tests with standard, minimal, or pre-release dependencies, use:

tox run -e [full|min|pre]

To run with a specific version, also specify py3X:

tox run -e py311-full

See tox documentation for more detail.

How to cite

To credit PyBIDS in your work, please cite both the JOSS paper and the Zenodo archive. The former provides a high level description of the package, and the latter points to a permanent record of all PyBIDS versions (we encourage you to cite the specific version you used). Example citations (for PyBIDS 0.9.3):

Yarkoni et al., (2019). PyBIDS: Python tools for BIDS datasets. Journal of Open Source Software, 4(40), 1294, https://doi.org/10.21105/joss.01294

Yarkoni, Tal, Markiewicz, Christopher J., de la Vega, Alejandro, Gorgolewski, Krzysztof J., Halchenko, Yaroslav O., Salo, Taylor, … Blair, Ross. (2019, August 8). bids-standard/pybids: 0.9.3 (Version 0.9.3). Zenodo. https://doi.org/10.5281/zenodo.3363985

Community guidelines

Bug reports, feedback, and other contributions to PyBIDS are welcome. To report a bug, request a feature, or raise a technical (non-usage-related) question for discussion, please open an issue on GitHub. Requests for support and questions about usage (where no bug is suspected) should be posted on the NeuroStars forum. For questions about the BIDS specification or BIDS-Validator, please see the corresponding repositories. For general BIDS-related discussion, see the bids-discussion mailing list.

Pull requests are always welcome. If you have any doubts about the suitability of a PR, or want to discuss implementation-related issues, feel free to open an issue for discussion.

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

pybids-0.17.2.tar.gz (13.2 MB view details)

Uploaded Source

Built Distribution

pybids-0.17.2-py3-none-any.whl (14.9 MB view details)

Uploaded Python 3

File details

Details for the file pybids-0.17.2.tar.gz.

File metadata

  • Download URL: pybids-0.17.2.tar.gz
  • Upload date:
  • Size: 13.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for pybids-0.17.2.tar.gz
Algorithm Hash digest
SHA256 e0ca455c6876b8e1c28cc6b6d77085e90cca0b21103623759a8c8da2511cc924
MD5 3d95a5e6e7178b3637fa2a3580bbe2bd
BLAKE2b-256 d224aa97cda3d1b24cc1edc3952e78fb68de938251a6c3d942313086b6df3cec

See more details on using hashes here.

Provenance

File details

Details for the file pybids-0.17.2-py3-none-any.whl.

File metadata

  • Download URL: pybids-0.17.2-py3-none-any.whl
  • Upload date:
  • Size: 14.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for pybids-0.17.2-py3-none-any.whl
Algorithm Hash digest
SHA256 68f8c77f0063f6f4d6002e07a7d2b7239a3d6f0904a484f23594490632bcabbf
MD5 b0ace080c623d84d0888f63165dd267a
BLAKE2b-256 2b29e627b10e36c8149d09aadeb54f27d209c2a41502d8cbe68839c8e3b33649

See more details on using hashes here.

Provenance

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