komamripy 0.0.2__py3-none-any.whl

komamripy/__init__.py

@@ -0,0 +1,56 @@
+"""komamripy — a Python interface to KomaMRI.jl, the Julia MRI simulator.
+
+komamripy mirrors the KomaMRI Julia namespace through juliacall: any name that
+KomaMRI exposes is available as an attribute of ``komamripy``. As a result,
+Julia code translates to Python almost line for line.
+
+Julia::
+
+    using KomaMRI
+    sys = Scanner()
+    obj = brain_phantom2D()
+    seq = PulseDesigner.EPI_example()
+    sim_params = KomaMRICore.default_sim_params()
+    raw = simulate(obj, seq, sys; sim_params)
+
+Python::
+
+    import komamripy as km
+    import numpy as np
+
+    sys = km.Scanner()
+    obj = km.brain_phantom2D()
+    seq = km.PulseDesigner.EPI_example()
+    sim_params = km.KomaMRICore.default_sim_params()
+    raw = km.simulate(obj, seq, sys, sim_params=sim_params)
+
+Simulation results are returned as Julia objects; use ``numpy.asarray`` to
+convert array-like results (such as a ``"mat"`` signal) into NumPy arrays.
+"""
+
+from ._session import get_julia
+
+
+def __getattr__(name):
+    """Resolve attribute access against the Julia session (the KomaMRI mirror).
+
+    Python invokes this only when normal module lookup fails, so anything
+    defined or imported in this module takes precedence, and the Julia session
+    starts lazily on the first real attribute access.
+
+    Note: any Python-side helper submodule added in future must be imported
+    explicitly in this file, otherwise the mirror would shadow it whenever its
+    name also exists in Julia (Julia's Base exports ``diff``, for instance).
+    """
+    # Avoid starting Julia just to answer dunder probes from the import system.
+    if name.startswith("__") and name.endswith("__"):
+        raise AttributeError(name)
+
+    jl = get_julia()
+
+    try:
+        return getattr(jl, name)
+    except AttributeError as exc:
+        raise AttributeError(
+            f"module 'komamripy' has no attribute '{name}'; KomaMRI does not expose it"
+        ) from exc

komamripy/_session.py

@@ -0,0 +1,30 @@
+"""Management of the Julia session that backs komamripy.
+
+The Julia runtime and KomaMRI are loaded lazily on first use, so importing
+komamripy stays inexpensive until a Julia-backed feature is actually called.
+All access to Julia flows through :func:`get_julia`.
+"""
+
+from __future__ import annotations
+
+_session = None  # cached juliacall ``Main`` module, created on first use
+
+
+def get_julia():
+    """Return the initialized Julia ``Main`` module, starting it if needed.
+
+    On the first call this imports juliacall (which provisions a private Julia
+    if one is not already available), loads KomaMRI, and caches the resulting
+    ``Main`` module for reuse.
+
+    ``using KomaMRI`` is evaluated as source because ``using`` is Julia syntax
+    rather than a callable; every other interaction with KomaMRI uses ordinary
+    attribute access on the returned module.
+    """
+    global _session
+    if _session is None:
+        from juliacall import Main as jl
+
+        jl.seval("using KomaMRI")
+        _session = jl
+    return _session

komamripy/juliapkg.json

@@ -0,0 +1,24 @@
+{
+  "packages": {
+    "KomaMRI": {
+      "uuid": "6a340f8b-2cdf-4c04-99be-4953d9b66d0a",
+      "version": "=0.10.4"
+    },
+    "KomaMRIBase": {
+      "uuid": "d0bc0b20-b151-4d03-b2a4-6ca51751cb9c",
+      "version": "=0.11.3"
+    },
+    "KomaMRICore": {
+      "uuid": "4baa4f4d-2ae9-40db-8331-a7d1080e3f4e",
+      "version": "=0.11.3"
+    },
+    "KomaMRIFiles": {
+      "uuid": "fcf631a6-1c7e-4e88-9e64-b8888386d9dc",
+      "version": "=0.10.4"
+    },
+    "KomaMRIPlots": {
+      "uuid": "76db0263-63f3-4d26-bb9a-5dba378db904",
+      "version": "=0.11.0"
+    }
+  }
+}

komamripy-0.0.2.dist-info/METADATA

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: komamripy
+Version: 0.0.2
+Summary: Pulseq-compatible, high-performance MRI simulation in Python, powered by KomaMRI.jl.
+Project-URL: Homepage, https://github.com/JuliaHealth/komamripy
+Project-URL: Repository, https://github.com/JuliaHealth/komamripy
+Project-URL: Issues, https://github.com/JuliaHealth/komamripy/issues
+Author: Anvika Singhal
+Author-email: Carlos Castillo Passi <cacp@stanford.edu>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: Julia,KomaMRI,MRI,Pulseq,medical-imaging,simulation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
+Requires-Python: >=3.10
+Requires-Dist: juliacall>=0.9.20
+Description-Content-Type: text/markdown
+
+# komamripy
+
+[![CI](https://github.com/JuliaHealth/komamripy/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/JuliaHealth/komamripy/actions/workflows/ci.yml)
+
+**Pulseq-compatible, high-performance MRI simulation in Python.**
+
+`komamripy` is a thin Python interface to
+[KomaMRI.jl](https://github.com/JuliaHealth/KomaMRI.jl), a high-performance
+Julia framework for MRI simulation. It exposes KomaMRI to Python through
+[juliacall](https://juliapy.github.io/PythonCall.jl/stable/juliacall/), so
+Python users can run fast CPU/GPU MRI simulations without writing any Julia.
+
+## Installation
+
+Install by using [uv](https://docs.astral.sh/uv/) (recommended) or pip (remove uv):
+
+```bash
+uv pip install git+https://github.com/JuliaHealth/komamripy
+```
+
+You do **not** need to install Julia yourself: `juliacall` provisions a suitable
+Julia automatically, and KomaMRI is installed on first import.
+
+## Quick start
+
+The first import downloads Julia and precompiles KomaMRI, which can take a few
+minutes. Subsequent runs are fast.
+
+```python
+import komamripy as km
+import numpy as np
+
+sys = km.Scanner()                       # scanner hardware
+obj = km.brain_phantom2D()               # 2D brain phantom
+seq = km.PulseDesigner.EPI_example()     # example EPI sequence
+
+sim_params = km.KomaMRICore.default_sim_params()
+sim_params["return_type"] = "mat"        # return the raw signal matrix
+
+raw = km.simulate(obj, seq, sys, sim_params=sim_params)
+signal = np.asarray(raw)
+
+print(signal.shape)
+```
+
+A runnable version lives in [`examples/`](examples/).
+
+## How it works
+
+`komamripy` mirrors the KomaMRI Julia namespace: any function or type that
+KomaMRI exposes is available as an attribute of `komamripy`. Julia code
+therefore translates to Python almost line for line.
+
+Simulation results are returned as Julia objects; convert array-like results to
+NumPy with `numpy.asarray`.
+
+## Status
+
+`komamripy` is under active development as a Google Summer of Code project.
+
+Currently supported: the core simulation pipeline and reading Pulseq files.
+
+Planned: PyPI releases, GPU backend selection, tighter pypulseq integration,
+and differentiable workflows.

komamripy-0.0.2.dist-info/RECORD

@@ -0,0 +1,7 @@
+komamripy/__init__.py,sha256=YViFE3kuJoDAvNozq3uWqAufSAoFPZe7M_Xm_7x-gmM,1913
+komamripy/_session.py,sha256=EIn551Vy6XZ8SzypnNooDhbhTuQJdk_a20CwDJRoSBY,1037
+komamripy/juliapkg.json,sha256=iNHgvxPnP3VTkpA3iopiuwrybCcaRKkVOALlTZqo6GY,566
+komamripy-0.0.2.dist-info/METADATA,sha256=UqTBkvWj7CAf0cGHNGpU8J9q9dp6LDxK6FJHRudebkg,3101
+komamripy-0.0.2.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+komamripy-0.0.2.dist-info/licenses/LICENSE,sha256=ki-YGkgdVygl8ObgkPEvgSJK57-R8gLO29vfS80w8GM,1078
+komamripy-0.0.2.dist-info/RECORD,,

komamripy-0.0.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

komamripy-0.0.2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Carlos Castillo Passi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.