XNAT CLI for BIDS
xnatbidscli is a command-line toolkit that takes neuroimaging data from login to analysis-ready dataset: authenticate against an XNAT (Extensible Neuroimaging Archive Toolkit) server, query and download experiments, convert them to BIDS (Brain Imaging Data Structure) with dcm2bids, group acquisitions with CuBIDS, map participants/sessions to anonymized IDs, and fold in physiological recordings — all through one CLI built on PyXNAT.
User Guide
Full documentation for every xnatbidscli subcommand, the on-disk layouts each one produces, and how the pieces fit together lives at xnatbidscli.readthedocs.io.
Installation
Requires Python ≥ 3.11.
pip install xnatbidscli
See the Installation guide for installing unreleased features from source with uv and the full list of runtime dependencies.
Reporting Issues and Feature Requests
Use the GitHub Issues feature here to report anything wrong with the CLI, code, or docs. You can also provide feature requests via GitHub Issues.
Attribution
Developed and tested primarily by Eric Earl of the NIMH Data Science and Sharing Team primarily for the NIMH Intramural Research Program labs. Claude Code and GitHub Copilot were used to develop features, docs, and modifications, as prompted by Eric Earl.
License
Distributed under the MIT License.
Metadata
Release files for xnatbidscli 2.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| xnatbidscli-2.0.0.tar.gz | 174.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| xnatbidscli-2.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 243.5 kB
Release files / xnatbidscli-2.0.0.tar.gz
| Download URL | xnatbidscli-2.0.0.tar.gz |
|---|---|
| Size | 174.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
81ef4d30c3c0cf92f9d420a899e4ff97a06eff14cc84cd2eecfb339ae41859e3
|
|
BLAKE2b-256 checksum How to use checksums |
8738ac4e8aceb70ffa5bd8a9402738639669ad0f089b372ad968440029f910d5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / xnatbidscli-2.0.0-py3-none-any.whl
| Download URL | xnatbidscli-2.0.0-py3-none-any.whl |
|---|---|
| Size | 68.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
89f741b39466cfbb2b34be177e3ace8baf71f1e98da7c818456221c09ccc952f
|
|
BLAKE2b-256 checksum How to use checksums |
8db971ddfe6cbdb012987ce874551cb4e37a76f5d0361a803d392cd4eec8f856
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
