Skip to main content

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 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-qsmrs --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.5.0

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

Source distribution (sdist)

Source distribution for qsm-ci 0.5.0
File Size Uploaded
qsm_ci-0.5.0.tar.gz 178.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for qsm-ci 0.5.0
File Interpreter ABI Platform
qsm_ci-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size:268.1 kB

Release files / qsm_ci-0.5.0.tar.gz

Download URL qsm_ci-0.5.0.tar.gz
Size 178.2 kB
Tags Source
SHA-256 checksum
How to use checksums
32ddc3a52d85274e158ec07a01b7cab5adca44f4a8365c059eccf06897fba64c
BLAKE2b-256 checksum
How to use checksums
2765a5a898c90ab5c31ef6438db5f5d86c18d1dd8f0d039b12d352ed0f4b3963
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 Sep 17, 2026.

Transparency log

Release files / qsm_ci-0.5.0-py3-none-any.whl

Download URL qsm_ci-0.5.0-py3-none-any.whl
Size 89.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
279b047900b9cca38b6be099b289de41a7c98183e1bcd9daf43293bb69abf277
BLAKE2b-256 checksum
How to use checksums
cce1304ece21aae36a05d05913cae4a548fd0c31343851b34590e9020e90ddb4
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 Sep 17, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.5.0 This release

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

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