PyBIDS

PyBIDS: Python tools for BIDS datasets - Published in JOSS (2019)

https://github.com/bids-standard/pybids

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 12 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
    20 of 73 committers (27.4%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

api bids python

Keywords from Contributors

neuroimaging eeg closember neuroscience meg magnetoencephalography data-storage git-annex usable electroencephalography

Scientific Fields

Mathematics Computer Science - 84% confidence
Last synced: 4 months ago · JSON representation

Repository

Python tools for querying and manipulating BIDS datasets.

Basic Info
Statistics
  • Stars: 247
  • Watchers: 19
  • Forks: 128
  • Open Issues: 105
  • Releases: 55
Topics
api bids python
Created over 9 years ago · Last pushed 4 months ago
Metadata Files
Readme Changelog License Zenodo

README.md

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.

Owner

  • Name: Brain Imaging Data Structure
  • Login: bids-standard
  • Kind: organization

JOSS Publication

PyBIDS: Python tools for BIDS datasets
Published
August 12, 2019
Volume 4, Issue 40, Page 1294
Authors
Tal Yarkoni ORCID
University of Texas at Austin
Christopher J. Markiewicz ORCID
Stanford University
Alejandro de la Vega ORCID
University of Texas at Austin
Krzysztof J. Gorgolewski ORCID
Stanford University
Taylor Salo ORCID
Florida International University
Yaroslav O. Halchenko ORCID
Dartmouth College
Quinten McNamara
University of Texas at Austin
Krista DeStasio ORCID
University of Oregon
Jean-Baptiste Poline ORCID
McGill University
Dmitry Petrov
University of Southern California
Valérie Hayot-Sasson ORCID
Concordia University
Dylan M. Nielson ORCID
National Institute of Mental Health
Johan Carlin ORCID
MRC Cognition and Brain Sciences Unit
Gregory Kiar ORCID
Montreal Neurological Institute and Hospital
Kirstie Whitaker ORCID
Alan Turing Institute
Elizabeth DuPre ORCID
Montreal Neurological Institute and Hospital
Adina Wagner ORCID
Otto-von-Guericke University Magdeburg
Lee S. Tirrell ORCID
CorticoMetrics LLC
Mainak Jas ORCID
Télécom ParisTech, France
Michael Hanke ORCID
Otto-von-Guericke University Magdeburg
Russell A. Poldrack ORCID
Stanford University
Oscar Esteban ORCID
Stanford University
Stefan Appelhoff ORCID
Max Planck Institute for Human Development, Berlin, Germany
Chris Holdgraf ORCID
University of California at Berkeley
Isla Staden ORCID
Queen Mary University London
Bertrand Thirion ORCID
INRIA
Dave F. Kleinschmidt ORCID
Rutgers University
John A. Lee ORCID
National Institute of Mental Health
Matteo Visconti Oleggio di Castello ORCID
University of California at Berkeley
Michael P. Notter ORCID
University of Lausanne
Ross Blair ORCID
Stanford University
Editor
Christopher R. Madan ORCID
Tags
BIDS neuroimaging

GitHub Events

Total
  • Create event: 24
  • Release event: 3
  • Issues event: 27
  • Watch event: 23
  • Delete event: 16
  • Issue comment event: 76
  • Push event: 29
  • Pull request review comment event: 5
  • Pull request review event: 12
  • Pull request event: 57
  • Fork event: 5
Last Year
  • Create event: 24
  • Release event: 3
  • Issues event: 27
  • Watch event: 23
  • Delete event: 17
  • Issue comment event: 77
  • Push event: 33
  • Pull request review comment event: 5
  • Pull request review event: 12
  • Pull request event: 59
  • Fork event: 5

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 2,477
  • Total Committers: 73
  • Avg Commits per committer: 33.932
  • Development Distribution Score (DDS): 0.711
Past Year
  • Commits: 128
  • Committers: 9
  • Avg Commits per committer: 14.222
  • Development Distribution Score (DDS): 0.406
Top Committers
Name Email Commits
Tal Yarkoni t****i@g****m 717
Christopher J. Markiewicz m****z@s****u 578
Alejandro de la Vega d****a@u****u 381
Krzysztof J. Gorgolewski k****i@g****m 77
Taylor Salo t****6@f****u 72
arokem a****m@g****m 64
Remi Gau r****u@h****m 59
Yaroslav O. Halchenko d****n@o****m 49
dependabot[bot] 4****] 47
Dimitri Papadopoulos Orfanos 3****s 37
Oscar Esteban c****e@o****s 36
James Kent j****1@g****m 29
Hans Johnson h****n@g****m 28
Krista DeStasio k****o@g****m 27
Evgenii Kalenkovich e****h@g****m 24
Dmitry Petrov t****v@g****m 17
Dylan M. Nielson D****n@n****v 16
Stefan Appelhoff s****f@m****g 15
Peter Van Dyken p****2@u****a 14
Mathias Goncalves m****g@s****u 11
Shashank Bansal s****6@g****m 11
Gregory Kiar g****r@m****a 8
Johan Carlin j****n@g****m 8
Satrajit Ghosh s****a@m****u 8
Jake VanderPlas j****p@u****u 8
Adina Wagner a****r@t****e 7
Elizabeth DuPre e****2@c****u 7
Kirstie Whitaker k****1@c****k 7
Ali Khan a****k@r****a 6
Andrew Janke a****w@a****t 6
and 43 more...

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 74
  • Total pull requests: 260
  • Average time to close issues: 11 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 49
  • Total pull request authors: 24
  • Average comments per issue: 2.99
  • Average comments per pull request: 2.19
  • Merged pull requests: 198
  • Bot issues: 2
  • Bot pull requests: 107
Past Year
  • Issues: 17
  • Pull requests: 95
  • Average time to close issues: 9 days
  • Average time to close pull requests: 6 days
  • Issue authors: 16
  • Pull request authors: 11
  • Average comments per issue: 0.82
  • Average comments per pull request: 1.25
  • Merged pull requests: 73
  • Bot issues: 2
  • Bot pull requests: 45
Top Authors
Issue Authors
  • effigies (6)
  • adelavega (6)
  • pvandyken (5)
  • tsalo (4)
  • bpinsard (4)
  • oesteban (3)
  • alperkent (2)
  • MRIDude (2)
  • dependabot[bot] (2)
  • eulerleibniz (1)
  • me-pic (1)
  • Lestropie (1)
  • maximemulder (1)
  • wasciutto (1)
  • musicinmybrain (1)
Pull Request Authors
  • dependabot[bot] (98)
  • effigies (57)
  • Remi-Gau (22)
  • DimitriPapadopoulos (17)
  • adelavega (15)
  • github-actions[bot] (9)
  • akhanf (6)
  • tsalo (5)
  • oesteban (4)
  • bpinsard (4)
  • alperkent (3)
  • cookpa (3)
  • pvandyken (2)
  • coryshain (2)
  • fraimondo (2)
Top Labels
Issue Labels
bug (12) layout (5) wontfix (2) dependencies (2) github_actions (2) discussion (1) enhancement (1) statsmodels (1) duplicate (1) question (1) documentation (1)
Pull Request Labels
dependencies (98) submodules (63) python:uv (19) github_actions (12) python (4) enhancement (2) windows (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 56,670 last-month
  • Total docker downloads: 28,429
  • Total dependent packages: 51
    (may contain duplicates)
  • Total dependent repositories: 163
    (may contain duplicates)
  • Total versions: 64
  • Total maintainers: 4
pypi.org: pybids

bids: interface with datasets conforming to BIDS

  • Homepage: https://github.com/bids-standard/pybids
  • Documentation: https://pybids.readthedocs.io/
  • License: The MIT License (MIT) Copyright (c) 2015-2016, Ariel Rokem, The University of Washington eScience Institute. Copyright (c) 2016--, PyBIDS developers, Planet Earth Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 0.19.0
    published 10 months ago
  • Versions: 55
  • Dependent Packages: 46
  • Dependent Repositories: 163
  • Downloads: 56,670 Last month
  • Docker Downloads: 28,429
Rankings
Dependent packages count: 0.3%
Dependent repos count: 1.2%
Docker downloads count: 1.2%
Downloads: 1.9%
Average: 2.3%
Forks count: 4.4%
Stargazers count: 5.0%
Maintainers (3)
Last synced: 4 months ago
spack.io: py-pybids

bids: interface with datasets conforming to BIDS

  • Versions: 9
  • Dependent Packages: 5
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Average: 8.6%
Dependent packages count: 9.7%
Forks count: 10.2%
Stargazers count: 14.7%
Maintainers (1)
Last synced: 4 months ago

Dependencies

.github/workflows/codespell.yml actions
  • actions/checkout v3 composite
  • codespell-project/actions-codespell master composite
.github/workflows/docs.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • peaceiris/actions-gh-pages v3 composite
pyproject.toml pypi
  • bids-validator *
  • click >=8.0
  • formulaic >=0.2.4, <0.6
  • nibabel >=2.1
  • num2words *
  • numpy <1.25.0.dev0; python_version < '3.9'
  • numpy *
  • pandas >=0.23
  • scipy *
  • sqlalchemy <1.4.0.dev0
setup.py pypi
.github/workflows/build-test-deploy.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-python v5 composite
  • astral-sh/setup-uv v5 composite
  • codecov/codecov-action v5 composite
  • hynek/build-and-inspect-python-package v2 composite
  • pypa/gh-action-pypi-publish release/v1 composite