mrphy

A Pytorch based tool for MR physics simulations


Keywords
autodiff, bloch-simulation, differentiable-blochsim
License
MIT
Install
pip install mrphy==0.1.12

Documentation

MRphy.py

A pytorch based MR simulator package. codecov Actions Status

Infrastructure of:
Joint Design of RF and Gradient Waveforms via Auto-Differentiation for 3D Tailored Exitation in MRI
(arXiv: https://arxiv.org/abs/2008.10594)

cite as:

@article{luo2021joint,
  author={Luo, Tianrui and Noll, Douglas C. and Fessler, Jeffrey A. and Nielsen, Jon-Fredrik},
  journal={IEEE Transactions on Medical Imaging}, 
  title={Joint Design of RF and gradient waveforms via auto-differentiation for 3D tailored excitation in MRI}, 
  year={2021},
  volume={},
  number={},
  pages={1-1},
  doi={10.1109/TMI.2021.3083104}}

For the interpT feature, consider citing:

@inproceedings{luo2021MultiScale,
  title={Multi-scale Accelerated Auto-differentiable Bloch-simulation based joint design of excitation RF and gradient waveforms},
  booktitle={ISMRM},
  pages={3958},
  author={Tianrui Luo and Douglas C. Noll and Jeffrey A. Fessler and Jon-Fredrik Nielsen},
  year={2021}
}

Branches

  • master: Stable;
  • dev: Ocassionally git squash'd, git push --force'd;
  • dev_cache: Constantly git push --force'd.

Developments are mostly done on dev_cache; when they have passed local checks, dev will be git rebase'd to dev_cache, and sent for CI tests. When enough updates have been accumulated, dev will be git squashed into one large commit, followed by having master-branch git rebase'd onto it.

Installation

pip install mrphy

(The package is not yet sent to conda.)

Demos

Check out files under ./test. After installation, one can quickly play with the tests through:

pytest -s

Only basic demo is available in this early version.