API reference¶

Full API documentation lives in each module guide page, generated from the live source tree by mkdocstrings. Use the table below to jump directly to the reference section for the subpackage you need.

If you are new to the library, start with the module guide — each page opens with a narrative introduction before the class/function listings.

Subpackage	API reference	Key classes / functions
`simweave.core`	Core	`SimEnvironment`, `Entity`, `Clock`, `SimTimeAxis`
`simweave.continuous`	Continuous	`simulate`, `MassSpringDamper`, `QuarterCarModel`, `FullCarModel`
`simweave.discrete`	Discrete	`Queue`, `Service`, `ArrivalGenerator`, `ResourcePool`
`simweave.spatial` + `.agents`	Agents and spatial	`Agent`, `a_star`, `dijkstra`, `grid_graph`
`simweave.supplychain`	Supply chain	`Warehouse`, `InventoryItems`
`simweave.reliability`	Reliability	`ReliableEntity`, `Fleet`, `RepairCentre`, `sensitivity_sweep`
`simweave.roads`	Roads	`Road`, `Intersection`, `Roundabout`, `TrafficSignal`, `RoadNetwork`
`simweave.mc`	Monte Carlo	`run_monte_carlo`, `run_batched_mc`, `MCResult`
`simweave.currency`	Currency	`Money`, `FXConverter`, `format_money`
`simweave.units`	Units	`SIUnit`, `Distance`, `Velocity`, `Mass`
`simweave.viz`	Visualisation	`plot_*` helpers, recorders, themes