Skip to content

API Reference#

Every public module, documented from its docstrings and arranged in the sidebar as a tree that mirrors the package — expand capturegraph on the left and drill in the way you would in a file explorer.

Three import surfaces aggregate this tree for everyday use:

  • import capturegraph as cg — the authoring surface: every type, node, and procedure helper, starting at capturegraph.
  • import capturegraph.scheduling as cgsh — analysis-side scheduling (distance metrics, forecasting, session selection, reservations), starting at capturegraph.scheduling.
  • capturegraph.api_models — the server wire shapes, starting at capturegraph.api_models.

The tree is generated from the package by scripts/gen-api-reference.py; regenerate it after adding, removing, or moving a module.