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.
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
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).
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.
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.
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
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.