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.12.3.tar.gz (88.7 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.12.3-py3-none-any.whl (118.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xnat_ingest-0.12.3.tar.gz
  • Upload date:
  • Size: 88.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for xnat_ingest-0.12.3.tar.gz
Algorithm Hash digest
SHA256 ff5d684af815fb6ca8605e3c5ac9d30496b7c185d857cd1e2f602dfbe23a36ab
MD5 9ea76ac0273c480cb86be9dec59f7a44
BLAKE2b-256 9db030730593c98ffe9dddccda4e188891dd3674caadd67bc71e53540b585322

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xnat_ingest-0.12.3-py3-none-any.whl
  • Upload date:
  • Size: 118.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for xnat_ingest-0.12.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1bb994cef5aa4c599c43f6c2f7be1172ae0b4426a35a47dd5316ea7cbe2c03bd
MD5 793e6ed99586cbb0a6b7a931b7128fed
BLAKE2b-256 ad55451a54a7d217155e29f7a64bbfe6978c836031b570b2b1412671ac3e6219

See more details on using hashes here.

Release history Release notifications | RSS feed

0.13.1

2 files

0.13.0

2 files

This release

0.12.3 This release

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