QSM-CI
An open benchmarking platform and leaderboard for Quantitative Susceptibility Mapping (QSM) reconstruction.
Submit a QSM algorithm — in any language, as a container — and QSM-CI runs it on standardized data, scores it against held-out ground truth, and publishes the result to an interactive leaderboard. Every published algorithm gets a citable Zenodo DOI and can be run by anyone with one command.
→ https://qsmxt.github.io/QSM-CI
- Results — per-stage tables, the background-removal × dipole-inversion combination matrix, and findings, with an interactive volume viewer.
- Run an algorithm — locally or from a workflow engine (nipype, Pydra, CWL, Snakemake, Nextflow).
- Submit yours — open a pull request adding a folder
under
algorithms/.
Run an algorithm
pip install qsm-ci
qsm-ci list # the published algorithms you can run
qsm-ci run sharp --totalfield tf.nii.gz --mask mask.nii.gz
Algorithms are fetched from Zenodo and run in their pinned container, so results are reproducible. See the running guide for details.
Submit an algorithm
A submission is a folder under algorithms/<slug>/ — your run.sh, a stage: declaration, and a
container environment — reading and writing canonical artifacts (all fields and χ in ppm). Your
code is mounted, not baked. QSM is scored stage-aware (field-mapping → background removal → dipole
inversion, plus combined spans), both isolated and composed with other stages.
Start from the Submit guide; the full rules are in CONTRACT.md and the machine-readable stages.yml. MATLAB is welcome via the license-free MATLAB Runtime.
Repository layout
| Path | What it is |
|---|---|
algorithms/<slug>/ |
One submission each |
qsm_ci/ |
The qsm-ci CLI (published to PyPI) |
eval/ |
qsm-eval — the Python scorer (metrics ported from QSM.rs) |
scripts/pipeline.py |
Isolated + composed evaluation runner |
web/, results/index.json |
The leaderboard site and the scores that feed it |
CONTRACT.md, stages.yml |
The submission contract and stage registry |
Release files for qsm-ci 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| qsm_ci-0.4.0.tar.gz | 122.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| qsm_ci-0.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size:198.2 kB
Release files / qsm_ci-0.4.0.tar.gz
| Download URL | qsm_ci-0.4.0.tar.gz |
|---|---|
| Size | 122.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b00a0f82680fee2fba3a542f11547595bb2f67b08fa2ced6425793f3b886f62a
|
|
BLAKE2b-256 checksum How to use checksums |
523c61f498fef699125abc565c26c298bc4b4b9742c222ca64d3dd9cc76ea3a8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 25, 2026.
Transparency logRelease files / qsm_ci-0.4.0-py3-none-any.whl
| Download URL | qsm_ci-0.4.0-py3-none-any.whl |
|---|---|
| Size | 75.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0f4da1009ee9bb2a1a06799f14e89f825e34f521f5fddd6390963ae6f028ef75
|
|
BLAKE2b-256 checksum How to use checksums |
b92d38815dca8f9b59c1db90c55514bbef57cea7a2693d14c7f322aecdf6ba92
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 25, 2026.
Transparency log