API reference

The API reference is generated from the docstrings and annotations of the package. The reference pages document each subsystem and render the public API beside the rules it implements — the optimizer’s objective and operators on Optimizer, the simulator on Simulator, the patch metrics on Spatial structure and constraints, and so on — with the signature, the parameter types, and the return value of every documented function. Search those pages before you call one of these functions. The pages below cover the repository’s own tooling. Add a page here, with an automodule entry, whenever you add a module to scripts/.