openswmm 5.3.0.dev0__tar.gz → 6.0.0.dev0__tar.gz

openswmm-6.0.0.dev0/.claude/settings.local.json

@@ -0,0 +1,7 @@
+{
+  "permissions": {
+    "allow": [
+      "WebFetch(domain:raw.githubusercontent.com)"
+    ]
+  }
+}

openswmm-6.0.0.dev0/CMakeLists.txt

@@ -0,0 +1,181 @@
+# ============================================================================
+# CMake entry point for the openswmm Python package (scikit-build-core)
+#
+# Invoked by `pip install .`, `pip install -e .`, or `python -m build`.
+# Responsibilities:
+#   1. Resolve the OpenSWMM engine (pre-built CI or from-source local dev).
+#   2. Find Python, locate Cython, and discover NumPy include paths.
+#   3. Include cmake/CythonHelpers.cmake (shared directives + helpers).
+#   4. Delegate extension builds to openswmm/CMakeLists.txt.
+# ============================================================================
+
+cmake_minimum_required(VERSION 3.24)
+
+# ============================================================================
+# vcpkg manifest directory: the vcpkg.json lives one directory above python/.
+# Set VCPKG_MANIFEST_DIR before project() so vcpkg's toolchain file sees it.
+# Users who install without vcpkg (e.g. system-lib builds) can ignore this.
+# ============================================================================
+if(NOT DEFINED CACHE{VCPKG_MANIFEST_DIR})
+    set(VCPKG_MANIFEST_DIR "${CMAKE_CURRENT_SOURCE_DIR}/.."
+        CACHE PATH "Directory containing vcpkg.json" FORCE)
+endif()
+
+# Auto-load vcpkg toolchain when VCPKG_ROOT is set in the environment.
+# Must be done before project() so the toolchain is processed at language
+# enable time.  Users can override by passing -DCMAKE_TOOLCHAIN_FILE=...
+# on the command line or via CMAKE_ARGS / SKBUILD_CMAKE_ARGS.
+if(NOT DEFINED CMAKE_TOOLCHAIN_FILE AND DEFINED ENV{VCPKG_ROOT})
+    set(CMAKE_TOOLCHAIN_FILE "$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
+        CACHE PATH "vcpkg toolchain file (auto-detected from VCPKG_ROOT)")
+    message(STATUS "openswmm-python: auto-loaded vcpkg toolchain from $ENV{VCPKG_ROOT}")
+endif()
+
+project(
+    openswmm-python
+    VERSION 6.0.0
+    LANGUAGES C CXX
+)
+
+# ============================================================================
+# 1. Engine library: find_package (CI pre-built) OR add_subdirectory (local)
+# ============================================================================
+if(NOT DEFINED OPENSWMM_ENGINE_INSTALL_PREFIX
+        AND DEFINED ENV{OPENSWMM_ENGINE_INSTALL_PREFIX})
+    set(OPENSWMM_ENGINE_INSTALL_PREFIX "$ENV{OPENSWMM_ENGINE_INSTALL_PREFIX}"
+        CACHE PATH "Install prefix of a pre-built OpenSWMM engine")
+endif()
+
+if(OPENSWMM_ENGINE_INSTALL_PREFIX)
+    message(STATUS "openswmm-python: using pre-built engine from ${OPENSWMM_ENGINE_INSTALL_PREFIX}")
+    set(OPENSWMM_USE_PREBUILT_ENGINE TRUE CACHE BOOL "" FORCE)
+
+    find_package(OpenSWMMEngine CONFIG REQUIRED
+        PATHS "${OPENSWMM_ENGINE_INSTALL_PREFIX}"
+        NO_DEFAULT_PATH
+    )
+
+    # Provide openswmm:: ALIAS names consumed by all sub-CMakeLists.
+    add_library(openswmm::engine         ALIAS OpenSWMMEngine::openswmm_engine)
+    add_library(openswmm::legacy::engine ALIAS OpenSWMMEngine::openswmm_legacy_engine)
+    add_library(openswmm::legacy::output ALIAS OpenSWMMEngine::openswmm_legacy_output)
+    add_library(openswmm::common         ALIAS OpenSWMMEngine::openswmm_common)
+    add_library(openswmm::plugin_sdk     ALIAS OpenSWMMEngine::openswmm_plugin_sdk)
+
+    if(NOT DEFINED LIBRARY_VERSION)
+        set(LIBRARY_VERSION   "${PROJECT_VERSION}")
+        set(LIBRARY_SOVERSION "${PROJECT_VERSION_MAJOR}")
+    endif()
+
+else()
+    message(STATUS "openswmm-python: building engine from source")
+    set(OPENSWMM_USE_PREBUILT_ENGINE FALSE CACHE BOOL "" FORCE)
+
+    set(OPENSWMM_BUILD_TESTS             OFF CACHE BOOL "" FORCE)
+    set(OPENSWMM_BUILD_UNIT_TESTS        OFF CACHE BOOL "" FORCE)
+    set(OPENSWMM_BUILD_REGRESSION_TESTS  OFF CACHE BOOL "" FORCE)
+    set(OPENSWMM_BUILD_BENCHMARKS        OFF CACHE BOOL "" FORCE)
+    set(OPENSWMM_BUILD_PYTHON            OFF CACHE BOOL "" FORCE)
+
+    # Disable WINDOWS_EXPORT_ALL_SYMBOLS: the cmake -E __create_def step
+    # cannot parse /GL (LTCG) object files on Windows CI.
+    set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS OFF)
+
+    add_subdirectory(
+        "${CMAKE_CURRENT_SOURCE_DIR}/.."
+        "${CMAKE_BINARY_DIR}/parent_build"
+        EXCLUDE_FROM_ALL
+    )
+endif()
+
+# ============================================================================
+# 2. Global settings
+# ============================================================================
+set(CMAKE_MACOSX_RPATH          ON)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+set(CMAKE_INSTALL_OPENMP_LIBRARIES  TRUE)
+include(InstallRequiredSystemLibraries)
+
+# ============================================================================
+# 2a. OpenMP — use the same custom FindOpenMP.cmake as the parent project.
+#
+# In source mode the parent's src/engine/CMakeLists.txt already includes it,
+# so the OpenMP::OpenMP_C/CXX targets exist when we reach here.
+# In pre-built mode the parent is skipped, so we must ensure the targets exist
+# ourselves before any Cython extension is linked.
+# ============================================================================
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../cmake")
+if(NOT TARGET OpenMP::OpenMP_CXX)
+    include("${CMAKE_CURRENT_SOURCE_DIR}/../cmake/FindOpenMP.cmake")
+endif()
+
+# ============================================================================
+# 3. Python (standard CMake FindPython — scikit-build-core populates hints)
+# ============================================================================
+find_package(Python REQUIRED COMPONENTS Interpreter Development.Module)
+message(STATUS "Python executable : ${Python_EXECUTABLE}")
+message(STATUS "Python version    : ${Python_VERSION}")
+
+# ============================================================================
+# 4. Cython driver — invoked as `python -m cython` so the cython that runs
+#    is ALWAYS the one installed in the active interpreter.  Calling a
+#    `cython` binary discovered on PATH is a footgun: the binary may shebang
+#    a different interpreter (e.g. a system / conda Python), in which case
+#    `cimport numpy` resolves to that interpreter's numpy/*.cython-3?.pxd
+#    instead of the venv's, producing ABI mismatches at compile time
+#    (e.g. _PyArray_Descr.subarray on numpy 2.x).
+# ============================================================================
+execute_process(
+    COMMAND "${Python_EXECUTABLE}" -c "import Cython, sys; sys.stdout.write(Cython.__version__)"
+    OUTPUT_VARIABLE _cython_version
+    RESULT_VARIABLE _cython_check_rc
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+if(NOT _cython_check_rc EQUAL 0)
+    message(FATAL_ERROR
+        "Cython is not importable from the active Python (${Python_EXECUTABLE}).\n"
+        "Install it with:  ${Python_EXECUTABLE} -m pip install 'cython>=3.0.12'")
+endif()
+# OPENSWMM_CYTHON_EXECUTABLE is treated as a list so add_custom_command's
+# COMMAND expansion runs `<python> -m cython ...`.
+set(OPENSWMM_CYTHON_EXECUTABLE "${Python_EXECUTABLE};-m;cython"
+    CACHE STRING "Cython driver (python -m cython) for the active interpreter" FORCE)
+message(STATUS "Cython driver     : ${Python_EXECUTABLE} -m cython (Cython ${_cython_version})")
+
+# ============================================================================
+# 5. NumPy include directory + pxd patch
+#
+# numpy.get_include() returns the C headers used by the .cxx compiler.
+# Separately, numpy ships Cython declaration files (numpy/__init__.cython-30.pxd
+# etc.) that have a known incompatibility with numpy 2.x — see
+# cmake/PatchNumpyPxd.cmake for the full story.  We materialise patched
+# copies into the build tree and prepend them to Cython's --include-dir so
+# our extensions compile against numpy 2.x without modifying the user's
+# numpy install.
+# ============================================================================
+execute_process(
+    COMMAND "${Python_EXECUTABLE}" -c "import numpy; print(numpy.get_include())"
+    OUTPUT_VARIABLE NUMPY_INCLUDE_DIR
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    RESULT_VARIABLE _numpy_rc
+)
+if(NOT _numpy_rc EQUAL 0)
+    message(FATAL_ERROR "Could not determine NumPy include directory")
+endif()
+message(STATUS "NumPy include dir : ${NUMPY_INCLUDE_DIR}")
+set(NUMPY_INCLUDE_DIR "${NUMPY_INCLUDE_DIR}" CACHE PATH "" FORCE)
+
+include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/PatchNumpyPxd.cmake")
+openswmm_patch_numpy_pxd()
+set(OPENSWMM_NUMPY_PATCHED_INCLUDE_DIR
+    "${OPENSWMM_NUMPY_PATCHED_INCLUDE_DIR}" CACHE PATH "" FORCE)
+
+# ============================================================================
+# 6. Cython helper functions (shared directives + add_cython_extension)
+# ============================================================================
+include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/CythonHelpers.cmake")
+
+# ============================================================================
+# 7. Cython extensions
+# ============================================================================
+add_subdirectory(openswmm)

openswmm-6.0.0.dev0/CMakePresets.json

@@ -0,0 +1,163 @@
+{
+    "version": 3,
+    "configurePresets": [
+        {
+            "name": "base",
+            "hidden": true,
+            "generator": "Ninja",
+            "toolchainFile": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake",
+            "cacheVariables": {
+                "CMAKE_EXPORT_COMPILE_COMMANDS": "YES"
+            }
+        },
+        {
+            "name": "base-debug",
+            "hidden": true,
+            "inherits": "base",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Debug"
+            }
+        },
+        {
+            "name": "Windows",
+            "inherits": "base",
+            "description": "Windows release build",
+            "generator": "Visual Studio 17 2022",
+            "toolset": {
+                "value": "v143",
+                "strategy": "external"
+            },
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Release",
+                "CMAKE_C_FLAGS": "/O2 /GL /fp:precise /W4",
+                "CMAKE_CXX_FLAGS": "/O2 /GL /fp:precise /W4",
+                "CMAKE_EXE_LINKER_FLAGS": "/LTCG /OPT:REF /OPT:ICF",
+                "CMAKE_SHARED_LINKER_FLAGS": "/LTCG /OPT:REF /OPT:ICF",
+                "CMAKE_MODULE_LINKER_FLAGS": "/LTCG /OPT:REF /OPT:ICF",
+                "CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS": "OFF"
+            },
+            "condition": {
+                "type": "equals",
+                "lhs": "${hostSystemName}",
+                "rhs": "Windows"
+            }
+        },
+        {
+            "name": "Windows-debug",
+            "inherits": "base-debug",
+            "description": "Windows debug build",
+            "generator": "Visual Studio 17 2022",
+            "toolset": {
+                "value": "v143",
+                "strategy": "external"
+            },
+            "cacheVariables": {
+                "CMAKE_C_FLAGS": "/Zi /Od /DDEBUG /W4 /fp:precise",
+                "CMAKE_CXX_FLAGS": "/Zi /Od /DDEBUG /W4 /fp:precise",
+                "CMAKE_EXE_LINKER_FLAGS": "/DEBUG"
+            },
+            "condition": {
+                "type": "equals",
+                "lhs": "${hostSystemName}",
+                "rhs": "Windows"
+            }
+        },
+        {
+            "name": "Linux",
+            "inherits": "base",
+            "description": "Linux release build",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Release",
+                "CMAKE_C_FLAGS": "-O2 -fdata-sections -ffunction-sections -fno-fast-math -ffp-contract=off -fexcess-precision=standard -ffloat-store -Wall -Wextra",
+                "CMAKE_CXX_FLAGS": "-O2 -fdata-sections -ffunction-sections -fno-fast-math -ffp-contract=off -ffloat-store -Wall -Wextra",
+                "CMAKE_EXE_LINKER_FLAGS": "-Wl,--gc-sections",
+                "CMAKE_SHARED_LINKER_FLAGS": "-Wl,--gc-sections",
+                "CMAKE_MODULE_LINKER_FLAGS": ""
+            },
+            "condition": {
+                "type": "equals",
+                "lhs": "${hostSystemName}",
+                "rhs": "Linux"
+            }
+        },
+        {
+            "name": "Linux-debug",
+            "inherits": "base-debug",
+            "description": "Linux debug build",
+            "cacheVariables": {
+                "CMAKE_C_FLAGS": "-O0 -g -DDEBUG -fno-fast-math -ffp-contract=off -fexcess-precision=standard -ffloat-store -Wall -Wextra",
+                "CMAKE_CXX_FLAGS": "-O0 -g -DDEBUG -fno-fast-math -ffp-contract=off -ffloat-store -Wall -Wextra",
+                "CMAKE_EXE_LINKER_FLAGS": "-g"
+            },
+            "condition": {
+                "type": "equals",
+                "lhs": "${hostSystemName}",
+                "rhs": "Linux"
+            }
+        },
+        {
+            "name": "Darwin",
+            "inherits": "base",
+            "description": "macOS release build",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Release",
+                "CMAKE_C_FLAGS": "-O2 -flto -fdata-sections -ffunction-sections -fno-fast-math -ffp-contract=off -ffloat-store -Wall -Wextra",
+                "CMAKE_CXX_FLAGS": "-O2 -flto -fdata-sections -ffunction-sections -fno-fast-math -ffp-contract=off -ffloat-store -Wall -Wextra",
+                "CMAKE_EXE_LINKER_FLAGS": "-flto",
+                "CMAKE_SHARED_LINKER_FLAGS": "-flto -twolevel_namespace -undefined dynamic_lookup",
+                "CMAKE_MODULE_LINKER_FLAGS": "-flto -undefined dynamic_lookup"
+            },
+            "condition": {
+                "type": "equals",
+                "lhs": "${hostSystemName}",
+                "rhs": "Darwin"
+            }
+        },
+        {
+            "name": "Darwin-debug",
+            "inherits": "base-debug",
+            "description": "macOS debug build",
+            "cacheVariables": {
+                "CMAKE_C_FLAGS": "-O0 -g -DDEBUG -fno-fast-math -ffp-contract=off -ffloat-store -Wall -Wextra",
+                "CMAKE_CXX_FLAGS": "-O0 -g -DDEBUG -fno-fast-math -ffp-contract=off -ffloat-store -Wall -Wextra",
+                "CMAKE_EXE_LINKER_FLAGS": "-g",
+                "CMAKE_SHARED_LINKER_FLAGS": "-twolevel_namespace -undefined dynamic_lookup",
+                "CMAKE_MODULE_LINKER_FLAGS": "-undefined dynamic_lookup"
+            },
+            "condition": {
+                "type": "equals",
+                "lhs": "${hostSystemName}",
+                "rhs": "Darwin"
+            }
+        }
+    ],
+    "buildPresets": [
+        {
+            "name": "Windows",
+            "configurePreset": "Windows",
+            "targets": ["package"]
+        },
+        {
+            "name": "Windows-debug",
+            "configurePreset": "Windows-debug"
+        },
+        {
+            "name": "Linux",
+            "configurePreset": "Linux",
+            "targets": ["package"]
+        },
+        {
+            "name": "Linux-debug",
+            "configurePreset": "Linux-debug"
+        },
+        {
+            "name": "Darwin",
+            "configurePreset": "Darwin",
+            "targets": ["package"]
+        },
+        {
+            "name": "Darwin-debug",
+            "configurePreset": "Darwin-debug"
+        }
+    ]
+}

{openswmm-5.3.0.dev0 → openswmm-6.0.0.dev0}/LICENSE

@@ -1,12 +1,9 @@
-Copyright 2026 HydroCouple
+MIT License
+
+Copyright 2026 Caleb Buahin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-This project contains original material has been released as part of various USEPA SWMM software over the years. These reside in the 
-public domain and cannot be claimed. This project also contains new material prepared by the United States
-Government for which domestic copyright protection is not available under 17
-USC § 105.