This release is a pre-release and may not be stable for production use.
fullmag
Python DSL and API client for Fullmag, a finite-difference (FDM) and finite-element (FEM) micromagnetics platform with CPU and CUDA backends.
Installation
pip install fullmag
# or, with uv
uv add fullmag # in a uv project
uv pip install fullmag # in an existing environment
Optional extras:
| Extra | Adds | Use for |
|---|---|---|
meshing |
gmsh, manifold3d, meshio, scipy, trimesh | FEM geometry and mesh authoring |
figures |
Pillow | image-based textures and figures |
jupyter |
IPython, matplotlib | notebooks and the live monitor |
pip install "fullmag[meshing,jupyter]"
Python 3.10 or newer is required. The package is pure Python.
What this package is
fullmag is the public scripting surface of Fullmag: you describe geometry, materials,
interactions and stages in Python, and the platform lowers them to its canonical ProblemIR.
The solvers themselves (FDM/FEM, CPU/CUDA) are native code and are not part of this wheel.
Works with only pip install fullmag:
- authoring models with the DSL (
fm.geometry, materials, textures, stages) and inspecting them; - mesh authoring with the
meshingextra; - the live API client:
fm.connect()drives a running Fullmag instance over HTTP, andfm.relax(),fm.run()andfm.field("m").to_numpy()then execute on that instance.
Needs a Fullmag runtime (the Docker DEV group or a native build from the repository):
- executing any solver stage. Without
fm.connect()and without the native runner,fm.relax()/fm.run()return aResultwithstatus="not-executable", andfm.connect()to an unreachable URL raisesFullmagConnectionError; - the Control Room UI and the
fullmagcommand-line launcher.
Live example
Start a Fullmag instance (see the repository README), then:
import fullmag as fm
fm.connect("http://127.0.0.1:3197") # or set FULLMAG_URL
fm.engine("fdm")
fm.device("cpu")
fm.cell(5e-9, 5e-9, 10e-9)
fm.solver(fix_dt=1e-13)
layer = fm.geometry(fm.Box(200e-9, 100e-9, 10e-9), name="layer")
layer.Ms = 800e3
layer.Aex = 13e-12
layer.alpha = 0.5
layer.m = fm.texture.uniform(1, 1, 0)
result = fm.relax(dt=1e-13, tolT=1e-4, max_steps=1_000)
m = fm.field("m").to_numpy() # (point_count, 3)
fm.disconnect()
More examples: examples/live. Documentation: https://fullmag.mzelent.pl.
Isolated authoring contexts
The module-level DSL remains compatible with existing scripts. When a process authors more than one document concurrently, bind each document to its own context:
import fullmag as fm
with fm.execution_context():
study = fm.study("document-a")
body = fm.geometry(fm.Box(100e-9, 100e-9, 5e-9), name="body-a")
with fm.ExecutionContext():
study = fm.study("document-b")
body = fm.geometry(fm.Box(100e-9, 100e-9, 5e-9), name="body-b")
ExecutionContext owns the mutable flat authoring state and restores the
previous binding on exit, including exception paths. Async tasks and threads
must use a separate context for each independent document. Entering a context
does not build a mesh or start a solver.
Metadata
Release files for fullmag 0.1.0rc1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| fullmag-0.1.0rc1.tar.gz | 1.4 MB | With provenance | Details for fullmag-0.1.0rc1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| fullmag-0.1.0rc1-py3-none-any.whl | Python 3 | none | any | Details for fullmag-0.1.0rc1-py3-none-any.whl |
Total release size: 2.4 MB
Release files / fullmag-0.1.0rc1.tar.gz
| Download URL | fullmag-0.1.0rc1.tar.gz |
|---|---|
| Size | 1.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d79d82cf43377f0602be5654afc128bf920aa9d33eaf69460b0053a6e8f216a9
|
|
BLAKE2b-256 checksum How to use checksums |
069f24511ec96b7bd60201dbde97513a7372ade90cc88a8bed3c9bedd5b8c83f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.
Transparency logRelease files / fullmag-0.1.0rc1-py3-none-any.whl
| Download URL | fullmag-0.1.0rc1-py3-none-any.whl |
|---|---|
| Size | 952.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0b58fe07673b8182c231a50e3492bc36ccc92355b5442cef91fa5c4b46ed5ae9
|
|
BLAKE2b-256 checksum How to use checksums |
7b12a70ad55ac5c9e5f91ea30521e4ac38cee4856cfaab6de2276870f3e588a9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.
Transparency logSecurity for fullmag 0.1.0rc1
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.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for fullmag-0.1.0rc1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 29, 2026.
Transparency logA 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.