Layout API

Layout is also exported from simulatte. All other declarations below are exported from simulatte.layout. The runnable layout guide covers author files, networks, stages, migration, diagnostics and saved presentation reuse. APIs remain unstable during active development.

Environment and resolution

register_resource_owner(
    manager: Any,
    *,
    owner: object,
    graph: GraphRef,
    binder: str,
) -> None

prepare() returns a cached ResolvedLayout after all component and custom binders finish. Its values, auto, network, closure, stage_records, required_paths and diagnostics describe the prepared model; bundle, full_hash, physical_hash and layers_hash are the final stored identity. network.graph is the single canonical runtime graph. bundle["network"] is null when no network was declared.

schema_version: str

reusable: bool

full_hash: str

physical_hash: str

layers_hash: str

from_dict(data: Mapping[str, Any]) -> LayoutBundle

to_dict() -> dict[str, Any]

check() -> None

manifest() -> dict[str, Any]

reresolve_presentation(
    bundle: LayoutBundle, file_patch: Mapping[str, Any]
) -> PresentationResult

Geometry and generators

Lengths use meters; z must equal zero. Speeds use meters per simulation time unit. Grid snapping is explicit. Default footprints are 1×1 m (nodes: 0.1×0.1 m), rotation zero, no ports and obstacle=False. Servers, pre-shop pools, warehouses, charging stations and parking areas receive auto positions. Custom kinds require explicit placement; graph nodes use graph positions and placed AGVs use their bound node. Shop floors, routers, fleets, jobs and orders are not placement targets. Transient jobs/orders never become static obstacles.

snap(point: Point) -> Point

Lanes.lanes maps lane ids to records with vertices (id, position), optional direction, enabled, and speed_limit. Lattice.bounds is (xmin, ymin, xmax, ymax) in world meters; it uses the declared grid. blocked maps stable ids to rectangle records; see the packaged schema for the complete nested grammar. A network override uses a stable id, logical address target and patch properties; lists in file layers replace complete inherited lists.

Handles and constructor unions

Handles are immutable and owner-scoped; they are not runtime nodes/graphs. Resolve through a stage/bind context or prepare().network. node_at(Address(...)) supports generated addresses; node(id) addresses an explicit node, and port(entity, name) addresses a named port.

The union describes both modes: an environment with a layout requires its own handles; an environment without one keeps concrete objects. It does not permit mixed mode. Node-only traffic semantics are unchanged.

encoded_id: str

to_dict() -> dict[str, Any]

Bounds and errors

LayoutLimits limits author bytes, nesting, placements, nodes, directed arcs and lane segment pairs before unbounded expansion. Geometry, generated addresses and dependencies are validated during preparation, outside the simulation hot path. INITIAL's separate 64 MiB encoded limit belongs to TraceRecorder.