Submit an algorithm

A few questions, and we'll generate your submission files.

Which part of the pipeline does your method implement?

QSM is modular — pick a single stage, or a span if your method crosses boundaries.

Tell us about your method

Package & run

Your code runs in a container with no network. It reads from /input and writes (in ppm) to /output. Any language works — pick one below for a starter file.
Language
We'll generate a starter for you. You'll wire up your own program in run.sh. Suggested base image: .
Container image
Format examples:
A public image with your dependencies baked in (Docker Hub, GHCR, Quay…). Your code is mounted at /algo, and there's no network at run time.

Parameters

Optional — documents the knobs your method exposes.

Review & submit

Your submission folder — download it as a zip, or copy the files below.

Then, with the qsm-ci CLI

One tool runs and submits your algorithm — it runs your stage on files you provide and (with --truth) scores it using the exact code the leaderboard uses. No BIDS needed.

  1. Install once: pipx install git+https://github.com/QSMxT/QSM-CI
  2. Unzip the folder into algorithms/ and fill in with your method (or scaffold in the terminal with qsm-ci new).
  3. Run it on your own files (add --truth .nii.gz to score):
  4. Open the pull request:
Full guide Open a PR by hand →
Open a pull request →