openswmm 6.0.0.dev2__cp310-cp310-win_amd64.whl

bin/__init__.py

@@ -0,0 +1,10 @@
+"""""" # start delvewheel patch
+def _delvewheel_patch_1_12_1():
+    import os
+    if os.path.isdir(libs_dir := os.path.abspath(os.path.join(os.path.dirname(__file__), os.pardir, 'openswmm.libs'))):
+        os.add_dll_directory(libs_dir)
+
+
+_delvewheel_patch_1_12_1()
+del _delvewheel_patch_1_12_1
+# end delvewheel patch

openswmm/CMakeLists.txt

@@ -0,0 +1,113 @@
+# ============================================================================
+# openswmm package — top-level Cython extension + subpackage delegation
+#
+# Builds the root _openswmm stub (if ever re-added) and delegates to:
+#   engine/    — new 6.x bindings
+#   legacy/    — legacy 5.x solver + output reader
+#
+# Shared libraries installed via CMake are placed next to each extension:
+#   openswmm/engine/libopenswmm.engine.*
+#   openswmm/legacy/engine/libopenswmm.legacy.engine.*
+#   openswmm/legacy/output/libopenswmm.legacy.output.*
+# ============================================================================
+
+add_subdirectory(engine)
+add_subdirectory(legacy)
+
+# ---------------------------------------------------------------------------
+# Install shared libraries alongside the Cython extensions so that
+# @loader_path / $ORIGIN RPATH entries resolve at runtime.
+#
+# In pre-built mode the targets are IMPORTED; cmake forbids install(TARGETS)
+# on imported targets, so we resolve the path via IMPORTED_LOCATION instead.
+# ---------------------------------------------------------------------------
+if(NOT OPENSWMM_USE_PREBUILT_ENGINE)
+    # On Windows, gather the transitive runtime DLL closure of every engine
+    # library into a single RUNTIME_DEPENDENCY_SET so it gets bundled into
+    # the wheel alongside the .pyd files.  Without this, `pip install .` on
+    # Windows produces a wheel where the engine DLL is present but its
+    # dependencies (OpenMP vcomp140.dll, vcpkg-installed runtime libs, etc.)
+    # are absent — Python's loader then fails with
+    #     "DLL load failed while importing _solver: The specified module
+    #      could not be found."
+    # The cibuildwheel path uses delvewheel, which performs the same bundling
+    # at wheel-repair time; this CMake-level rule mirrors that behaviour for
+    # the `pip install .` (no delvewheel) path.
+    set(_openswmm_runtime_dep_set "")
+    if(WIN32)
+        set(_openswmm_runtime_dep_set
+            RUNTIME_DEPENDENCY_SET openswmm_runtime_deps)
+    endif()
+
+    install(TARGETS openswmm_engine
+        ${_openswmm_runtime_dep_set}
+        LIBRARY DESTINATION openswmm/engine
+        ARCHIVE DESTINATION openswmm/engine
+        RUNTIME DESTINATION openswmm/engine
+    )
+    install(TARGETS openswmm_legacy_engine
+        ${_openswmm_runtime_dep_set}
+        LIBRARY DESTINATION openswmm/legacy/engine
+        ARCHIVE DESTINATION openswmm/legacy/engine
+        RUNTIME DESTINATION openswmm/legacy/engine
+    )
+    install(TARGETS openswmm_legacy_output
+        ${_openswmm_runtime_dep_set}
+        LIBRARY DESTINATION openswmm/legacy/output
+        ARCHIVE DESTINATION openswmm/legacy/output
+        RUNTIME DESTINATION openswmm/legacy/output
+    )
+
+    if(WIN32)
+        install(RUNTIME_DEPENDENCY_SET openswmm_runtime_deps
+            DESTINATION openswmm/engine
+            # Skip OS-supplied DLLs that ship with every Windows installation
+            # (Python loader finds them in System32 anyway, and shipping them
+            # into a wheel would conflict with the loaded copies).
+            PRE_EXCLUDE_REGEXES
+                "api-ms-.*\\.dll"
+                "ext-ms-.*\\.dll"
+                "[Kk]ernel32\\.dll"
+                "[Nn]tdll\\.dll"
+                "[Mm]svcrt\\.dll"
+                "ucrtbase\\.dll"
+                "vcruntime[0-9]+\\.dll"
+                "msvcp[0-9]+\\.dll"
+                "concrt[0-9]+\\.dll"
+                "[Pp]ython[0-9]+\\.dll"
+            POST_EXCLUDE_REGEXES
+                ".*[Ww]indows[/\\\\][Ss]ystem32.*"
+                ".*[Ww]indows[/\\\\][Ss]ys[Ww][Oo][Ww]64.*"
+        )
+    endif()
+else()
+    foreach(_entry
+        "OpenSWMMEngine::openswmm_engine|openswmm/engine"
+        "OpenSWMMEngine::openswmm_legacy_engine|openswmm/legacy/engine"
+        "OpenSWMMEngine::openswmm_legacy_output|openswmm/legacy/output"
+    )
+        string(REPLACE "|" ";" _pair "${_entry}")
+        list(GET _pair 0 _tgt)
+        list(GET _pair 1 _dest)
+
+        get_target_property(_loc "${_tgt}" IMPORTED_LOCATION)
+        if(NOT _loc)
+            get_target_property(_loc "${_tgt}" IMPORTED_LOCATION_RELEASE)
+        endif()
+        if(_loc)
+            install(FILES "${_loc}" DESTINATION "${_dest}")
+        else()
+            message(WARNING "IMPORTED_LOCATION not found for ${_tgt} — dylib missing from wheel")
+        endif()
+
+        if(WIN32)
+            get_target_property(_imp "${_tgt}" IMPORTED_IMPLIB)
+            if(NOT _imp)
+                get_target_property(_imp "${_tgt}" IMPORTED_IMPLIB_RELEASE)
+            endif()
+            if(_imp)
+                install(FILES "${_imp}" DESTINATION "${_dest}")
+            endif()
+        endif()
+    endforeach()
+endif()

openswmm/__init__.py

@@ -0,0 +1,93 @@
+"""
+openswmm -- Python bindings for the OpenSWMM stormwater modelling engine.
+
+:author: Caleb Buahin
+:copyright: Copyright (c) 2026 Caleb Buahin
+:license: MIT
+
+Subpackages
+-----------
+legacy.engine
+    Legacy EPA SWMM 5.x solver bindings (Cython).
+legacy.output
+    Legacy EPA SWMM 5.x binary output reader (Cython).
+engine
+    New data-oriented engine 6.x bindings (Cython).
+
+This top-level package additionally:
+
+  - Configures the platform-specific shared-library search path so the
+    bundled C/C++ shared libraries can be located by the dynamic linker.
+  - Resolves the package version string into ``__version__``.
+  - Re-exports the legacy engine and legacy output public symbols when
+    their compiled Cython extensions are available, for backward
+    compatibility with pre-6.x callers.
+"""
+
+
+# start delvewheel patch
+def _delvewheel_patch_1_12_1():
+    import os
+    if os.path.isdir(libs_dir := os.path.abspath(os.path.join(os.path.dirname(__file__), os.pardir, 'openswmm.libs'))):
+        os.add_dll_directory(libs_dir)
+
+
+_delvewheel_patch_1_12_1()
+del _delvewheel_patch_1_12_1
+# end delvewheel patch
+
+import importlib.metadata
+import os
+import platform
+
+# ---------------------------------------------------------------------------
+# Windows DLL search path
+#
+# On macOS and Linux the Cython extensions embed @loader_path / $ORIGIN
+# RPATH entries pointing at the directory where the bundled dylib/so lives,
+# so the dynamic linker finds it automatically — no extra path configuration
+# is required.
+#
+# On Windows, Python 3.8+ requires explicit DLL directories because the
+# old LoadLibrary PATH search was disabled.  The bundled .dll files live
+# alongside the Cython .pyd extensions under openswmm/engine/ and
+# openswmm/legacy/{engine,output}/ — NOT in sys.prefix/bin.  Register each
+# subpackage directory so Python can find all bundled DLLs regardless of
+# which module is imported first.
+# ---------------------------------------------------------------------------
+if platform.system() == "Windows" and hasattr(os, "add_dll_directory"):
+    _pkg_dir = os.path.dirname(__file__)
+    for _dll_subdir in (
+        os.path.join(_pkg_dir, "engine"),
+        os.path.join(_pkg_dir, "legacy", "engine"),
+        os.path.join(_pkg_dir, "legacy", "output"),
+    ):
+        if os.path.isdir(_dll_subdir):
+            os.add_dll_directory(_dll_subdir)
+
+# ---------------------------------------------------------------------------
+# Version
+# ---------------------------------------------------------------------------
+try:
+    __version__: str = importlib.metadata.version("openswmm")
+except importlib.metadata.PackageNotFoundError:
+    __version__ = "0.0.0.dev0"
+
+# ---------------------------------------------------------------------------
+# Public re-exports  (legacy subpackages)
+#
+# These require compiled Cython extensions (.so/.pyd).  When building
+# documentation or in a partial install the extensions may not be available,
+# so we import them conditionally.
+# ---------------------------------------------------------------------------
+try:
+    from openswmm.legacy.engine import *  # noqa: F401,F403
+except ImportError:
+    pass
+
+try:
+    from openswmm.legacy.output import *  # noqa: F401,F403
+except ImportError:
+    pass
+
+__all__ = ["__version__"]

openswmm/engine/CMakeLists.txt

@@ -0,0 +1,68 @@
+# ============================================================================
+# openswmm.engine — Cython bindings for the OpenSWMM 6.x C API.
+#
+# Every extension is built through add_cython_extension() (see
+# python/cmake/CythonHelpers.cmake) so directives, RPATH, visibility,
+# symbol export, and install rules stay uniform across modules.
+#
+# CMake target names carry an "engine_" prefix to avoid collisions with the
+# identically-named legacy modules (legacy/engine/_solver.pyx, etc.).  The
+# helper sets OUTPUT_NAME so the on-disk filename remains the bare module
+# name and Python imports resolve correctly.
+# ============================================================================
+
+set(_engine_modules
+    _solver
+    _model
+    _edit
+    _nodes
+    _links
+    _subcatchments
+    _gages
+    _hotstart
+    _massbalance
+    _pollutants
+    _tables
+    _inflows
+    _controls
+    _infrastructure
+    _quality
+    _statistics
+    _output_reader
+    _spatial
+    _forcing
+)
+
+foreach(_mod IN LISTS _engine_modules)
+    add_cython_extension(
+        NAME        ${_mod}
+        TARGET      engine_${_mod}
+        SOURCE      ${_mod}.pyx
+        INSTALL_DIR openswmm/engine
+        LIBS        openswmm::engine
+    )
+endforeach()
+
+# Optional 2-D module (requires SUNDIALS/CVODE; off by default).
+if(OPENSWMM_BUILD_2D)
+    add_cython_extension(
+        NAME        _2d
+        TARGET      engine__2d
+        SOURCE      _2d.pyx
+        INSTALL_DIR openswmm/engine
+        LIBS        openswmm::engine
+    )
+endif()
+
+# GeoPackage support is optional — built only when the engine target was
+# configured with OPENSWMM_WITH_GEOPACKAGE.  When omitted, openswmm.engine
+# imports HAS_GEOPACKAGE = False at runtime (see __init__.py).
+if(OPENSWMM_WITH_GEOPACKAGE)
+    add_cython_extension(
+        NAME        _geopackage
+        TARGET      engine__geopackage
+        SOURCE      _geopackage.pyx
+        INSTALL_DIR openswmm/engine
+        LIBS        openswmm::engine
+    )
+endif()

openswmm/engine/_2d.pxd

@@ -0,0 +1,83 @@
+# _2d.pxd — Cython declarations for the 2D surface routing C API.
+#
+# These declarations allow Cython modules to call the C functions in
+# openswmm_2d.h without an intermediate Python layer.
+
+cdef extern from "openswmm_2d.h":
+    # Status
+    int swmm_2d_is_active(void* engine, int* active)
+
+    # Mesh geometry
+    int swmm_2d_vertex_count(void* engine, int* count)
+    int swmm_2d_triangle_count(void* engine, int* count)
+    int swmm_2d_vertex_get_xyz(void* engine, int idx,
+                                double* x, double* y, double* z)
+    int swmm_2d_vertex_get_xyz_bulk(void* engine,
+                                     double* x, double* y, double* z) nogil
+    int swmm_2d_set_vertex_z(void* engine, int idx, double z)
+    int swmm_2d_triangle_get_vertices(void* engine, int idx,
+                                       int* v0, int* v1, int* v2)
+    int swmm_2d_triangle_get_area(void* engine, int idx, double* area)
+    int swmm_2d_triangle_get_centroid(void* engine, int idx,
+                                       double* cx, double* cy, double* cz)
+    int swmm_2d_triangle_get_mannings(void* engine, int idx, double* n)
+    int swmm_2d_triangle_get_neighbours(void* engine, int idx,
+                                         int* n0, int* n1, int* n2)
+    int swmm_2d_edge_get_geometry_bulk(void* engine,
+                                        double* length, double* nx, double* ny) nogil
+
+    # Coupling
+    int swmm_2d_vertex_coupling_count(void* engine, int* count)
+    int swmm_2d_triangle_coupling_count(void* engine, int* count)
+    int swmm_2d_vertex_get_coupled_node(void* engine, int vidx, int* nidx)
+    int swmm_2d_triangle_get_coupled_node(void* engine, int tidx, int* nidx)
+
+    # State — per triangle
+    int swmm_2d_get_depth(void* engine, int idx, double* depth)
+    int swmm_2d_get_head(void* engine, int idx, double* head)
+    int swmm_2d_get_coupling_flux(void* engine, int idx, double* flux)
+    int swmm_2d_get_rainfall(void* engine, int idx, double* rainfall)
+    int swmm_2d_get_net_source(void* engine, int idx, double* net_source)
+    int swmm_2d_get_depths_bulk(void* engine, double* depths) nogil
+    int swmm_2d_get_heads_bulk(void* engine, double* heads) nogil
+    int swmm_2d_get_coupling_fluxes_bulk(void* engine, double* fluxes) nogil
+    int swmm_2d_get_edge_flux_bulk(void* engine, double* flux) nogil
+
+    # State — per vertex
+    int swmm_2d_vertex_get_head(void* engine, int idx, double* head)
+    int swmm_2d_vertex_get_heads_bulk(void* engine, double* heads) nogil
+
+    # Statistics
+    int swmm_2d_get_max_depth(void* engine, double* max_depth)
+    int swmm_2d_get_total_volume(void* engine, double* volume)
+    int swmm_2d_get_total_exchange_flow(void* engine, double* flow)
+    int swmm_2d_get_cvode_steps(void* engine, long* steps)
+    int swmm_2d_get_cvode_last_step(void* engine, double* h_last)
+    int swmm_2d_get_stat_max_depths(void* engine, double* max_depths)
+
+    # Forcing
+    int swmm_2d_force_rainfall(void* engine, int idx,
+                                double value, int mode, int persist)
+    int swmm_2d_force_rainfall_uniform(void* engine,
+                                        double value, int mode, int persist)
+    int swmm_2d_force_coupling_flux(void* engine, int idx,
+                                     double value, int mode, int persist)
+    int swmm_2d_force_clear_all(void* engine)
+
+    # Options
+    int swmm_2d_get_dry_depth(void* engine, double* dry_depth)
+    int swmm_2d_set_dry_depth(void* engine, double dry_depth)
+    int swmm_2d_get_rel_tolerance(void* engine, double* rtol)
+    int swmm_2d_set_rel_tolerance(void* engine, double rtol)
+    int swmm_2d_get_abs_tolerance(void* engine, double* atol)
+    int swmm_2d_set_abs_tolerance(void* engine, double atol)
+
+    # Boundary edges
+    int swmm_2d_boundary_edge_count(void* engine, int* count)
+    int swmm_2d_get_edge_bc_type(void* engine, int tri_idx, int edge, int* bc_type)
+    int swmm_2d_set_edge_bc_type(void* engine, int tri_idx, int edge, int bc_type)
+    int swmm_2d_get_edge_bc_head(void* engine, int tri_idx, int edge, double* head)
+    int swmm_2d_set_edge_bc_head(void* engine, int tri_idx, int edge, double head)
+    int swmm_2d_get_edge_bc_slope(void* engine, int tri_idx, int edge, double* slope)
+    int swmm_2d_set_edge_bc_slope(void* engine, int tri_idx, int edge, double slope)
+    int swmm_2d_get_edge_bc_cum_flux(void* engine, int tri_idx, int edge, double* cum_flux)