Skip to main content
MRSPRINT

PyPI Version Documentation Status

Welcome!

Magnetic resonance experiment simulator and visualization tool

MRSPRINT is a visual magnetic resonance simulator where you can simulate a magnetic resonance experiment - spectroscopy or imaging. Its main goal is to be an education tool that assists the student/staff to understand, interpret and explore magnetic resonance phenomena.

This tool is totally free (see license), but if you are making use of it, you need to cite us using both citations. This is very important for us.

  • Article: Coming soon!

  • Software: Coming soon!

If you are using this piece of software to generate images, gif’s, movies, etc., or using images available on this site, please, also reference us using those citations.

What can you see?

  • Precession: spins precessing in static magnetic field;

  • Resonance: resonance when a RF pulse is applied;

  • Contrast: T1, T2, and density of spins;

  • Field inhomogeneity: isochromates can be shown with their dispersion;

  • Gradient: magnetic field gradient in action, its intensity and effect over the frequency;

  • Evolution: over magnetization with intensity, frequency and phase and the pulse sequence;

  • FID: free induction decay, the signal;

  • Echo: spin or gradient echo (rephasing/dephasing).

Future planned features

  • K-space visualization;

  • Multi-nuclei samples/experiments;

  • T2* as sample parameter to easily setup field inhomogeneity;

  • Graphical sequence editor;

  • Chemical interactions;

  • View on coordinate laboratory system;

  • Flow (spins not fixed in positions).

Documentation

Go to documentation on ReadTheDocs! It is available on Read The Docs in HTML, EPUB, and PDF.

Download binaries - click-and-run

Binaries are for those do not wish to install any Python things. We recommend them to the ones without any programming experience. Download from links below.

  • Portable Windows Binaries: coming soon!

  • Portable Linux Binaries: coming soon!

  • Portable Mac Binaries: coming soon!

Sou you can just download, decompress, click-and-run.

Installing from PyPI - stable, end-user

To install, do

$ pip install mrsprint

This will install all necessary dependencies then the code.

To run from terminal

$ mrsprint

Dependencies

  • NumPy: Numerical mathematical library;

  • SciPy: Scientific library;

  • NMRGlue: NMR processing library;

  • H5Py: Storing and managing data files;

  • PyQtGraph: Data visualization library;

  • PyQt/Pyside: Graphical framework.

Dependencies are automatically installed when using the method above.

Metadata

Release files for mrsprint 1.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mrsprint 1.2.2
File Size Uploaded Provenance Actions
mrsprint-1.2.2.tar.gz 10.2 MB Without provenance Details for mrsprint-1.2.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mrsprint 1.2.2
File Interpreter ABI Platform Actions
mrsprint-1.2.2-py3-none-any.whl Python 3 none any Details for mrsprint-1.2.2-py3-none-any.whl

Total release size: 10.5 MB

Release files / mrsprint-1.2.2.tar.gz

Download URL mrsprint-1.2.2.tar.gz
Size 10.2 MB
Tags Source
SHA-256 checksum
How to use checksums
b1ffc426ae4f90f12a7522fd3cc53a388ba61df414149e43ea20485761631ada
BLAKE2b-256 checksum
How to use checksums
a6692cae99d13794120623eac946d682c89c21238672f391ef4f6e4df1da449d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / mrsprint-1.2.2-py3-none-any.whl

Download URL mrsprint-1.2.2-py3-none-any.whl
Size 286.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
617c324542fbcf27525c47da29dad34b2f60ca58c4aff0421eb6e90303ef2f62
BLAKE2b-256 checksum
How to use checksums
8860e2dd632edd43bff21c598bfab7fdbf6437e57df5f101aa05efbd0d7c293a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for mrsprint 1.2.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page