pymagba 0.5.0

Performant magnetic computation powered by Rust

PyMagba

---

PyMagba is a package for analytical magnetic computation, powered by Rust. All functions support numpy and parallelization.

Quick Start

from pymagba.magnets import *
from pymagba.sensors import *

magnet = CylinderMagnet(
   position=[0.0, 0.0, 0.01],
   diameter=0.01,
   height=0.005,
   polarization=[0.0, 0.0, 1.0],
)
sensor = LinearHallSensor(
   position=[0.0, 0.0, 0.025],
   sensitive_axis=[0.0, 0.0, 1.0],
   sensitivity=0.05,
   supply_voltage=5.0,
)
b_field = magnet.compute_B([0.0, 0.0, 0.025])  # [[0, 0, 0.01652363]]
voltage = sensor.read_voltage(magnet)  # 2.5008261

Installation

To install PyMagba, use your preferred package manager:

pip install pymagba

uv add pymagba

To install from source see the Reproducibility section.

Reproducibility

Clone into the repository:

git clone https://github.com/p-sira/pymagba.git
cd pymagba

To reproduce the build:

uv sync --group dev
cargo run --bin stub_gen --no-default-features --features=stub-gen
maturin build --release

Installing the build:

pip install target/wheels/pymagba-*.whl

Generating the docs:

uv sync --group dev
mkdir docs
cd docs
make html

To verify the installation and the generated stubs:

uv run pytest python/tests
uv run mypy python/pymagba