XNAT Ingest

XNAT-Ingest is a collection of tools to sort, label, de-identify data and upload them to an XNAT repository. Support for various file types is provided through the FileFormats package and its extensions (e.g. FileFormats MedImage, FileFormats Siemens,...).

flowchart LR
    Scanner(["Scanner / instrument"]) --> Group["group"]
    Group --> Assign["assign"]
    Assign --> Deidentify["deidentify (optional)"]
    Deidentify --> Upload["upload"]
    Upload --> XNAT[("XNAT")]
    Upload -.-> CheckUpload["check-upload"]

    Extra(["files without\nsorting metadata"]) -.-> Associate["associate (optional)"]
    Group -.-> Associate
    Associate -.-> Assign

Installation

XNAT ingest can be installed as a Python package from PyPI with pip:

$ python3 -m pip install xnat-ingest

Alternatively, a Docker image containing the toolkit can be pulled from docker pull ghcr.io/australian-imaging-service/xnat-ingest:latest

Running

XNAT Ingest has a public API and a command-line interface (CLI), with sub-commands to group, assign, associate, de-identify, and upload imaging sessions to XNAT — either as a one-off run or as a continuously-running service (e.g. via Docker Compose or Kubernetes).

See the full documentation for a hands-on quick start, how-to guides for each part of the pipeline, and the complete CLI/API reference.

Metadata

Release files for xnat-ingest 0.15.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for xnat-ingest 0.15.1
File	Size	Uploaded
xnat_ingest-0.15.1.tar.gz	146.5 kB	Sep 9, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for xnat-ingest 0.15.1
File	Interpreter	ABI	Platform	Reset
xnat_ingest-0.15.1-py3-none-any.whl 178.4 kB Sep 9, 2026	Python 3	none	any	Details

Total release size: 324.9 kB

Release files / xnat_ingest-0.15.1.tar.gz

Download URL	xnat_ingest-0.15.1.tar.gz
Size	146.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`89accfe507470fe28fab6bc436aef7746b2ab2a51779a846348947e8803a8c22`
BLAKE2b-256 checksum How to use checksums	`9468d2bb936593fa5635304868382cfe120ba08585155be96c1d18e443d80454`
Upload date	Sep 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Release files / xnat_ingest-0.15.1-py3-none-any.whl

Download URL	xnat_ingest-0.15.1-py3-none-any.whl
Size	178.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`3d1e237cd7bc65c577669ceba496ad2453fe14e038635643e5e2fb5472577672`
BLAKE2b-256 checksum How to use checksums	`53cdef9ededd718c676b640dd2d9ed5f762d1e3ab1c54920561230bb406af9d1`
Upload date	Sep 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`