XNAT Ingest
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.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| xnat_ingest-0.17.1.tar.gz | 222.4 kB | Without provenance | Details for xnat_ingest-0.17.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| xnat_ingest-0.17.1-py3-none-any.whl | Python 3 | none | any | Details for xnat_ingest-0.17.1-py3-none-any.whl |
Total release size: 496.3 kB
Release files / xnat_ingest-0.17.1.tar.gz
| Download URL | xnat_ingest-0.17.1.tar.gz |
|---|---|
| Size | 222.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6c68b96728403675f9872fe0eba07361819967c9c7bd479e796643927499e04e
|
|
BLAKE2b-256 checksum How to use checksums |
ccdb2f138715d524e44370d9c3b561dc57c6031a17cdd0f0a52ea29a938b5aa9
|
| 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.1-py3-none-any.whl
| Download URL | xnat_ingest-0.17.1-py3-none-any.whl |
|---|---|
| Size | 273.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f93670b823db19477a78571cae4b5db0f2142719b1e7f46a25554db248c15a34
|
|
BLAKE2b-256 checksum How to use checksums |
e3e0983fbf824dc5c49783a225c1874e821018d90ef12a6c14b757ea63c894e5
|
| 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.1
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.