This page is generated from the Cython type-stub files (.pyi) so signatures and docstrings are always in sync with the compiled extensions. Each entry below lists the public class for the module; private helpers prefixed with _ are intentionally hidden.

For task-oriented documentation see the :doc:`User Guide <guide/index>`.

The top-level package. Importing :mod:`openswmm` configures the platform-specific shared-library search path and re-exports the legacy SWMM 5 symbols for backward compatibility.

.. automodule:: openswmm
   :members:
   :no-undoc-members:

The :mod:`openswmm.engine` subpackage exposes the new, refactored OpenSWMM 6 engine — the recommended API for all new work.

All domain access is class-based: each class takes an active :class:`~openswmm.engine._solver.Solver` in its constructor and may only be called when the solver is in an appropriate :class:`EngineState`.

.. seealso::

   :doc:`guide/index` — task-oriented user guide for this engine.

.. automodule:: openswmm.engine
   :no-members:

.. automodule:: openswmm.engine._solver
   :members:
   :undoc-members:
   :show-inheritance:

The :class:`EngineError` hierarchy and the dispatch helper used by _check(). Each subclass also inherits from a standard-library exception so idiomatic except IndexError: / except ValueError: handlers do the right thing.

.. automodule:: openswmm.engine._exceptions
   :members:
   :undoc-members:
   :show-inheritance:

The low-level C API encode/decode primitives plus the high-level oadate_to_datetime / datetime_to_oadate helpers used throughout the bindings.

.. automodule:: openswmm.engine._datetime
   :members:
   :undoc-members:

.. automodule:: openswmm.engine._dates
   :members:
   :undoc-members:

.. automodule:: openswmm.engine._model
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._edit
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._nodes
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._links
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._xsect
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._geometry
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._subcatchments
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._gages
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._inflows
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._forcing
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._climate
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._controls
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._pollutants
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._quality
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._tables
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._infrastructure
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._hotstart
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._massbalance
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._statistics
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._output_reader
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._spatial
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._enums
   :members:
   :undoc-members:
   :show-inheritance:
   :no-index:

These extensions are only built when the matching CMake flag is enabled on the parent C/C++ engine. They expose HAS_* flags at runtime so client code can degrade gracefully.

.. automodule:: openswmm.engine._geopackage
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openswmm.engine._2d
   :members:
   :undoc-members:
   :show-inheritance:

The :mod:`openswmm.legacy.engine` and :mod:`openswmm.legacy.output` subpackages preserve the original EPA SWMM 5.x C solver and binary-output reader verbatim for backward compatibility with existing scripts. No new development happens here; new projects should prefer :mod:`openswmm.engine` (above).

.. seealso::

   :doc:`legacy/index` — task-oriented guide for the legacy layer.

   :doc:`migration/swmm5_to_swmm6` — translating legacy patterns to
   the OpenSWMM 6 API.

.. automodule:: openswmm.legacy.engine
   :members:
   :undoc-members:
   :imported-members:
   :show-inheritance:

The :mod:`openswmm.legacy.output` subpackage reads the binary .out file produced by either the legacy SWMM 5.x solver or the v6.0 engine.

.. automodule:: openswmm.legacy.output
   :members:
   :undoc-members:
   :imported-members:
   :show-inheritance: