Skip to main content

Python implementation (translation) of qMRLab models for quantitative MRI.

Project description

qmrpy

PyPI

qMRLab(MATLAB実装)の概念・モデルを Python へ段階的に移植するためのリポジトリです。

本プロジェクトは upstream の qMRLab(MIT License)に着想を得ており、モデル定義・検証方針は qMRLab を参照しつつ Python で再構成します。

開発(ローカル)

現時点では最小のパッケージ雛形のみです(今後、モデル実装を段階的に追加します)。

  • uv sync --extra viz(可視化を含める)
  • uv sync --extra viz --extra dev(pytest/ruff 等を含める)
  • uv run --locked -m pytest

パッケージ利用

uv を使う場合の導入例:

uv add qmrpy

最小利用例

import numpy as np
from qmrpy.models.t1.vfa_t1 import VfaT1

model = VfaT1(
    tr_s=0.015,
    flip_angles_deg=np.array([2, 5, 10, 15]),
)

signal = model.forward(m0=1.0, t1_s=1.2)
fit = model.fit_linear(signal)
print(fit["t1_s"], fit["m0"])

ライセンス

  • qmrpy 本体:MIT(LICENSE
  • 参照元 qMRLab/:MIT(upstream、ローカル参照用)
  • 翻訳・参考実装・vendor の詳細は THIRD_PARTY_NOTICES.md を参照

第三者由来コードの扱い

  • qMRLab(MATLAB)および DECAES.jl の概念・アルゴリズムを翻訳/再構成しています。
  • epgpysrc/epgpy/ に vendor しています。
  • ライセンス表記・出自は THIRD_PARTY_NOTICES.md に集約しています。

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

qmrpy-0.1.2.tar.gz (250.5 kB view details)

Uploaded Source

Built Distribution

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

qmrpy-0.1.2-py3-none-any.whl (118.2 kB view details)

Uploaded Python 3

File details

Details for the file qmrpy-0.1.2.tar.gz.

File metadata

  • Download URL: qmrpy-0.1.2.tar.gz
  • Upload date:
  • Size: 250.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for qmrpy-0.1.2.tar.gz
Algorithm Hash digest
SHA256 5f5f6cd46253ea6c53cf9eee48ea542ac9b933aff3235a155e5773f22b62e9c7
MD5 e671037c0f9b3acbb4702b773c80762b
BLAKE2b-256 e639bd2456055d4b33e1fe6f9e897f61a8bd17c8bd963e7bb4ec8f567adf8a0f

See more details on using hashes here.

File details

Details for the file qmrpy-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: qmrpy-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 118.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for qmrpy-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0c8f7d0a64932bf56816ffb68b317a1436a10c73d90c8c8165750a6763544a40
MD5 c07a3e2246b7d0feb5dd65516b17609f
BLAKE2b-256 482e8f0fe0d6f70a219dcbae1422e849fc8a1fc5df5aa05c84edd6229d66c8be

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