bids:与符合BIDS的数据集接口
项目描述
PyBIDS
PyBIDS 是一个 Python 库,用于集中处理符合 BIDS (Brain Imaging Data Structure) 格式的数据集。有关 BIDS 的更多信息,请访问 https://bids.neuroimaging.io。
PyBIDS 目前支持 POSIX 操作系统上的 Python 3(包括 Mac OS)。虽然 Windows 不受官方支持,但 PyBIDS 的大多数功能可能仍然可以正常运行。
安装
PyBIDS 最容易通过 pip 安装。要安装最新官方版本
pip install pybids
或者,也可以通过 conda 安装
conda install -c conda-forge pybids
如果您想尝试最新的代码,可以从 master 分支安装
pip install git+https://github.com/bids-standard/pybids.git
依赖项
PyBIDS 有多个依赖项。核心查询功能只需要 BIDS-Validator
包。但是,大多数其他模块需要核心 Python 神经影像学堆栈: numpy
、scipy
、pandas
和 nibabel
。此外,reports
模块还需要 num2words
。默认情况下,所有依赖项都会与 pybids 一起安装(如果它们尚未可用)。
使用方法
查看 文档 开始使用!
或者您可以从 教程 开始!您可以通过 binder 无需安装任何东西即可交互式地运行它。点击链接,然后导航到 doc/examples/pybids_tutorial.md
进行探索。
开发和测试
PyBIDS 使用 tox 来管理测试环境,并确保可以在本地和 CI 中轻松运行相同的命令。
使用以下命令安装 tox
pip install tox
要使用标准、最小或预发布依赖项运行测试,请使用
tox run -e [full|min|pre]
要使用特定版本,也指定 py3X
tox run -e py311-full
有关更多详细信息,请参阅 tox
文档。
如何引用
要在您的作品中提及 PyBIDS,请引用 JOSS 论文 和 Zenodo 存档。前者提供了对包的高级描述,后者指向 PyBIDS 所有版本的永久记录(我们鼓励您引用您使用的特定版本)。示例引用(针对 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
社区指南
欢迎向 PyBIDS 报告错误、反馈和其他贡献。要报告错误、请求功能或提出技术(非使用相关)问题以进行讨论,请 在 GitHub 上打开一个问题。有关支持请求和使用问题(未怀疑存在错误的情况)应在 NeuroStars 论坛上发布。有关 BIDS 规范 或 BIDS-Validator 的问题,请参阅相应的存储库。有关 BIDS 相关的一般讨论,请参阅 bids-discussion 邮件列表。
欢迎 Pull 请求。如果您对 PR 的适用性有任何疑问或想讨论与实现相关的问题,请随时为讨论打开一个问题。
项目详情
下载文件
下载适合您平台文件。如果您不确定选择哪个,请了解更多关于安装包的信息。