Skip to main content

Core functionality of MRzero

Project description

Documentation Status PyPI - Version

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.

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: Open In Colab

Links

Building from source

This assumes windows as host operating system. For building the python wheel, you need:

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, and uploaded as following:

maturin upload target/wheels/MRzeroCore-{ version }-cp37-abi3-win_amd64.whl target/wheels/MRzeroCore-{ version }-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl -u <pypi-user> -p <pypi-pwd>

The documentation is built using readthedocs, which works the same as described above.

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

mrzerocore-0.4.10.tar.gz (47.5 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

mrzerocore-0.4.10-cp37-abi3-win_amd64.whl (476.6 kB view details)

Uploaded CPython 3.7+Windows x86-64

mrzerocore-0.4.10-cp37-abi3-win32.whl (460.0 kB view details)

Uploaded CPython 3.7+Windows x86

mrzerocore-0.4.10-cp37-abi3-musllinux_1_2_x86_64.whl (772.2 kB view details)

Uploaded CPython 3.7+musllinux: musl 1.2+ x86-64

mrzerocore-0.4.10-cp37-abi3-musllinux_1_2_i686.whl (813.7 kB view details)

Uploaded CPython 3.7+musllinux: musl 1.2+ i686

mrzerocore-0.4.10-cp37-abi3-musllinux_1_2_armv7l.whl (821.9 kB view details)

Uploaded CPython 3.7+musllinux: musl 1.2+ ARMv7l

mrzerocore-0.4.10-cp37-abi3-musllinux_1_2_aarch64.whl (719.4 kB view details)

Uploaded CPython 3.7+musllinux: musl 1.2+ ARM64

mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (563.5 kB view details)

Uploaded CPython 3.7+manylinux: glibc 2.17+ x86-64

mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl (621.2 kB view details)

Uploaded CPython 3.7+manylinux: glibc 2.17+ s390x

mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (673.7 kB view details)

Uploaded CPython 3.7+manylinux: glibc 2.17+ ppc64le

mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (545.9 kB view details)

Uploaded CPython 3.7+manylinux: glibc 2.17+ ARMv7l

mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (542.9 kB view details)

Uploaded CPython 3.7+manylinux: glibc 2.17+ ARM64

mrzerocore-0.4.10-cp37-abi3-manylinux_2_5_i686.manylinux1_i686.whl (606.0 kB view details)

Uploaded CPython 3.7+manylinux: glibc 2.5+ i686

mrzerocore-0.4.10-cp37-abi3-macosx_11_0_arm64.whl (520.4 kB view details)

Uploaded CPython 3.7+macOS 11.0+ ARM64

mrzerocore-0.4.10-cp37-abi3-macosx_10_12_x86_64.whl (532.8 kB view details)

Uploaded CPython 3.7+macOS 10.12+ x86-64

File details

Details for the file mrzerocore-0.4.10.tar.gz.

File metadata

  • Download URL: mrzerocore-0.4.10.tar.gz
  • Upload date:
  • Size: 47.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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}

File hashes

Hashes for mrzerocore-0.4.10.tar.gz
Algorithm Hash digest
SHA256 aa331f77a237ea587d255d9218afe9c849eadf9a3ab90b92ad219a743bda2dd2
MD5 55524fdac1e12feb3a7165fe2d162bff
BLAKE2b-256 b59ab7846e71df76902ae6d9302ba423fd0f2f86d3724f00474d5bdd6ba2aea7

See more details on using hashes here.

File details

Details for the file mrzerocore-0.4.10-cp37-abi3-win_amd64.whl.

File metadata

  • Download URL: mrzerocore-0.4.10-cp37-abi3-win_amd64.whl
  • Upload date:
  • Size: 476.6 kB
  • Tags: CPython 3.7+, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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}

File hashes

Hashes for mrzerocore-0.4.10-cp37-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 9d525c55d6af569cefe506b2d9315c0716882c1a37d0b5d17fa0a15384066470
MD5 a4810a98c50279c170acae7ceb8c5be9
BLAKE2b-256 0ed1ac566707f40acb54570f1e28a7518a6a7c8135f71dcd5689aa4164185499

See more details on using hashes here.

File details

Details for the file mrzerocore-0.4.10-cp37-abi3-win32.whl.

File metadata

  • Download URL: mrzerocore-0.4.10-cp37-abi3-win32.whl
  • Upload date:
  • Size: 460.0 kB
  • Tags: CPython 3.7+, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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}

File hashes

Hashes for mrzerocore-0.4.10-cp37-abi3-win32.whl
Algorithm Hash digest
SHA256 c80c6c4c29d5b2a27dbba7d287ba79cd8812be2e4331880cdb3658b6f2e3fe87
MD5 b7dcd71625453b801da3b323f42986e9
BLAKE2b-256 17fa62c7ba47d6963c357f33be52af42f54f621da0ce5a21a919edc8e67ced3d

See more details on using hashes here.

File details

Details for the file mrzerocore-0.4.10-cp37-abi3-musllinux_1_2_x86_64.whl.

File metadata

  • Download URL: mrzerocore-0.4.10-cp37-abi3-musllinux_1_2_x86_64.whl
  • Upload date:
  • Size: 772.2 kB
  • Tags: CPython 3.7+, musllinux: musl 1.2+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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}

File hashes

Hashes for mrzerocore-0.4.10-cp37-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 43052c53fb0b05a26b2be058024ff06f2bde712fab814dab82b2c191af189ecb
MD5 5ae52eb6c67c4c2d400b169d74b6e835
BLAKE2b-256 4f4f8c794356c6761ce728f36c003b0dcc72521699501098b57666caabf804d5

See more details on using hashes here.

File details

Details for the file mrzerocore-0.4.10-cp37-abi3-musllinux_1_2_i686.whl.

File metadata

  • Download URL: mrzerocore-0.4.10-cp37-abi3-musllinux_1_2_i686.whl
  • Upload date:
  • Size: 813.7 kB
  • Tags: CPython 3.7+, musllinux: musl 1.2+ i686
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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}

File hashes

Hashes for mrzerocore-0.4.10-cp37-abi3-musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 e9ffc4da0af7785214064ea10d4765da31b194920fb6fae705a2540e929fbd80
MD5 78080a41917072d0e62d22347b43d6f9
BLAKE2b-256 89e255aa2285577a50484fc114aefc9633d7270a1d84017eac0dd4b17b225373

See more details on using hashes here.

File details

Details for the file mrzerocore-0.4.10-cp37-abi3-musllinux_1_2_armv7l.whl.

File metadata

  • Download URL: mrzerocore-0.4.10-cp37-abi3-musllinux_1_2_armv7l.whl
  • Upload date:
  • Size: 821.9 kB
  • Tags: CPython 3.7+, musllinux: musl 1.2+ ARMv7l
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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}

File hashes

Hashes for mrzerocore-0.4.10-cp37-abi3-musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 d8775a7c80e6993359a1e011f2d36a537034f8da2c99a71edd7d53a4f6027ba4
MD5 8ae0842f57c4746b2eb715876c5a5ae8
BLAKE2b-256 87448da3cdc527e806dd6e8e8ab82be0107d53048746ffa9c53923e4e0da797c

See more details on using hashes here.

File details

Details for the file mrzerocore-0.4.10-cp37-abi3-musllinux_1_2_aarch64.whl.

File metadata

  • Download URL: mrzerocore-0.4.10-cp37-abi3-musllinux_1_2_aarch64.whl
  • Upload date:
  • Size: 719.4 kB
  • Tags: CPython 3.7+, musllinux: musl 1.2+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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}

File hashes

Hashes for mrzerocore-0.4.10-cp37-abi3-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 4b8f2e0fea6fdee2ec40845e1989f2f724358bd1033d092368ebd9f9bb6b9dd4
MD5 56d16890dd5f061a6b74cba48514915a
BLAKE2b-256 6b2ee395457ae06e87b5145fb5ceb0a967685b2bc953b2a59d3912109ad61c3a

See more details on using hashes here.

File details

Details for the file mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

  • Download URL: mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 563.5 kB
  • Tags: CPython 3.7+, manylinux: glibc 2.17+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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}

File hashes

Hashes for mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 de304a936a2fdd623965d8f47da8fadfd2cb9dda3d99ea5bf687d714fad4a066
MD5 f00887b28d1778e4d2e82e3197729026
BLAKE2b-256 88edf6572f75ef44980f2ffa51a68ccffc8075dd8aed75ebe1a7895d0ca732c0

See more details on using hashes here.

File details

Details for the file mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl.

File metadata

  • Download URL: mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl
  • Upload date:
  • Size: 621.2 kB
  • Tags: CPython 3.7+, manylinux: glibc 2.17+ s390x
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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}

File hashes

Hashes for mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl
Algorithm Hash digest
SHA256 d837963718afe3ee1e7b4fb359c42a2bd2f489af0ef7ceffcf6b7c1c31831b8b
MD5 2f5c5dae980f3e09fdb2ac6f8a889564
BLAKE2b-256 8b5110cf5e66016ecb1d9704cd9217fc8d9d6fb7399bcd933c5f03b88bc5c663

See more details on using hashes here.

File details

Details for the file mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl.

File metadata

  • Download URL: mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl
  • Upload date:
  • Size: 673.7 kB
  • Tags: CPython 3.7+, manylinux: glibc 2.17+ ppc64le
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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}

File hashes

Hashes for mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl
Algorithm Hash digest
SHA256 9873b96798f76c1e8a07256a59be3eb2588e894fe18fb40e8f579aba1b17d4c1
MD5 4bb7873d5e7381f6660116ec28e581b5
BLAKE2b-256 8678ab3fdc07fbf47425a11d392a84cb468a7abc1a34fc8d07db617707834559

See more details on using hashes here.

File details

Details for the file mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl.

File metadata

  • Download URL: mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
  • Upload date:
  • Size: 545.9 kB
  • Tags: CPython 3.7+, manylinux: glibc 2.17+ ARMv7l
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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}

File hashes

Hashes for mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Algorithm Hash digest
SHA256 50432a6c24b93a0844c9c643e58448237b921c329ec150c8614b270959be41a8
MD5 7dbe07bdcdfbcbf61f4db8078fd710cc
BLAKE2b-256 fb47a07745e3d87bdd77dc6416e9a5793adb79181b546f3ac82c9f486230885e

See more details on using hashes here.

File details

Details for the file mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

  • Download URL: mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
  • Upload date:
  • Size: 542.9 kB
  • Tags: CPython 3.7+, manylinux: glibc 2.17+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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}

File hashes

Hashes for mrzerocore-0.4.10-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 406b34961506f022622f08c2b1ea7611125cbd8eba9ed1b0e53e2e810d82ae09
MD5 c09ccc8d2bf692d5ba3e579c40c8d414
BLAKE2b-256 20067e5974a7b52e787529e05daff39bf142c9ff71355036fad49ba8f8e6863f

See more details on using hashes here.

File details

Details for the file mrzerocore-0.4.10-cp37-abi3-manylinux_2_5_i686.manylinux1_i686.whl.

File metadata

  • Download URL: mrzerocore-0.4.10-cp37-abi3-manylinux_2_5_i686.manylinux1_i686.whl
  • Upload date:
  • Size: 606.0 kB
  • Tags: CPython 3.7+, manylinux: glibc 2.5+ i686
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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}

File hashes

Hashes for mrzerocore-0.4.10-cp37-abi3-manylinux_2_5_i686.manylinux1_i686.whl
Algorithm Hash digest
SHA256 87219b56c46df58d7d4d6e2301b13d9efcb207734f63616b91fa66d6346f57aa
MD5 8e8a9fb068bdd63936f5dd78aa572562
BLAKE2b-256 ef995252bda732fd0b305a66c3fecebba451c5da62ace6436d256d34dc41322f

See more details on using hashes here.

File details

Details for the file mrzerocore-0.4.10-cp37-abi3-macosx_11_0_arm64.whl.

File metadata

  • Download URL: mrzerocore-0.4.10-cp37-abi3-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 520.4 kB
  • Tags: CPython 3.7+, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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}

File hashes

Hashes for mrzerocore-0.4.10-cp37-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 fe24ddf2cefc328cf218f7f85d8763bd82d881b72889cbcfccb22b35f97448ed
MD5 af3f497097031532b5f0771f3d644912
BLAKE2b-256 15285542e7e47be4c9e1839f9643214e3bb6ad9da082c0e16fb1271db06ae354

See more details on using hashes here.

File details

Details for the file mrzerocore-0.4.10-cp37-abi3-macosx_10_12_x86_64.whl.

File metadata

  • Download URL: mrzerocore-0.4.10-cp37-abi3-macosx_10_12_x86_64.whl
  • Upload date:
  • Size: 532.8 kB
  • Tags: CPython 3.7+, macOS 10.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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}

File hashes

Hashes for mrzerocore-0.4.10-cp37-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 0be615c48491868a8eadede615d6f01e684c859805ee8f8a7cc9f22563a70313
MD5 3b2097c4b91c08fa5280bc7efe36f221
BLAKE2b-256 8b4946fabfc646c94cd8d6f446ae95230dc6fbfb8246960e2d88e3a97a671d7c

See more details on using hashes here.

Supported by

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