Artifacts¶

Contract¶

Artifacts are the persisted run outputs: the output directory, saved magnetization states, tables, and field snapshots written by the runtime.

Governing equations¶

No physical equation is owned here.

Symbols and SI units¶

Magnetization state is stored with its own unit metadata; table quantities carry the units defined by the corresponding observables.

Assumptions and validity¶

State formats are validated against the supported set (json, zarr, h5); format is inferred from the path extension when "auto" is requested.

Python API¶

# %% Stage-first study whose executed result can persist final state
import fullmag as fm

nm = 1.0e-9

study = fm.study("artifacts_api_example")
study.engine("fdm")
study.device("cpu", precision="double")
study.mode("strict")

study.objects.mesh.defaults(cell_size=(2 * nm, 2 * nm, 5 * nm))
film = study.geometry(fm.Box(100 * nm, 20 * nm, 5 * nm), name="film")
film.Ms = 800.0e3
film.Aex = 13.0e-12
film.alpha = 0.02
film.m = fm.init.UniformMagnetization((1.0, 0.0, 0.0))
study.exchange()
study.stages.add_run(stage_id="run", until=1.0e-12)

# After execution with a final magnetization, the result persists state:
# result.save_state("relaxed_m.zarr", format="zarr")

ProblemIR¶

Artifacts are runtime outputs; they are not authoring inputs and have no lowering destination.

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.

Saving without final_magnetization raises immediately. Unsupported formats raise rather than writing a best-effort file.

Discrete realization¶

State serialization lives in fullmag/init/state_io.py and supports JSON, Zarr, and HDF5.

Implementation mapping¶

Anchors: packages/fullmag-py/src/fullmag/runtime/simulation.py (Result.save_state) and packages/fullmag-py/src/fullmag/init/state_io.py (save_magnetization).

Validation¶

State round-trip is covered by read/write tests; ownership tests validate the source map.

Limitations¶

Artifact format support does not guarantee interchange with other tools; readers must honor the stored unit and dataset metadata.

Scientific bibliography¶

No physical model is introduced.

Control Room crosswalk¶

Status: Runtime and provenance data are inspection-only; they are not standalone authoring controls.

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¶