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.1.tar.gz (101.0 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.1-py3-none-any.whl (131.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xnat_ingest-0.13.1.tar.gz
  • Upload date:
  • Size: 101.0 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.1.tar.gz
Algorithm Hash digest
SHA256 73c260dda492d2646522e64527a0a1f7e92aaeacf90b38e3f87a27d936559e4b
MD5 bbbab4daac4ce179a9c046ca180ea802
BLAKE2b-256 95d5c27e7481648d4f10c411f8182e929515628ff499ea16ecd65f0b4f0f18f9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xnat_ingest-0.13.1-py3-none-any.whl
  • Upload date:
  • Size: 131.6 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4cae934a3567bdc8d2ff55ea009862d49dfd6fb0e6076cc280e9ca7511937017
MD5 fdc11770e6223f21ca195284d33db3aa
BLAKE2b-256 4297ff7c6348c5a6f3d15a28df74a0fedae28f573f8007aedbf65f8210a6b85f

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.13.1 This release

2 files

0.13.0

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