Skip to content

API reference

The API reference is generated from the docstrings in the current source tree. Use it when you need exact signatures, parameters, return fields, or exception behavior. For task-oriented examples, begin with the user guide; for mathematical interpretation, see the theory section. Lifecycle classifications are authoritative in the v0.7 API inventory; the concise user-facing summary is in Choosing an API.

Spatial API (3D)

The top-level pyvoro2 namespace contains 3D domains, forward operations, diagnostics, validation, normalization, face properties, and visualization.

Planar API (2D)

The explicit pyvoro2.planar namespace contains planar domains, forward operations, structured results, diagnostics, normalization, edge properties, and visualization.

Separator fitting

The canonical fixed-observation workflow is deliberately small at pyvoro2.inverse; advanced separator-specific functionality lives at pyvoro2.inverse.separator.

The historical pyvoro2.powerfit package and broad top-level separator exports are deprecated compatibility routes for v0.7 and will be removed in v0.8.