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 :doc:`../reference/optimizer`, the simulator on :doc:`../reference/simulator`, the patch metrics on :doc:`../reference/spatial`, 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/``. .. toctree:: :maxdepth: 2 check-workflow check-notebooks dashboard