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)"]
    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.3

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.3
File Size Uploaded
xnat_ingest-0.15.3.tar.gz 164.2 kB Details

Built distribution (wheel)

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

Total release size: 366.4 kB

Release files / xnat_ingest-0.15.3.tar.gz

Download URL xnat_ingest-0.15.3.tar.gz
Size 164.2 kB
Tags Source
SHA-256 checksum
How to use checksums
275e78d9446a690cfef475f10676ea1918c5a6248f2461d6b909966417115926
BLAKE2b-256 checksum
How to use checksums
2a2e5639b451c1aa2fc627378ab335c36a9dda77144a0e90d3f7bfd4ca2b1c1d
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.15.3-py3-none-any.whl

Download URL xnat_ingest-0.15.3-py3-none-any.whl
Size 202.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e2e9ad17e582f442f67b15d76a8f3e92b88d9124ada7f5ce829f22a7cc86b528
BLAKE2b-256 checksum
How to use checksums
4f0523cb663c1f188063765e34946c8d1278b89e95c0b616f83ad57fac222198
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

This release

0.15.3 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