Skip to main content

XNAT Ingest

CI/CD codecov PyPI Documentation Status

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)"]
    Assign -.-> Associate
    Associate -.-> Deidentify

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.14.0

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.14.0
File Size Uploaded
xnat_ingest-0.14.0.tar.gz 103.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for xnat-ingest 0.14.0
File Interpreter ABI Platform
xnat_ingest-0.14.0-py3-none-any.whl Python 3 none any Details

Total release size: 238.3 kB

Release files / xnat_ingest-0.14.0.tar.gz

Download URL xnat_ingest-0.14.0.tar.gz
Size 103.4 kB
Tags Source
SHA-256 checksum
How to use checksums
e55f7e86bb38d44c1d19542d8e08273c60ab25624aaf0b00acd306605b8bd9cf
BLAKE2b-256 checksum
How to use checksums
febed20f6ed84c798cac3fcf1fdaf9066bd4665dd5a3d099b783a7ee21eaa4e5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

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

Download URL xnat_ingest-0.14.0-py3-none-any.whl
Size 134.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0bc7fd37161f0aeb5597a4e22dfa1a0d9c2a774f6391d6a211cef6868504223b
BLAKE2b-256 checksum
How to use checksums
8bc08556f9dc475bd6d5c2db3624ffa9e9903791c1dcd010423785afe4e8ed1a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

0.15.7

2 release files

0.15.6

2 release files

0.15.4

2 release files

0.15.3

2 release files

This release

0.14.0 This release

2 release files

0.13.1

2 release files

0.13.0

2 release files

0.12.3

2 release files

0.11.0

2 release files

0.9.1

2 release files

0.9.0

2 release files

0.8.7

2 release files

0.8.6

2 release files

0.8.4

2 release files

0.8.3

2 release files

0.8.2

2 release files

0.7.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page