XNAT Python Client

An XNAT client that exposes XNAT objects/functions as python objects/functions.

The XNAT Python client is open-source (licensed under the Apache 2.0 license) and hosted on gitlab at https://gitlab.com/radiology/infrastructure/xnatpy

The official documentation can be found at xnat.readthedocs.org

Documentation

Tutorials

New to xnatpy? The tutorials are a hands-on, start-to-finish introduction: install the package, connect to a server, and work through your first project.

How-to guides

Recipes for specific tasks — connecting, searching, downloading, importing, working with the prearchive. For when you already know the basics and want to get something done.

Reference

Technical description of the machinery: the Python API, the command-line interface, and the generated XSD classes.

Explanation

Background and context: the XNAT REST API, xnatpy’s object model, the project status, and how data-integrity checking works.

Contributing

Want to improve xnatpy or its documentation? The contributor guide covers setup, conventions, and the release process.

Indices and tables