Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ DIstortion Correction). Phase unwrapping uses a self-contained C++17 port of
**no Julia runtime is involved**; do not reintroduce one (no `julia.py`, no
conda recipe, no `FindJulia.cmake`).

Pre-print: <https://www.biorxiv.org/content/10.1101/2023.11.28.568744v1>.
Paper (Imaging Neuroscience): <https://doi.org/10.1162/IMAG.a.1262>.

## Layout

Expand Down
5 changes: 4 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
Copyright (c) 2022 Washington University.
Authored by: Andrew Van

Please cite https://www.biorxiv.org/content/10.1101/2023.11.28.568744v1
Please cite:
Van AN, Montez DF, Laumann TO, Cho PN, Suljic V, Madison T, et al.
Frame-wise multi-echo distortion correction for superior functional MRI.
Imaging Neuroscience 2026; 4 IMAG.a.1262. doi: https://doi.org/10.1162/IMAG.a.1262

warpkit is free for non-commercial use by academic, government,
and non-profit/not-for-profit institutions. A commercial version of the software is
Expand Down
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@

[![Build](https://github.com/vanandrew/warpkit/actions/workflows/build.yml/badge.svg)](https://github.com/vanandrew/warpkit/actions)
[![PyPI](https://img.shields.io/pypi/v/warpkit)](https://pypi.org/project/warpkit/)
[![docker](https://ghcr-badge.egpl.dev/vanandrew/warpkit/latest_tag?trim=major&label=ghcr&nbsp;latest)](https://github.com/vanandrew/warpkit/pkgs/container/warpkit)
[![codecov](https://codecov.io/gh/vanandrew/warpkit/graph/badge.svg?token=S6ZZKOAF8V)](https://codecov.io/gh/vanandrew/warpkit)

A Python library for neuroimaging transforms, focused on the Multi-Echo DIstortion Correction (MEDIC) algorithm. The pre-print is available at <https://www.biorxiv.org/content/10.1101/2023.11.28.568744v1>.
A Python library for neuroimaging transforms, focused on the Multi-Echo DIstortion Correction (MEDIC) algorithm. The paper is published in *Imaging Neuroscience* at <https://doi.org/10.1162/IMAG.a.1262>.

The phase-unwrapping core is a self-contained C++17 port of [ROMEO](https://github.com/korbinian90/ROMEO) — there is no Julia runtime to install, and binary wheels ship with the ITK pieces statically linked. If you used an older release of warpkit that required `julia` on `PATH`, that step is gone.

Expand Down Expand Up @@ -194,6 +193,15 @@ wk-convert-fieldmap \
--output sub-01_run-01_fieldmap.nii
```

## Citation

If you use warpkit, please cite:

> Van AN, Montez DF, Laumann TO, Cho PN, Suljic V, Madison T, et al.
> Frame-wise multi-echo distortion correction for superior functional MRI.
> *Imaging Neuroscience* 2026; 4 IMAG.a.1262.
> doi: <https://doi.org/10.1162/IMAG.a.1262>

## Authors

Vahdeta Suljic &lt;suljic@wustl.edu&gt;, Andrew Van &lt;vanandrew77@gmail.com&gt;
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ requires-python = ">=3.11"
authors = [{ name = "Andrew Van", email = "vanandrew77@gmail.com" }]
keywords = ["neuroimaging"]
classifiers = ["Programming Language :: Python :: 3"]
urls = { github = "https://github.com/vanandrew/warpkit" }
urls = { github = "https://github.com/vanandrew/warpkit", paper = "https://doi.org/10.1162/IMAG.a.1262" }
# include/romeo/LICENSE is the upstream MIT notice for the ROMEO C++ port; it
# travels with the headers in source distributions and (via PEP 639
# license-files) gets bundled into wheels under *.dist-info/licenses/.
Expand Down