Skip to content

API Reference

This section is auto-generated from docstrings using mkdocstrings. For narrative walkthroughs of how the pieces fit together, see the Tutorials and Guides.

  • Core — Core simulation objects: Environment, ShopFloor, Server, ProductionJob, Router, PreShopPool, Runner, and the ShopFloor extension points.
  • Release Policies — Release policies that control when jobs are admitted to the shop floor: LumsCor, Slar, SlarLimit, Draco, ConWIP, ContinuousRelease, starvation avoidance, and event triggers.
  • Dispatching Rules — Priority rules applied at each workstation queue: stateless rules (SPT, EDD, …), parameterized rules, and system-state rules (Focus).
  • Intralogistics — Warehouse, AGV fleet, and material-transport API: layout graph, pathfinding, traffic management, vehicles, storage, orders, fleet coordination, policies, and metrics.
  • Events & Traces — The event bus and catalog, entities, RNG streams, the semantic digest, Provenance and the run manifest, TraceRecorder and Trace, and the KPI and Collector framework.
  • Utilities — Builder functions for quick system setup, statistical distribution helpers, and the log sinks.
  • Experimental — Unstable Gymnasium RL wrapper (SimulatteEnv); API subject to change without notice.