MRzero Core
The MRzero Core contains the core functionality of MRzero like MRI sequence building, simulation and reconstruction. MRzero Core does not force you to take any particular approach to e.g., reconstruction, as it targets easy integration in existing projects. Nevertheless, more tools can be added in the future if they helpful for the general application space.
🎉 1.0 release
Version 1.0 adds Pulseq 1.5 support and flips the sign convention of the simulated signal, so that it is now the complex conjugate of what previous versions returned. Reconstruction accordingly switches from
ffttoifft.See the FFT sign conventions page for details, and the CHANGELOG for the full list of changes. If anything else broke, please open an issue.
Usage
MRzero Core is written in Python, heavily relying on PyTorch for fast (GPU-) Tensor calculations. To improve performance, parts of the simulation are written in Rust and compiled for x86 Windows and Linux, other platforms are currently not supported.
Install with pip:
pip install MRzeroCore
The typical way of using it is like the following:
import MRzeroCore as mr0
Examples on how to use MR-zero can be found in the Playground.
Pulseq Integration
MRzero Core makes Pulseq simulation incredibly easy - simulate any .seq file in just one line:
import MRzeroCore as mr0
# Simulate any Pulseq file
seq = mr0.Sequence.import_file("your_sequence.seq")
signal = mr0.util.simulate(seq) # That's it!
Key Features:
- One-line simulation of any Pulseq .seq file
- PyPulseq integration - write sequences in Python, simulate with MR-zero
- Google Colab ready - 13+ ready-to-run examples
- MATLAB ↔ Python workflow - create in MATLAB Pulseq, simulate in Python
- No dependencies - fully self-contained Pulseq parser included
- Scanner-ready export - export MR-zero sequences as .seq files
Try it now:
Links
- Documentation: https://mrsources.github.io/MRzero-Core
- Examples: Playground
- PyPI: https://pypi.org/project/mrzerocore/
- Original MRzero Paper: https://arxiv.org/abs/2002.04265
Building from source
This assumes windows as host operating system. For building the python wheel, you need:
- the Rust toolchain: rustup
- the rust-python build tool tool: pip install maturin
- for Linux crosscompilation: docker
- to build the documentation: mdBook
Building for Windows
maturin build --interpreter python
Building for Linux
docker run --rm -v <path-to-repo>/MRzero-Core:/io ghcr.io/pyo3/maturin build
Building the documentation
Install newest (beta) version of mdBook:
cargo install --git https://github.com/rust-lang/mdBook.git mdbook
Run a live-preview server:
# in the root directory:
mdbook serve documentation
Official builds
The python wheels hosted by PyPI is built as described above. It is deployed as GitHub action (see pypi_publish.yml)
1 maintainer
Release files for mrzerocore 1.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mrzerocore-1.1.1.tar.gz | 75.9 MB | Details |
Built distributions (wheels)
Total release size: 84.6 MB
Release files / mrzerocore-1.1.1.tar.gz
| Download URL | mrzerocore-1.1.1.tar.gz |
|---|---|
| Size | 75.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b5016d654ceff74d693f24b895b5f9c3d5dcb6851cef44ab7eafe8d6d6ba4b55
|
|
BLAKE2b-256 checksum How to use checksums |
09f96e09affdf870e3b030dd226460f495764e9e36b9fde5ae90f6fe0f36824c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mrzerocore-1.1.1-cp37-abi3-win_amd64.whl
| Download URL | mrzerocore-1.1.1-cp37-abi3-win_amd64.whl |
|---|---|
| Size | 477.6 kB |
| Tags | CPython 3.7 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
e22ff819b013754d3c0caa1f65ef0d6d3014fd84735d4366c8766b495aa92be6
|
|
BLAKE2b-256 checksum How to use checksums |
723d8246b903aba3318cb601c4910eba7e17262fa6d1b437eaeae4c61afb6001
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mrzerocore-1.1.1-cp37-abi3-win32.whl
| Download URL | mrzerocore-1.1.1-cp37-abi3-win32.whl |
|---|---|
| Size | 461.0 kB |
| Tags | CPython 3.7 Windows x86-32 abi3 |
|
SHA-256 checksum How to use checksums |
0432db224591adbfa76a959dace0bac8ef0fc8c5069ee11734f6d0c6a6b637c2
|
|
BLAKE2b-256 checksum How to use checksums |
58b1bbe422b7e895ca244005cd96ce466b4854cde26bafda9fb7638b50b980c7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mrzerocore-1.1.1-cp37-abi3-musllinux_1_2_x86_64.whl
| Download URL | mrzerocore-1.1.1-cp37-abi3-musllinux_1_2_x86_64.whl |
|---|---|
| Size | 774.5 kB |
| Tags | CPython 3.7 Linux musl 1.2+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
d71528ee55656d2fa3097f60a18a2448747bdc84bf6b0bc18392621a4b334bd9
|
|
BLAKE2b-256 checksum How to use checksums |
8973c09ca91cdbeadc6ef813ab892d28d41596da57860a18c68722f5093faafd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mrzerocore-1.1.1-cp37-abi3-musllinux_1_2_i686.whl
| Download URL | mrzerocore-1.1.1-cp37-abi3-musllinux_1_2_i686.whl |
|---|---|
| Size | 815.5 kB |
| Tags | CPython 3.7 Linux musl 1.2+ x86-32 abi3 |
|
SHA-256 checksum How to use checksums |
1f0824ace44edc58d03e65d8c49230ba0caf6df0c35757cdee768cabf685ce2b
|
|
BLAKE2b-256 checksum How to use checksums |
31822460ecac01ba03fab880fcd53bcde30b0bd9aacbac1a304874a531146d3e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mrzerocore-1.1.1-cp37-abi3-musllinux_1_2_armv7l.whl
| Download URL | mrzerocore-1.1.1-cp37-abi3-musllinux_1_2_armv7l.whl |
|---|---|
| Size | 825.4 kB |
| Tags | CPython 3.7 Linux musl 1.2+ ARMv7l abi3 |
|
SHA-256 checksum How to use checksums |
18df5677fcbd8e2899648968f7e9edb95c7adf2e0d750ba5582ebc64566af071
|
|
BLAKE2b-256 checksum How to use checksums |
2c2052e0d4f2a1a45e28da7b8d229cba4b1907c4160603580a44e229555bc774
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mrzerocore-1.1.1-cp37-abi3-musllinux_1_2_aarch64.whl
| Download URL | mrzerocore-1.1.1-cp37-abi3-musllinux_1_2_aarch64.whl |
|---|---|
| Size | 719.0 kB |
| Tags | CPython 3.7 Linux musl 1.2+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
8f23cdf22c6d578e4459e6d65829aa08d44b800426ccb8109a688d8517ddc0db
|
|
BLAKE2b-256 checksum How to use checksums |
50796ba4e2488c50c885870e4afeb6c1224154239b7e0946deadf1dd83d5ee65
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mrzerocore-1.1.1-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | mrzerocore-1.1.1-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 565.6 kB |
| Tags | CPython 3.7 Linux glibc 2.17+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
7ce5fed8bf0b9d24beaca4ebbb48f60da4b5af185bcd978b3495e58529c9c485
|
|
BLAKE2b-256 checksum How to use checksums |
31f577ee5a7e15c070fb3985ce4a186018dec82e23dddc0968dbd509367eb09f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mrzerocore-1.1.1-cp37-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl
| Download URL | mrzerocore-1.1.1-cp37-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl |
|---|---|
| Size | 623.1 kB |
| Tags | CPython 3.7 Linux glibc 2.17+ IBM System/390x abi3 |
|
SHA-256 checksum How to use checksums |
e5888a4983d57083e28bfec0d6ebe3452a7a7d8739701b077e567daad4a9253e
|
|
BLAKE2b-256 checksum How to use checksums |
6622a244e64998b35a4ccacbb3c52e91bbca2c6e667161cd524c82d1a5bb6070
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mrzerocore-1.1.1-cp37-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl
| Download URL | mrzerocore-1.1.1-cp37-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl |
|---|---|
| Size | 675.0 kB |
| Tags | CPython 3.7 Linux glibc 2.17+ PowerPC 64-le abi3 |
|
SHA-256 checksum How to use checksums |
362c398a6d61e7242cd3e0ed5c0cb07f6d0fac7ea5d06d48b4908220b9ad5d6b
|
|
BLAKE2b-256 checksum How to use checksums |
4cd2d7ed850a0744dc63607b43a18e3b58b2c30ebe65700b868df63165369a67
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mrzerocore-1.1.1-cp37-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
| Download URL | mrzerocore-1.1.1-cp37-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl |
|---|---|
| Size | 547.9 kB |
| Tags | CPython 3.7 Linux glibc 2.17+ ARMv7l abi3 |
|
SHA-256 checksum How to use checksums |
2837518d544f37d2c33d32fe15bafbf3dae95f3c0c1f37219a9fd1b0b102eb2a
|
|
BLAKE2b-256 checksum How to use checksums |
03e90306217f116eb21106a70504722751406a22218eadb74e44debc96481a0c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mrzerocore-1.1.1-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
| Download URL | mrzerocore-1.1.1-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl |
|---|---|
| Size | 541.1 kB |
| Tags | CPython 3.7 Linux glibc 2.17+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
cfe428cd376fe8057138b41efada4053797f565b891e29b77c8600c8395bd3d7
|
|
BLAKE2b-256 checksum How to use checksums |
16ce46848fd05334e2924f04c10e233c10eacf39dd9e978d305873060bc093ba
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mrzerocore-1.1.1-cp37-abi3-manylinux_2_5_i686.manylinux1_i686.whl
| Download URL | mrzerocore-1.1.1-cp37-abi3-manylinux_2_5_i686.manylinux1_i686.whl |
|---|---|
| Size | 608.8 kB |
| Tags | CPython 3.7 Linux glibc 2.5+ x86-32 abi3 |
|
SHA-256 checksum How to use checksums |
42da046837d2bd7730bc2d9962a1e8b7fe062840d63aa77784be73b276943f55
|
|
BLAKE2b-256 checksum How to use checksums |
5aca10fb59af8c95179cbffb35595b663e432b05c4991b1a3daccf9f650e72d8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mrzerocore-1.1.1-cp37-abi3-macosx_11_0_arm64.whl
| Download URL | mrzerocore-1.1.1-cp37-abi3-macosx_11_0_arm64.whl |
|---|---|
| Size | 519.2 kB |
| Tags | CPython 3.7 abi3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
54c5021f9723807444648b8c3a9dc1cbbeb735b71ee5d1177b29a3846289277c
|
|
BLAKE2b-256 checksum How to use checksums |
113aef35622292c2c16e8c85db9dacffe89c5d9a26c1dd458b054e2e6d64a518
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mrzerocore-1.1.1-cp37-abi3-macosx_10_12_x86_64.whl
| Download URL | mrzerocore-1.1.1-cp37-abi3-macosx_10_12_x86_64.whl |
|---|---|
| Size | 531.4 kB |
| Tags | CPython 3.7 abi3 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
3d65994721f78e8e5f6d392c575fee99264b2ff0d67251ee176be555021d1e0d
|
|
BLAKE2b-256 checksum How to use checksums |
b75e23d5b1b8bdab7aab0e81208c9d52ff1f2141adafe0237d80c723bd362e68
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
