Skip to main content

mrftools

Python / pip package for managing MRF sequence definitions, dictionary definitions, bloch simulation results, and more. Utilizes HDF5 interchange format (.mrf files).

Features

  1. MRF Sequence definitions
    • Intended to define a sequence for execution on the scanner or within a bloch simulation
    • Supports timepoints with varying TR, TE, and FA
    • Supports multiple "beats" with varying RRTime, PrepTime, and PrepID
    • Can be defined programatically via Python, via .txt import, or via .mrf import
    • Can be exported to .txt format or .mrf format (** txt export not implemented fully **)
  2. MRF Dictionary definitions
    • Intended to define a set of dictionary entries to be used by a bloch simulation
    • Supports entries with varying T1, T2, and B0 values
    • Can be defined programatically via Python, via .txt import, or via .mrf import
    • Can be exported to .txt format or .mrf format
  3. MRF Simulation definitions
    • Intended to specify and execute a bloch simulation of a specific sequence over a specific dictionary set
    • Configurable phase range and number of isochromat spins
    • Can either store all isochromat results or perform averaging before saving dictionary
    • Results and configuration can be exported to .mrf format

Installation from pip

  1. pip install mrftools

Installation from source

  1. git clone https://gitlab.casemri.com/common-resources/mrftools
  2. cd mrftools
  3. pip install .

Building and Publishing pip Package

setuptools wheel twine

  1. python3 setup.py bdist_wheel
  2. twine upload dist/*

Metadata

Release files for mrftools 0.2.12

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

Built distribution (wheel)

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

Release files / mrftools-0.2.12-py3-none-any.whl

Download URL mrftools-0.2.12-py3-none-any.whl
Size 271.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e741e755c2dbeb8b2d40334ed268928375fb67f7ceba8e795e570b0ec739515d
BLAKE2b-256 checksum
How to use checksums
a2e2b829e29ec06de017f04c36e9c5926a0353f39e5c5699a474e4c5d6af0d5a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.12

Security for mrftools 0.2.12

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.

Release history Release notifications | RSS feed

This release

0.2.12 This release

1 release file No provenance

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