XNAT Python Client#
A new 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
New to your_python_package? Check out the Tutorials. They are a hands-on introduction for beginners.
The user guides are recipes for key tasks and common problems.
The reference guide contains a detailed description of the configuration options, directives, and templates included in your_python_package.
Want to add to the codebase? The contributing guidelines will guide you through the process of improving your_python_package.
To install from pypi simply use:
pip install xnat
There is also a conda package available:
conda install -c conda-forge xnat
Alternatively, you can get yourself a copy of the source code:
git clone https://gitlab.com/radiology/infrastructure/xnatpy
- Tutorials
- How-to Guides
- The XNAT REST API
- Installation
- Connecting to a server
- Low level REST directives
- Exploring your xnat server
- Looping over data
- Mapping function
- Selecting an object based on its uri
- Downloading data
- Custom variables
- Getting external urls of an object
- Importing data into XNAT
- Prearchive
- Searching
- Object creation
- Accessing XNAT files as local files (partial read)
- Accessing DICOM headers of scan
- Re-using XNAT jsession
- Example scripts
- Data integrity check
- Reference Manual
- Maintenance
- Changelog
- UNRELEASED VERSION
- 0.7.2 - 2025-05-28
- 0.7.1 - 2025-04-15
- 0.7.0 - 2025-02-06
- 0.6.2 - 2024-06-18
- 0.6.1 - 2024-05-23
- 0.6.0 - 2024-05-14
- 0.5.3 - 2023-12-04
- 0.5.2 - 2023-10-02
- 0.5.1 - 2023-03-30
- 0.5.0 - 2023-02-27
- 0.4.3 - 2022-10-31
- 0.4.2 - 2022-04-07
- 0.4.1 - 2022-02-22
- 0.4.0 - 2022-01-27
- 0.3.28 - 2021-10-28
- 0.3.27 - 2021-09-29
- 0.3.26 - 2021-04-16
- 0.3.25 - 2020-09-24
- 0.3.24 - 2020-06-19
- 0.3.23 - 2020-06-19
- 0.3.22 - 2020-02-26
- 0.3.21 - 2019-10-09
- 0.3.20 - 2019-10-09
- 0.3.19 - 2019-09-20
- 0.3.18 - 2019-06-06
- 0.3.17 - 2019-04-04
- 0.3.16 - 2019-03-28
- 0.3.14 - 2019-02-22
- 0.3.13 - 2019-01-07
- 0.3.12 - 2019-01-03
- 0.3.11 - 2018-11-12
- 0.3.10 - 2018-08-31
- 0.3.9 - 2018-07-02
- 0.3.8 - 2018-06-04
- 0.3.7 - 2018-03-12
- 0.3.6 - 2018-03-09
- 0.3.5 - 2018-01-02
- 0.3.4 - 2017-11-13
- 0.3.3 - 2017-10-18
- 0.3.2 - 2017-10-15
- 0.3.1 - 2017-09-04
- 0.3.0 - 2017-08-17
- 0.2.3 - 2017-04-03