← Python SDK / run

PYTHONPUBLIC API

fastsim.api.run

Current public Python API for fastsim.api.run; signatures are extracted directly from the vNext AST.

Source src/fastsim/api/run.py

FastSimRun open_plan open

Public symbols 3

class

FastSimRun

L27

class FastSimRun(object)

Blocking application facade for exactly one immutable ExecutionPlan. Runtime, root control, bundle, backend and simulator-native objects remain behind the private composition root. Plugins use their injected async scoped services instead of calling this synchronous facade.

run_id

FastSimRun.run_id(self) -> str

No public docstring is provided in the current source.

plan_digest

FastSimRun.plan_digest(self) -> str

No public docstring is provided in the current source.

prepare

FastSimRun.prepare(self, timeout: float | None=None) -> ApplicationSnapshot

No public docstring is provided in the current source.

start

FastSimRun.start(self, timeout: float | None=None) -> ApplicationSnapshot

Prepare when necessary, then start plugins before Runtime physics.

pause

FastSimRun.pause(self, timeout: float | None=None) -> ApplicationSnapshot

No public docstring is provided in the current source.

resume

FastSimRun.resume(self, timeout: float | None=None) -> ApplicationSnapshot

No public docstring is provided in the current source.

single_step

FastSimRun.single_step(self, timeout: float | None=None) -> ApplicationSnapshot

No public docstring is provided in the current source.

reset

FastSimRun.reset(self, timeout: float | None=None) -> ApplicationSnapshot

No public docstring is provided in the current source.

stop

FastSimRun.stop(self, timeout: float | None=None) -> ApplicationSnapshot

Fully tear down the Run; use :meth:`pause` to preserve its world.

snapshot

FastSimRun.snapshot(self) -> ApplicationSnapshot

No public docstring is provided in the current source.

plugin_status

FastSimRun.plugin_status(self) -> PluginHostSnapshot | None

No public docstring is provided in the current source.

close

FastSimRun.close(self, timeout: float | None=None) -> ApplicationSnapshot

Close composition and its loop exactly once, attempting both layers.

function

open_plan

L183

open_plan(plan: ExecutionPlan, *, timeout: float | None=None, output_policy: RunOutputPolicy | None=None, checkpoint: str | Path | None=None) -> FastSimRun

Open one already compiled plan on a dedicated application-loop thread.

function

open

L250

open(path: str | Path, lock: str | Path | None=None, *, launch_profile: str | None=None, timeout: float | None=None, output_policy: RunOutputPolicy | None=None) -> FastSimRun

Compile a project Run, optionally override its launch profile, then open it. ``launch_profile`` is only a compilation input. It cannot modify an existing lock; regenerate the lock with the desired profile instead.