Complete API reference

This section is generated from the AbaQuant source tree and then rendered by Sphinx autodoc. It complements the conceptual domain guides: the guides explain model choice and workflow design, while these pages document callable contracts.

What each entry contains

Each module page provides:

  • the canonical import path;

  • a purpose and usage explanation;

  • an inventory of public functions, classes, methods, and properties;

  • callable signatures and type hints;

  • parameter, return-value, exception, and notes sections from source docstrings; and

  • inheritance information for classes.

Coverage

The generated tree covers 109 Python modules/packages, 249 public functions, 93 public classes, and 375 public methods or properties discovered by the AST inventory. The documentation guard reports docstrings for 717/717 public definitions.

Note

“Public” means a source definition whose name does not begin with an underscore. Package facades may also re-export canonical definitions documented on their implementation-module pages.