Skip to main content

A Pytorch based tool for MR physics simulations

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mrphy-0.2.0.tar.gz (28.2 kB view details)

Uploaded Source

Built Distribution

mrphy-0.2.0-py3-none-any.whl (32.3 kB view details)

Uploaded Python 3

File details

Details for the file mrphy-0.2.0.tar.gz.

File metadata

  • Download URL: mrphy-0.2.0.tar.gz
  • Upload date:
  • Size: 28.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for mrphy-0.2.0.tar.gz
Algorithm Hash digest
SHA256 5476d7a5cc2ab73c4206d531be7290fbc4312f7f7b05a12628aaa4e06b490fbc
MD5 f77dabaf4f40ecf32e9e6bf6b24ab2ad
BLAKE2b-256 77c517be661e073b67850e7d54c6428446fb1eee55cf3c675727c5849227fcf5

See more details on using hashes here.

Provenance

File details

Details for the file mrphy-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: mrphy-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 32.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for mrphy-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 266c97eadc56bc84c5065fcf83c4e7efbe5a19d1a76d9a3adb6f50df9089fa89
MD5 b38980f63ac9ea63649940f10a23137c
BLAKE2b-256 fd129d5af38ecf1b73cf3d7c7ba200e78e1bc03013663efd3c34aa546f56b238

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page