API Reference¶

This section is generated automatically from the source docstrings with mkdocstrings. It is a reference, not a tutorial — for narrative explanations of how the pieces fit together, start with The Model and the User Guide.

Everything listed here (except the plotting/animation helpers) is re-exported from the top-level package, so the canonical way to import it is:

import mesoltm as m
from mesoltm import Network, Vehicle, ShortestPathPolicy, ReroutingPlugin

The plotting and animation helpers live under mesoltm.visualizations and require the optional [plot] extra — see Visualizations.

Pages¶

Page	Contents
Core	Links, the `Vehicle` agent, and the `Simulation` loop
Nodes	Junction flow-resolution models + origins/destinations
Network	The `Network` builder, `NetworkState`, and grid/corridor builders
Routing	Routing policies (`RoutingPolicy`, shortest path)
Plugins	Per-step loop hooks (`Plugin`, `ReroutingPlugin`)
Metrics	Per-vehicle trip records and summaries
Demand	Demand-profile generation
Recording	Animation history capture (matplotlib-free)
Visualizations	Plots and movement animations (`[plot]` extra)
Scenarios & CLI	JSON scenario I/O and the command line