Skip to main content

XNAT Ingest

CI/CD codecov PyPI Documentation Status

XNAT-Ingest is a toolkit used for sorting data into project/subject/sessions, de-identifying images before uploading them to an XNAT instance. Support for various file formats 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xnat_ingest-0.13.0.tar.gz (100.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xnat_ingest-0.13.0-py3-none-any.whl (131.1 kB view details)

Uploaded Python 3

File details

Details for the file xnat_ingest-0.13.0.tar.gz.

File metadata

  • Download URL: xnat_ingest-0.13.0.tar.gz
  • Upload date:
  • Size: 100.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for xnat_ingest-0.13.0.tar.gz
Algorithm Hash digest
SHA256 11745e7c91c6b2bbe4b62868eca479dda1da935614b9db2727fc4866eb4e843e
MD5 a3444b0558e1ac7d5950e5767b876fda
BLAKE2b-256 0d434cdea68451f6baed05a4d58788c44c8719eb7209d529d58d2db1c651f0b0

See more details on using hashes here.

File details

Details for the file xnat_ingest-0.13.0-py3-none-any.whl.

File metadata

  • Download URL: xnat_ingest-0.13.0-py3-none-any.whl
  • Upload date:
  • Size: 131.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for xnat_ingest-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 55ad9c514716ee1e98088ad67b091be173648a8dd08b21f8890f84e581bc1200
MD5 43428e416f1a00dec3686e3beaeaf82f
BLAKE2b-256 0e176ed4ca0dc50ac32530fb5cdbf83bb02a0c8ef33edb66dd170bdfb76fcaaa

See more details on using hashes here.

Release history Release notifications | RSS feed

0.13.1

2 files

This release

0.13.0 This release

2 files

0.12.3

2 files

0.12.2

2 files

0.12.1

2 files

0.12.0

2 files

0.11.0

2 files

0.10.0

2 files

0.9.1

2 files

0.9.0

2 files

0.8.7

2 files

0.8.6

2 files

0.8.4

2 files

0.8.3

2 files

0.8.2

2 files

0.7.2

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page