Version: dev

Simulation

Building a problem from a document, integrating it, and reading states and observed quantities from the solution.

These operations belong to the simulation capability profile: Julia, Python, Rust.

OperationKindBindingsSummary
callbacksfunctionJulia, Python, RustThe problem’s own callback set — the composition of its data-refresh, output-sink and checkpoint callbacks, or nothing when it has none.
esm_problemfunctionJulia, Python, RustBuild the ESM simulation problem for input over tspan = (t0, t1) — the one noun of esm-libraries-spec §2.5.
evaluate_cellwisefunctionJulia, RustEvaluate an array-valued expression (elementwise ops over array-producing faq/makearray nodes — e.g. a grid-geometry template expanded by a §9.7 import, or a §6.6.5 analytic…
field_reducefunctionJulia, RustCollapse a spatial field to the scalar a §6.6.5 reduce assertion compares (esm-spec §6.6.5):
initfunctionPython, RustBuild a stepping Integrator over prob (esm-libraries-spec §2.5.6).
observed_fieldfunctionJulia, Python, RustThe observed name of the problem, as a flat vector in row-major cell order (last index fastest; one element for a scalar observed).
remakefunctionPython, RustA NEW EsmProblem with the named substitutions applied, everything else shared.
resolve_tolerancesfunctionJulia, TypeScript, Python, RustResolve integration tolerances most-specific first (esm-spec §2.2.2):
run_inline_testsfunctionJulia, RustRun every inline test (esm-spec §6.6, including the §6.6.5 PDE assertions) of the selected component(s) of inputs through the official tree-walk simulation pathway, and return…
solvefunctionPython, RustRun prob to completion and return its Solution.
stepfunctionPython, RustAdvance integrator one accepted step — the spec’s step!.
assertion_resulttypeJulia, RustOutcome of one (file, container, test, assertion_idx) evaluation — the ONE result type both inline-test runners produce (run_esm_tests over the MTK engine and…
callback_settypePython, RustAn ordered, immutable set of callbacks, declared on a EsmProblem.
compilertypePython, RustThe type a caller’s compiler keyword takes.
compiler_reporttypeJulia, Python, RustWhat a build did, per rule.
ensemble_problemtypePython, RustA EsmProblem plus a per-trajectory rewrite (esm-libraries-spec §2.5.8).
esm_problemtypeJulia, Python, RustThe ESM simulation problem: the right-hand side f! the chosen compiler built — the compiled tree walk under :native / :interpreter, the compiled StableHLO program under…
inline_test_optionstypeJulia, RustPer-document overrides for run_inline_tests, returned by its options_for callback.
integratortypePython, RustA stepping integrator over a EsmProblem (esm-libraries-spec §2.5.6).
return_codetypePython, RustThe SciML ReturnCode vocabulary (API_SPEC §4, esm-libraries-spec §2.5.3), which is how a run reports its outcome in every simulating binding.
solutiontypePython, RustWhat earthsci_ast.problem.solve returns.
simulate_errorerrorJulia, RustException thrown when a simulation Problem cannot be built or run (API_SPEC §5.8): esm_problem given a missing file or an unsupported input, an override in p / u0 that…
default_abstolconstantTypeScript, RustBinding default absolute tolerance (API_SPEC §5.8) — the bottom of the §2.2.2 chain, used when neither the caller nor solver.abstol sets one.
default_reltolconstantTypeScript, RustBinding default relative tolerance (API_SPEC §5.8) — the bottom of the §2.2.2 chain, used when neither the caller nor solver.reltol sets one.

All topics