Provenance¶
Last changes: Documentation changelog
Contract¶
Provenance keeps requested intent separate from resolved execution. A result records the requested backend/mode/precision together with the actual run status and artifact directory.
Governing equations¶
No physical equation is owned here.
Symbols and SI units¶
All fields are identifiers or status strings.
Assumptions and validity¶
Requested and resolved values are normalized but never conflated; a planned result is distinct
from a completed one.
Python API¶
Python |
Type |
Default |
SI unit |
Validation |
Meaning |
Backend support |
ProblemIR |
|---|---|---|---|---|---|---|---|
|
|
|
\(1\) |
Enum value; normalized by runtime selection. |
Requested backend family. |
FEM/FDM CPU/GPU; planner resolves capability. |
|
|
|
|
\(1\) |
Enum value; normalized by runtime selection. |
Requested execution mode. |
FEM/FDM CPU/GPU; planner resolves capability. |
|
|
|
required |
\(1\) |
One of |
Resolved execution outcome. |
FEM/FDM CPU/GPU runtime record. |
|
Record |
Meaning |
||||||
— |
— |
||||||
requested backend/mode/precision |
What the script asked for |
||||||
resolved backend/mode/precision |
What the planner selected after capability checks |
||||||
|
|
||||||
|
Directory of the produced artifacts |
Complete stage-first context¶
# %% Validation/provenance stage-first probe
import fullmag as fm
study = fm.study("api_contract_probe")
study.engine("fdm")
study.device("cpu", precision="double")
study.mode("strict")
study.objects.mesh.defaults(cell_size=(2e-9, 2e-9, 2e-9))
body = study.geometry(fm.Box(40e-9, 20e-9, 4e-9), name="film")
body.Ms = 800.0e3
body.Aex = 13.0e-12
body.m = fm.texture.uniform(1.0, 0.0, 0.0)
study.stages.add_run(stage_id="probe", until=1.0e-12)
Provenance is attached to the study the script authored; the resolved record is read from the
executed Result (see Results).
ProblemIR¶
Lowering preserves the requested descriptors (requested_backend, execution_mode,
execution_precision); resolved execution is runtime output.
Round-trip and failure semantics¶
Requested intent is the value authored by Python and preserved in ProblemIR; resolved execution is the planner or realization result. Validation errors identify the violated domain rule, and unsupported combinations are rejected explicitly rather than silently substituted.
A capability failure must state the unsatisfied combination; it never silently substitutes another backend, device, precision, or physics term.
Discrete realization¶
Planner resolution and runner status are the authoritative provenance sources.
Implementation mapping¶
Anchors: packages/fullmag-py/src/fullmag/model/problem.py (RuntimeSelection) and
packages/fullmag-py/src/fullmag/runtime/simulation.py (class Result).
Validation¶
Capability and round-trip tests require requested/resolved separation to remain observable.
Limitations¶
Provenance records resolution; it does not by itself prove that a GPU lane executed on a current device.
Scientific bibliography¶
No physical model is introduced.
Control Room crosswalk¶
Status: Runtime and provenance data are inspection-only; they are not standalone authoring controls.
Python/API surface |
Control Room path |
Status |
Transaction |
|---|---|---|---|
Parameters documented on this page |
|
|
No runtime-authoring transaction |
Parameters without a named UI field |
|
|
Python-only until implemented |
not implemented: frontend support for runtime-selection and artifact-publication parameters.
See Control Room capability register for the support matrix and not implemented policy.
Frontend source owner: apps/control-room/src/modules/inspector/panels/RuntimeExplorerInspectorPanels.tsx (RuntimeExplorerInspectorPanels).
Source-code index¶
Claim |
Path |
Stable symbol |
Responsibility |
Evidence |
|---|---|---|---|---|
Requested selection |
|
|
Requested descriptors |
Ownership test |
Resolved result |
|
|
Resolved status |
Ownership test |
Source-map coverage¶
Claim |
Path |
Stable symbol |
Responsibility |
Evidence |
|---|---|---|---|---|
Requested runtime descriptors and provenance metadata. |
|
|
Requested runtime descriptors and provenance metadata. |
Source-map validator and focused API tests |
Resolved execution result and status. |
|
|
Resolved execution result and status. |
Source-map validator and focused API tests |