Appearance

0.2k

KomaMRI.jlFast and Extensible MRI Simulation in Julia

Pulseq in, ISMRMRD out. Fast CPU and GPU simulation with a GUI, interactive PlotlyJS visualizations, and dynamic phantoms.

Getting Started
View on GitHub
API Reference
KomaMRIKomaMRI
📦

Community Standards

Import Pulseq sequences and export raw data in ISMRMRD. Integrate directly with reconstruction and benchmarking workflows.

🚀

Fast, Device Agnostic

Run on CPU and GPU with CUDA, AMDGPU, Metal, and oneAPI support. Differentiable simulations powered by Enzyme and Reactant.

🌊

Dynamic Motion Models

Simulate static and dynamic phantoms. Model motion and complex spin trajectories with reusable HDF5 phantom files.

🖥️

Interactive GUI

Configure scanners, phantoms, and sequences in KomaUI. Explore results with interactive PlotlyJS visualizations.

Installation ​

KomaMRI.jl is a registered Julia package and can be installed using the Julia package manager. From the Julia REPL, type ] to enter the Pkg REPL mode and run:

julia
pkg> add KomaMRI

Or, alternatively, via the Pkg API:

julia
julia> import Pkg; Pkg.add("KomaMRI")

GPU Support ​

KomaMRI supports GPU acceleration with CUDA, AMDGPU, Metal, and oneAPI. To use GPU acceleration, install the corresponding backend package:

julia
# Install
import Pkg; Pkg.add("CUDA")
# Load
using KomaMRI, CUDA
julia
# Install
import Pkg; Pkg.add("AMDGPU")
# Load
using KomaMRI, AMDGPU
julia
# Install
import Pkg; Pkg.add("Metal")
# Load
using KomaMRI, Metal
julia
# Install
import Pkg; Pkg.add("oneAPI")
# Load
using KomaMRI, oneAPI

Citation ​

If you use KomaMRI.jl in your research, please cite our paper:

Castillo-Passi, C, Coronado, R, Varela-Mattatall, G, Alberola-López, C, Botnar, R, Irarrazaval, P. KomaMRI.jl: An open-source framework for general MRI simulations with GPU acceleration. Magn Reson Med. 2023; 1-14. doi: 10.1002/mrm.29635

bibtex
@article{https://doi.org/10.1002/mrm.29635,
  author = {Castillo-Passi, Carlos and Coronado, Ronal and Varela-Mattatall, Gabriel and Alberola-López, Carlos and Botnar, René and Irarrazaval, Pablo},
  title = {KomaMRI.jl: An open-source framework for general MRI simulations with GPU acceleration},
  journal = {Magnetic Resonance in Medicine},
  keywords = {Bloch equations, GPU, GUI, Julia, open source, simulation},
  doi = {https://doi.org/10.1002/mrm.29635},
  url = {https://onlinelibrary.wiley.com/doi/abs/10.1002/mrm.29635},
  eprint = {https://onlinelibrary.wiley.com/doi/pdf/10.1002/mrm.29635}
}