SpinSight MRI simulator
SpinSight is an MRI simulator written in Python and created for educational puposes. It jointly visualizes the imaging parameters, the MRI pulse sequence, the k-space data matrix, and the MR image. These are updated in near real-time when the user changes parameters. The simulator is run as a web browser dashboard. The data is simulated from computational 2D phantoms in vector graphics format (SVG).
Running the Simulator
Install using pip:
pip install spinsight
Then run as a command line tool
spinsight
This serves SpinSight on the local host, so that the simulator can be run by navigating to localhost in the web browser. The same command line tool can be used to deploy the simulator on a local network, or on a web server (run spinsight -h for help). Be aware that several minutes are required upon loading a phantom for the first time.
Phantom construction
To create a new phantom, add a directory with the phantom name under spinsight/phantoms. This directory shall contain files with the same name as the directory. Two formats are supported:
A single .toml file
The file shall consist of a list of shapes (see Shepp-Logan_shapes.toml for reference). Each shape is assigned a tissue type which must be defined in the TISSUES dict in constants.py.
A pair of .toml and .svg files
The .toml file specifies a mapping from hexcolors to tissues (see brain.toml for reference). The tissues must be defined in the TISSUES dict in constants.py.
The specified .svg file must meet the following specifications:
- All paths must be closed
- All paths must have a fill color matching a hexcolor defined in the
.tomlfile (this defines the tissue). - Only polygons are supported (not Bézier curves etc.)
Dependencies
See pyproject.toml, dependencies under heading [project].
How to cite
If you use this software in your research, please cite:
Berglund J, Jain K, Sousa JM, Hedman K, Fahlström M. “SpinSight – An educational open-source MRI simulator with joint visualization of pulse sequence, k-space, and MR image. In: Proceedings of the Annual Meeting of the International Society of Magnetic Resonance in Medicine, Honolulu 2025, pp. 1968.
License
SpinSight is distributed under the terms of the GNU General Public License. See LICENSE.md.
Contact Information
Johan Berglund, Ph.D.
Uppsala University Hospital,
Uppsala, Sweden
johan.berglund@akademiska.se
Copyright © 2021–2026 Johan Berglund.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file spinsight-1.3.3.tar.gz.
File metadata
- Download URL: spinsight-1.3.3.tar.gz
- Upload date:
- Size: 543.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
984cef430d89f560c82b215e10861dfdd1b8cc3ded8a6933ea9268e20c5e6365
|
|
| MD5 |
56a99c11d82f50dd48e38d5882cfb588
|
|
| BLAKE2b-256 |
0ae9fa77f50e1f16b0029fd6d7d671fbcef735410d3a28344e1af64a8558b26a
|
File details
Details for the file spinsight-1.3.3-py3-none-any.whl.
File metadata
- Download URL: spinsight-1.3.3-py3-none-any.whl
- Upload date:
- Size: 118.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8b6daff42e0efee5cb662821e662cec1c083cf75414af9aa1c680639cc6f93eb
|
|
| MD5 |
024d97e15ab893af80d1babd216f8a9e
|
|
| BLAKE2b-256 |
b518ad0cfce4407a266bd7743eec6a781c016c0505f609d1635c0f516965ca8a
|
