Skip to main content


AccessionFlow

CI/CD codecov PyPI Documentation Status

Accessioning is the process of formally receiving material from a source and registering it in a managed collection. AccessionFlow is a collection of tools to accession data: collate, label, de-identify and store them in a data store. Support for various file types is provided through the FileFormats package and its extensions (e.g. FileFormats MedImage, FileFormats Siemens,...).

flowchart LR
    Folder(["folder"]) --> Collate["collate (source)"]
    Orthanc(["Orthanc"]) --> Collate
    Collate --> Label["label (store)"]
    Label --> Deidentify["deidentify (optional)"]
    Deidentify --> Store["store (store)"]
    Store --> XNAT[("XNAT")]
    Store --> FolderStore[("folder store\n(local, S3, SFTP)")]
    Store -.-> CheckStore["check-store (store)"]

    Extra(["files without\nsorting metadata"]) -.-> Attach["attach (optional)"]
    Collate -.-> Attach
    Attach -.-> Label

Where the files come from and where they go are both plugins: sources provide the collate subcommands (collate folder, collate orthanc), and data stores provide the label, store and check-store subcommands (e.g. label xnat, store folder).

Installation

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

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

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

$ python3 -m pip install accessionflow

Running

AccessionFlow has a public API and a command-line interface (CLI), with sub-commands to collate, attach, label, de-identify and store accessions in a data store — either as a one-off run or as a continuously-running service (e.g. via Docker Compose or Kubernetes). For example:

$ accessionflow collate folder /data/incoming /data/staging/collated
$ accessionflow label folder /data/staging/collated /data/staging/labelled --level subject PatientID
$ accessionflow store folder /data/staging/labelled s3://my-bucket/archive

See the full documentation for a hands-on quick start, a guide to each source, stage and data store, and the complete CLI/API reference.

Metadata

Release files for accessionflow 0.20.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for accessionflow 0.20.1
File Size Uploaded Provenance Actions
accessionflow-0.20.1.tar.gz 271.5 kB Without provenance Details for accessionflow-0.20.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for accessionflow 0.20.1
File Interpreter ABI Platform Actions
accessionflow-0.20.1-py3-none-any.whl Python 3 none any Details for accessionflow-0.20.1-py3-none-any.whl

Total release size: 621.3 kB

Release files / accessionflow-0.20.1.tar.gz

Download URL accessionflow-0.20.1.tar.gz
Size 271.5 kB
Tags Source
SHA-256 checksum
How to use checksums
05845452dd4dbf00e59d97d39620bd0df9c7aa9f739fd216780bb6fb7a1c3122
BLAKE2b-256 checksum
How to use checksums
94c8e4e48169200d202b66f831ed7c51c81bea1e77c07e7b31e7846a42ef3644
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / accessionflow-0.20.1-py3-none-any.whl

Download URL accessionflow-0.20.1-py3-none-any.whl
Size 349.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b66ff8d010b520b1659c17da5655bba09d5162ee7a1c4575c405e3bab15dc093
BLAKE2b-256 checksum
How to use checksums
b32b6aa3f13e93959b083efe2e53f933c92a14edae47479fbca04346004b64eb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for accessionflow 0.20.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.

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