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

A Docker image containing the toolkit can be pulled from the GitHub Container Registry and entrypoint of the image is the xnat-ingest CLI so commands can be run by the form

docker run ghcr.io/australian-imaging-service/xnat-ingest:latest <command-name> <arg1> <arg2> ... --opt1 <opt1> ...

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

$ python3 -m pip install xnat-ingest

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.17.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.17.0
File Size Uploaded Provenance Actions
xnat_ingest-0.17.0.tar.gz 221.7 kB Without provenance Details for xnat_ingest-0.17.0.tar.gz

Built distribution (wheel)

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

Total release size: 494.8 kB

Release files / xnat_ingest-0.17.0.tar.gz

Download URL xnat_ingest-0.17.0.tar.gz
Size 221.7 kB
Tags Source
SHA-256 checksum
How to use checksums
58ea36b3f922dc2d24f2756e944f470b7779d8451373a691f5b8913f9824fafd
BLAKE2b-256 checksum
How to use checksums
d0b8291404cf28cf1686a738233c3b20b46452d5568b0496db026c4a07247a2a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

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

Download URL xnat_ingest-0.17.0-py3-none-any.whl
Size 273.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cbccfa80c349301246fd6f5081c8cf7c6e74a69f7ed9fde5c560c9ef0ed179d8
BLAKE2b-256 checksum
How to use checksums
ae745cfddf97c884014b2d6ad07d7c6ceaad95e72c919a1d54de5af93f2c7ade
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for xnat-ingest 0.17.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

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