Skip to content

Repository files navigation

XNAT CLI for BIDS

xnatcli 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 xnatcli subcommand, the on-disk layouts each one produces, and how the pieces fit together lives at xnatbidscli.readthedocs.io.

Prerequisites

  • uv — manages the Python environment and dependencies.
  • Git — to clone this repository.

Installation

uv sync

See the Installation guide for making the xnatcli command available on PATH 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.

About

A command-line interface for logging into an Extensible Neuroimaging Archive Toolkit (XNAT) server, querying experiments and downloading files, then converting to the Brain Imaging Data Structure (BIDS) standard format.

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages