Getting started¶
Last changes: Documentation changelog
This section installs the Python authoring layer and solver runtime, then introduces the public stage-oriented workflow for finite-difference (FDM) and finite-element (FEM) simulations. Each tutorial states the requested backend, device, precision, interactions, mesh, solver, stopping criteria, and expected artifacts.
Recommended sequence¶
Installation — install
fullmagfrom PyPI or source and start the Docker Compose DEV runtime.First FDM simulation — run a structured-grid relaxation through the CPU FDM lane.
First FEM simulation — run the corresponding physical workflow on an unstructured FEM mesh with an airbox demagnetization solve.
Choosing a solver — select FDM or FEM and CPU or GPU from the documented capability and validation scope.
Interactive Live Python & REPL — connect a terminal, script, or Jupyter notebook directly to a running Control Room session via
fm.connect().Control Room — author, launch, monitor, and inspect a study through the browser interface.
Execution semantics¶
study.engine(...), study.device(...), study.mode(...), the discretization, and all solver
parameters express requested intent. Before execution, FullMag validates the complete request and
resolves a concrete numerical lane. The result records requested and resolved values separately.
In strict mode, an unsupported combination fails before backend startup. The runtime does not
silently replace an interaction, device, precision, solver, or mesh class. A successful run proves
execution only for the resolved lane and workload; it does not establish cross-backend parity or
scientific qualification.
Running a tracked example¶
After configuring the Docker DEV workspace on the installation page, execute the repository-owned FDM smoke scenario inside your checkout’s Compose group:
just fullmag-dev-container examples/fdm_cpu_relax_smoke.py
If your just docker-dev group is already running with an empty workspace, run
just docker-dev-script examples/fdm_cpu_relax_smoke.py instead, or attach interactively from
Python with Interactive Live Python & REPL.
Use the FDM and FEM tutorials for complete copyable studies, expected outputs, and stated limits.
Control Room crosswalk¶
Use the authoring path stated in this guide, normally Model Explorer -> Objects followed by the relevant Geometry, Material, Physics, Mesh, or Stage panel. Any parameter shown in Python but not shown in that path is TODO: frontend support; do not describe it as configurable in the UI. See Control Room capability register.
Python/API crosswalk¶
The runnable Python example and exact argument contract are authoritative. If this guide is conceptual or does not contain a runnable example, it explicitly defers to the linked Python API page rather than duplicating an unverified signature.
Physics, limitations, and bibliography¶
Use the linked physics or numerical-methods page for governing equations and assumptions. This onboarding page does not add a new physical model. Bibliography: see the linked terminal API or physics page; no additional source is claimed here.
Bibliography¶
No independent scientific model is introduced by this navigation page. Use the bibliography on the selected terminal page; this statement is an explicit applicability boundary, not an omitted reference.
Source-code index¶
This is a navigation page and introduces no standalone implementation symbol. The exact source-code index is maintained by the selected terminal page.