Skip to content

API reference

The supported compatibility boundary is the names exported directly from culvert_solver. Import these names from the package root; submodule paths remain implementation details unless another document explicitly promotes them.

from culvert_solver import CulvertBarrel, solve_barrel_hydraulics

The reference is grouped by how callers use the library:

The package code version is available as culvert_solver.__version__. It comes from a package-local marker synchronized from authoritative pyproject.toml, so a source checkout, standalone wheel, and copy vendored inside another distribution report the same culvert_solver version. A vendoring distribution should separately retain its upstream Git commit; __version__ identifies the bundled solver code, not the host distribution.