openswmm 5.3.0.dev0__py3-none-any.whl

openswmm/solver/solver.pxd

@@ -0,0 +1,356 @@
+# Description: Cython module for openswmmcore solver
+# Created by: Caleb Buahin (EPA/ORD/CESER/WID)
+# Created on: 2024-11-19
+
+# cython: language_level=3
+
+# cython imports
+from cpython.datetime cimport datetime as cython_datetime
+
+# third-party imports
+
+# project imports
+
+# Define the number of days since 01/01/00
+cpdef double encode_swmm_datetime(cython_datetime pdatetime)
+
+# Define the number of days since 01/01/00
+cpdef cython_datetime decode_swmm_datetime(double swmm_datetime)
+
+cdef extern from "Python.h":
+    object PyObject_CallObject(object, object)
+
+cdef extern from "time.h":
+    ctypedef long clock_t
+    clock_t clock()
+
+cdef extern from "openswmm_solver.h":
+    # SWMM object type enumeration
+    ctypedef enum swmm_Object:
+        swmm_GAGE      # Rain gage
+        swmm_SUBCATCH         # Subcatchment
+        swmm_NODE             # Junction
+        swmm_LINK             # Conduit
+        swmm_AQUIFER         # Aquifers
+        swmm_SNOWPACK         # Snowpack
+        swmm_UNIT_HYDROGRAPH # Unit hydrographs
+        swmm_LID              # Low impact development
+        swmm_STREET          # Streets
+        swmm_INLET           # Inlets
+        swmm_TRANSECT        # Transects
+        smmm_XSECTION_SHAPE   # Cross-section shape
+        swmm_CONTROL_RULE    # Control rules
+        swmm_POLLUTANT       # Pollutants
+        swmm_LANDUSE         # Land uses
+        swmm_CURVE            # Curve
+        swmm_TIMESERIES       # Time series
+        swmm_TIME_PATTERN     # Time pattern
+        swmm_SYSTEM           # General
+
+    # SWMM node type enumeration
+    ctypedef enum swmm_NodeType:
+        swmm_JUNCTION  # Junction node
+        swmm_OUTFALL   # Outfall node
+        swmm_STORAGE   # Storage node
+        swmm_DIVIDER   # Divider node
+
+    # SWMM link type enumeration
+    ctypedef enum swmm_LinkType:
+        swmm_CONDUIT   # Conduit link
+        swmm_PUMP      # Pump link
+        swmm_ORIFICE   # Orifice link
+        swmm_WEIR      # Weir link
+        swmm_OUTLET    # Outlet link
+
+    # SWMM Rain Gage properties
+    ctypedef enum swmm_GageProperty:
+        swmm_GAGE_TOTAL_PRECIPITATION # Total precipitation
+        swmm_GAGE_RAINFALL          # Snow depth
+        swmm_GAGE_SNOWFALL            # Snowfall
+    
+    # SWMM Subcatchment properties
+    ctypedef enum swmm_SubcatchProperty:
+        swmm_SUBCATCH_AREA      # Area
+        swmm_SUBCATCH_RAINGAGE  # Rain gage
+        swmm_SUBCATCH_RAINFALL  # Rainfall
+        swmm_SUBCATCH_EVAP      # Evaporation
+        swmm_SUBCATCH_INFIL     # Infiltration
+        swmm_SUBCATCH_RUNOFF    # Runoff
+        swmm_SUBCATCH_RPTFLAG   # Reporting flag
+        swmm_SUBCATCH_WIDTH     # Width 
+        swmm_SUBCATCH_SLOPE     # Slope
+        swmm_SUBCATCH_CURB_LENGTH # Curb length
+        swmm_SUBCATCH_API_RAINFALL # API rainfall
+        swmm_SUBCATCH_API_SNOWFALL # API snowfall
+        swmm_SUBCATCH_POLLUTANT_BUILDUP # Pollutant buildup
+        swmm_SUBCATCH_EXTERNAL_POLLUTANT_BUILDUP # External pollutant buildup
+        swmm_SUBCATCH_POLLUTANT_RUNOFF_CONCENTRATION # Pollutant ponded concentration
+        swmm_SUBCATCH_POLLUTANT_PONDED_CONCENTRATION # Pollutant runoff concentration
+        swmm_SUBCATCH_POLLUTANT_TOTAL_LOAD # Pollutant total load
+
+    # SWMM Node properties
+    ctypedef enum swmm_NodeProperty:
+        swmm_NODE_TYPE     # Node type
+        swmm_NODE_ELEV     # Elevation
+        swmm_NODE_MAXDEPTH # Max. depth
+        swmm_NODE_DEPTH    # Depth
+        swmm_NODE_HEAD     # Hydraulic head
+        swmm_NODE_VOLUME   # Volume
+        swmm_NODE_LATFLOW  # Lateral inflow
+        swmm_NODE_INFLOW   # Total inflow
+        swmm_NODE_OVERFLOW # Flooding
+        swmm_NODE_RPTFLAG  # Reporting flag
+        swmm_NODE_SURCHARGE_DEPTH # Surcharge depth
+        swmm_NODE_PONDED_AREA   # Ponded area
+        swmm_NODE_INITIAL_DEPTH # Initial depth
+        swmm_NODE_POLLUTANT_CONCENTRATION # Pollutant concentration
+        swmm_NODE_POLLUTANT_LATMASS_FLUX  # Pollutant lateral mass flux
+
+    # SWMM Link properties
+    ctypedef enum swmm_LinkProperty:
+        swmm_LINK_TYPE       # Link type
+        swmm_LINK_NODE1      # Start node
+        swmm_LINK_NODE2      # End node
+        swmm_LINK_LENGTH     # Length
+        swmm_LINK_SLOPE      # Slope 
+        swmm_LINK_FULLDEPTH  # Full depth
+        swmm_LINK_FULLFLOW   # Full flow
+        swmm_LINK_SETTING    # Setting
+        swmm_LINK_TIMEOPEN   # Time open
+        swmm_LINK_TIMECLOSED # Time closed
+        swmm_LINK_FLOW       # Flow
+        swmm_LINK_DEPTH      # Depth
+        swmm_LINK_VELOCITY   # Velocity
+        swmm_LINK_TOPWIDTH   # Top width
+        swmm_LINK_VOLUME     # Volume
+        swmm_LINK_CAPACITY   # Capacity
+        swmm_LINK_RPTFLAG    # Reporting flag
+        swmm_LINK_OFFSET1    # Inlet offset
+        swmm_LINK_OFFSET2    # Outlet offset
+        swmm_LINK_INITIAL_FLOW # Initial flow
+        swmm_LINK_FLOW_LIMIT # Flow limit
+        swmm_LINK_INLET_LOSS # Inlet loss
+        swmm_LINK_OUTLET_LOSS # Outlet loss
+        swmm_LINK_AVERAGE_LOSS # Average depth
+        swmm_LINK_SEEPAGE_RATE # Seepage rate
+        swmm_LINK_HAS_FLAPGATE # Flap gate
+        swmm_LINK_POLLUTANT_CONCENTRATION  # Pollutant concentration
+        swmm_LINK_POLLUTANT_LOAD # Pollutant load
+        swmm_LINK_POLLUTANT_LATMASS_FLUX # Pollutant lateral mass flux
+
+    # SWMM System properties
+    ctypedef enum swmm_SystemProperty:
+        swmm_STARTDATE           # The start date of the simulation.
+        swmm_CURRENTDATE         # The current date in the simulation.
+        swmm_ELAPSEDTIME         # The elapsed time since the start of the simulation.
+        swmm_ROUTESTEP           # The routing step size.
+        swmm_MAXROUTESTEP        # The maximum routing step size.
+        swmm_REPORTSTEP          # The reporting step size.
+        swmm_TOTALSTEPS          # The total number of steps in the simulation.
+        swmm_NOREPORT            # Flag indicating whether reporting is disabled.
+        swmm_FLOWUNITS           # The flow units used in the simulation.
+        swmm_ENDDATE             # The end date of the simulation.
+        swmm_REPORTSTART         # The start date of the reporting period.
+        swmm_UNITSYSTEM          # The unit system used in the simulation.
+        swmm_SURCHARGEMETHOD     # The surcharge method used in the simulation.
+        swmm_ALLOWPONDING        # Flag indicating whether ponding is allowed.
+        swmm_INERTIADAMPING      # The inertia damping factor used in the simulation.
+        swmm_NORMALFLOWLTD       # The normal flow limited flag.
+        swmm_SKIPSTEADYSTATE     # Flag indicating whether steady state periods are skipped.
+        swmm_IGNORERAINFALL      # Flag indicating whether rainfall is ignored.
+        swmm_IGNORERDII          # Flag indicating whether RDII is ignored.
+        swmm_IGNORESNOWMELT      # Flag indicating whether snowmelt is ignored.
+        swmm_IGNOREGROUNDWATER   # Flag indicating whether groundwater is ignored.
+        swmm_IGNOREROUTING       # Flag indicating whether routing is ignored.
+        swmm_IGNOREQUALITY       # Flag indicating whether water quality is ignored.
+        swmm_ERROR_CODE          # The error code.
+        swmm_RULESTEP            # The rule step size.
+        swmm_SWEEPSTART          # The start date of the sweep start.
+        swmm_SWEEPEND            # The end date of the sweep end.
+        swmm_MAXTRIALS           # The maximum number of trials.
+        swmm_NUMTHREADS          # The number of threads used in the simulation.
+        swmm_MINROUTESTEP        # The minimum routing step size.
+        swmm_LENGTHENINGSTEP     # The lengthening step size.
+        swmm_STARTDRYDAYS        # The number of start dry days.
+        swmm_COURANTFACTOR       # The Courant factor.
+        swmm_MINSURFAREA         # The minimum surface area.
+        swmm_MINSLOPE            # The minimum slope.
+        swmm_RUNOFFERROR         # The runoff error.
+        swmm_FLOWERROR           # The flow error.
+        swmm_QUALERROR           # The quality error.
+        swmm_HEADTOL             # The head tolerance.
+        swmm_SYSFLOWTOL          # The system flow tolerance.
+        swmm_LATFLOWTOL          # The lateral flow tolerance.
+
+    # SWMM flow units enumeration
+    ctypedef enum swmm_FlowUnitsProperty:
+        swmm_CFS  # Cubic feet per second
+        swmm_GPM  # Gallons per minute
+        swmm_MGD  # Million gallons per day
+        swmm_CMS  # Cubic meters per second
+        swmm_LPS  # Liters per second
+        swmm_MLD  # Million liters per day
+
+    # SWMM API function return error codes
+    ctypedef enum swmm_API_Errors:
+        ERR_API_NOT_OPEN          # API not open
+        ERR_API_NOT_STARTED       # API not started
+        ERR_API_NOT_ENDED         # API not ended
+        ERR_API_OBJECT_TYPE       # Invalid object type
+        ERR_API_OBJECT_INDEX      # Invalid object index
+        ERR_API_OBJECT_NAME       # Invalid object name
+        ERR_API_PROPERTY_TYPE     # Invalid property type
+        ERR_API_PROPERTY_VALUE    # Invalid property value
+        ERR_API_TIME_PERIOD       # Invalid time period
+        ERR_API_HOTSTART_FILE_OPEN # Error opening hotstart file
+        ERR_API_HOTSTART_FILE_FORMAT # Invalid hotstart file format
+        ERR_API_IS_RUNNING        # Simulation is already running
+
+    # SWMM API function return simulation progress
+    ctypedef void (*progress_callback)(double progress); 
+
+    # SWMM API function prototypes
+    # param: inp_file: input file name
+    # param: rpt_file: report file name
+    # param: out_file: output file name
+    # Returns: error code (0 if successful)
+    cdef int swmm_run(char* inp_file, char* rpt_file, char* out_file)
+
+
+    # SWMM API function prototypes
+    # param: inp_file: input file name
+    # param: rpt_file: report file name
+    # param: out_file: output file name
+    # param: progress: progress callback
+    # Returns: error code (0 if successful)
+    cdef int swmm_run_with_callback(char* inp_file, char* rpt_file, char* out_file, progress_callback progress)
+
+    # Open a SWMM input file
+    # param: inp_file: input file name
+    # param: rpt_file: report file name
+    # parm: out_file: output file name
+    # Returns: error code (0 if successful)
+    cdef int swmm_open(char* inp_file, char* rpt_file, char* out_file)
+
+    #  Starts a SWMM simulation
+    #  param: save_flag = TRUE if simulation results saved to binary file 
+    #  Returns: error code
+    cdef int swmm_start(int save_flag)
+
+    # Performs a single time step of a SWMM simulation
+    # param: elapsed_time: elapsed time in seconds
+    # Returns: error code
+    cdef int swmm_step(double* elapsed_time)
+
+    # Performs a single stride of a SWMM simulation
+    # param: strideStep: number of steps to perform
+    # param: elapsedTime: elapsed time in seconds
+    # Returns: error code
+    cdef int swmm_stride(int strideStep, double *elapsedTime)
+
+    # Uses provide hot start file to initialize the simulation
+    # param: hotStartFile: hot start file name
+    # Returns: error code
+    cdef int swmm_useHotStart(const char* hotStartFile)
+
+    # Saves the current simulation state to a hot start file
+    # param: hotStartFile: hot start file name
+    # Returns: error code
+    cdef int swmm_saveHotStart(const char* hotStartFile)
+
+    # Ends a SWMM simulation
+    # Returns: error code
+    cdef int swmm_end()
+
+    # Writes a report to the report file
+    # Returns: error code
+    cdef int swmm_report()
+
+    # Closes a SWMM simulation
+    # Returns: error code
+    cdef int swmm_close()
+
+    # Retrieves the mass balance errors
+    # param: runoffErr: runoff error
+    # param: flowErr: flow error
+    # param: qualErr: quality error
+    cdef int swmm_getMassBalErr(float *runoffErr, float *flowErr, float *qualErr)
+
+    # Gets the version of the SWMM engine
+    # Returns: version number
+    cdef int swmm_getVersion()
+
+    # Retrieves the error message from the SWMM engine
+    # param: errMsg: error message
+    # param: msgLen: length of the error message
+    # Returns: error code
+    cdef int swmm_getError(char *errMsg, int msgLen)
+
+    # Retrieves the error message from the SWMM engine
+    # param: error_code: error code
+    # param: outErrMsg: error message
+    # Returns: error code
+    cdef int swmm_getErrorFromCode(int error_code, char *outErrMsg[1024])
+
+    # Retrieves the number of warnings from the SWMM engine
+    cdef int swmm_getWarnings()
+    
+    # Retrieves the number of objects of a given type
+    # param: objType: object type
+    cdef int swmm_getCount(int objType)
+
+    # Retrieves the name of an object of a given type and index
+    # param: objType: object type
+    # param: index: object index
+    # param: name: object name
+    # param: size: size of the object name
+    cdef int swmm_getName(int objType, int index, char *name, int size)
+
+    # Retrieves the index of an object of a given type and name
+    # param: objType: object type
+    # param: name: object name
+    cdef int swmm_getIndex(int objType, const char *name)
+
+    # Retrieves the value of a property for an object of a given type and index
+    # param: property: property type
+    # param: index: object index
+    cdef double swmm_getValue(int property, int index)
+
+
+
+    # Retrieves the value of a property for an object of a given type and index
+    # param: objType: object type
+    # param: property: property type
+    # param: index: object index
+    # param: subIndex: sub-index
+    # param: pollutantIndex: pollutant index
+    cdef double swmm_getValueExpanded(int objType, int property, int index, int subIndex, int pollutantIndex)
+
+    # Sets the value of a property for an object of a given type and index
+    # param: property: property type
+    # param: index: object index
+    # param: value: property value
+    cdef int swmm_setValue(int property, int index,  double value)
+    
+    # Sets the value of a property for an object of a given type and index
+    # param: objType: object type
+    # param: property: property type
+    # param: index: object index
+    # param: value: property value
+    cdef int swmm_setValueExpanded(int objType, int property, int index, int subindex, int pollutantIndex, double value)
+
+    # Retrieves the value of a property for an object of a given type and index
+    # param: property: property type
+    # param: index: object index
+    # param: period: time period
+    cdef double swmm_getSavedValue(int property, int index, int period)
+    
+    # Writes a line to the SWMM report file
+    # param: line: line to write
+    cdef void swmm_writeLine(const char *line)
+
+    # Decodes a SWMM datetime into a datetime object    
+    cdef void swmm_decodeDate(double date, int *year, int *month, int *day, int *hour, int *minute, int *second, int *dayOfWeek)
+
+    # Encodes a datetime object into a SWMM datetime
+    cdef double swmm_encodeDate(int year, int month, int day, int hour, int minute, int second)

openswmm-5.3.0.dev0.dist-info/METADATA

@@ -0,0 +1,228 @@
+Metadata-Version: 2.4
+Name: openswmm
+Version: 5.3.0.dev0
+Summary: A python package for EPA SWMM preprocessing, solver, and post-processing.
+Author-email: Caleb Buahin <caleb.buahin@gmail.com>
+Maintainer-email: Caleb Buahin <caleb.buahin@gmail.com>
+License: Copyright 2026 HydroCouple
+        
+        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.
+Project-URL: Homepage, https://github.com/HydroCouple/Stormwater-Management-Model
+Project-URL: Documentation, https://github.com/HydroCouple/Stormwater-Management-Model
+Project-URL: Source Code, https://github.com/HydroCouple/Stormwater-Management-Model
+Project-URL: Bug Tracker, https://github.com/HydroCouple/Stormwater-Management-Model/issues
+Project-URL: Repository, https://github.com/HydroCouple/Stormwater-Management-Model
+Project-URL: Changelog, https://github.com/HydroCouple/Stormwater-Management-Model/blob/master/CHANGELOG.md
+Keywords: SWMM,storm water,modeling,water,hydrology,hydraulics,wastewater,machine learning,AI,GIS,environmental engineering,civil engineering
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: C
+Classifier: Programming Language :: C++
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Hydrology
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license-file
+
+EPA ORD Stormwater Management Model (SWMM)
+==========================================
+
+Stormwater Management Model (SWMM) computational engine and output post-processing codebase
+
+## Build Status
+[![Build and Unit Testing](https://github.com/HydroCouple/Stormwater-Management-Model/actions/workflows/unit_testing.yml/badge.svg)](https://github.com/HydroCouple/Stormwater-Management-Model/actions/workflows/unit_testing.yml)
+[![Build and Regression Testing](https://github.com/HydroCouple/Stormwater-Management-Model/actions/workflows/regression_testing.yml/badge.svg)](https://github.com/HydroCouple/Stormwater-Management-Model/actions/workflows/regression_testing.yml)
+[![Docs](https://github.com/HydroCouple/Stormwater-Management-Model/actions/workflows/build_docs.yml/badge.svg)](https://github.com/HydroCouple/Stormwater-Management-Model/actions/workflows/build_docs.yml)
+[![Deployment](https://github.com/HydroCouple/Stormwater-Management-Model/actions/workflows/deploy.yml/badge.svg)](https://github.com/HydroCouple/Stormwater-Management-Model/actions/workflows/deploy.yml)
+[![Documentation](https://github.com/HydroCouple/Stormwater-Management-Model/actions/workflows/build-and-test.yml/badge.svg?branch=docs)](https://github.com/HydroCouple/Stormwater-Management-Model/actions/workflows/build-and-test.yml)
+[![Issues](https://img.shields.io/github/issues/HydroCouple/Stormwater-Management-Model)](https://github.com/HydroCouple/Stormwater-Management-Model/issues)
+
+## Python Binding
+[![PyPi](https://img.shields.io/pypi/v/openswmm.svg)](https://pypi.org/project/openswmm)
+[![PythonVersion](https://img.shields.io/pypi/pyversions/openswmm.svg)](https://pypi.org/project/openswmm)
+[![Wheel](https://img.shields.io/pypi/wheel/openswmm.svg)](https://pypi.org/project/openswmm)
+[![Downloads](https://pepy.tech/badge/openswmm)](https://pepy.tech/project/openswmm)
+[![Downloads](https://pepy.tech/badge/openswmm/month)](https://pepy.tech/project/openswmm)
+[![Downloads](https://pepy.tech/badge/openswmm/week)](https://pepy.tech/project/openswmm)
+
+## Introduction
+This is the official SWMM source code repository maintained by US EPA Office of Research and Development, Center For Environmental Solutions & Emergency Response, Water Infrastructure Division located in Cincinnati, Ohio.
+
+SWMM is a dynamic hydrology-hydraulic water quality simulation model. It is used for single event or long-term (continuous) simulation of runoff quantity and quality from primarily urban areas. SWMM source code is written in the C Programming Language and released in the Public Domain.
+
+## Build Instructions
+
+The 'src' folder of this repository contains the C source code for
+version of Storm Water Management Model's computational
+engine. Consult the included 'Roadmap.txt' file for an overview of
+the various code modules. The code can be compiled into both a shared
+object library and a command line executable. Under Windows, the 
+library file (swmm5.dll) is used to power SWMM's graphical user
+interface.
+
+Also included is a python interface for the SWMM computational engine and output 
+post-processing application programming interfaces located in the python folder.
+
+The 'CMakeLists.txt' file is a script used by CMake (https://cmake.org/)
+to build the SWMM binaries. CMake is a cross-platform build tool
+that generates platform native build systems for many compilers. To
+check if the required version is installed on your system, enter from 
+a console window and check that the version is 3.5 or higher.
+
+```bash
+cmake --version
+```
+
+To build the SWMM engine library and its command line executable
+using CMake and the Microsoft Visual Studio C compiler on Windows:
+
+1. Open a console window and navigate to the directory where this
+   Readme file resides (which should have 'src' as a sub-directory
+   underneath it).
+
+2. Use the following command to create the directory for storing the built binaries:
+
+```bash
+mkdir build
+```
+
+3. Then the following CMake commands to build the binaries:
+
+``` bash
+cmake -G <compiler> -B build
+cmake --build ./build --config Release
+```
+
+where `<compiler>` is the name of the compiler being used
+in double quotes (e.g., "Visual Studio 17 2022" for windows, "Ninja" for linux, or "Xcode" for macos). The resulting engine shared libraries (i.e., swmm5.dll), command line executable (i.e., runswmm.exe), and output processing libraries (i.e., swmm-output.dll)
+will appear in the build\Release directory.
+
+### Python Bindings (Experimental)
+
+Experimental python bindings for the SWMM API are being developed to support regression and benchmark testing as well as for other applications. _**These bindings are still under development and testing and has yet to be cleared through US EPA ORD's official quality assurance review process**_. The exprimental python bindings can be built and installed locally using the following command.
+
+```bash
+cd python
+python -m pip install -r requirements.txt
+python -m pip install . 
+```
+Users may also build python wheels for installation or distribution. Once the python bindings
+have been validated and cleared through EPA's quality assuracnce clearance process, they will be available for installation via package indexing repositories such as pypi.
+
+Example usage of python bindings can be found below. More extensive documentation will be provided once cleared.
+
+```python
+
+from openswmmcore import solver
+from openswmmcore.solver import Solver 
+from openswmmcore.output import Output
+
+# Alternative 1 to run SWMM
+
+with Solver(inp_file="input_file.inp") as swmm_solver:
+   
+   # Open swmm file and starts the simulation
+   swmm_solver.start()
+
+   # Set initialization parameters e.g., time step stride, start date, end date etc.
+   swmm_solver.time_stride = 600 
+
+   for elapsed_time, current_datetime in swmm_solver:
+
+      # Get and set attributes per timestep
+      print(current_datetime)
+
+      swmm_solver.set_value(
+         object_type=solver.SWMMObjects.RAIN_GAGE,
+         property_type=solver.SWMMRainGageProperties.GAGE_RAINFALL,
+         index="RG1",
+         value=3.6
+      )
+
+# Alternative 2 to run SWMM
+swmm_solver = Solver(inp_file="input_file.inp")
+swmm_solver.initialize()
+
+for elapsed_time, current_datetime in swmm_solver:
+   # Get and set attributes per timestep
+   print(current_datetime)
+
+swmm_solver.finalize()
+# or
+# swmm_solver.end()
+# swmm_solver.report()
+# swmm_solver.close()
+
+# Alternative 3 to run SWMM
+swmm_solver = Solver(inp_file="input_file.inp")
+swmm_solver.execute()
+
+# To read output file
+
+swmm_output = Output(output_file='output_file.out')
+
+# Dict[datetime, float]
+link_timeseries = swmm_output.get_link_timeseries(
+   element_index="C1",
+   attribute=output.LinkAttribute.FLOW_RATE,
+)
+
+```
+
+## Unit and Regression Testing
+
+Unit tests and regression tests have been developed for both the natively compiled SWMM computational engine and output toolkit as well as their respective python bindings. Unit tests for the natively compiled toolkits use the Boost 1.67.0 library and can be compiled by adding DBUILD_TESTS=ON flag during the cmake build phase as shown below:
+
+```bash
+ctest --test-dir .  -DBUILD_TESTS=ON --config Debug --output-on-failure
+```
+
+Unit testing on the python bindings may be executed using the following command after installation.
+
+```bash
+cd python\tests
+pytest .
+```
+
+Regression tests are executed using the python bindings using the pytest and pytest-regressions extension using the following commands.
+
+```bash
+cd ci
+pytest --data-dir <path-to-regression-testing-files> --atol <absolute-tolerance> --rtol <relative-tolerance> --benchmark-compare --benchmark-json=PATH
+```
+
+## Find Out More
+The source code distributed here is identical to the code found at the official [SWMM website](https://www.epa.gov/water-research/storm-water-management-model-swmm).
+The SWMM website also hosts the official manuals and installation binaries for the SWMM software. 
+
+A live web version of the SWMM documentation of the API and user manuals can be found on the [SWMM GitHub Pages website](https://usepa.github.io/Stormwater-Management-Model). Note that this is an experimental version that is still under development and has yet to go through EPA'S official quality assurance review process.
+
+## Disclaimer 
+The United States Environmental Protection Agency (EPA) GitHub project code is provided on an "as is" basis and the user assumes responsibility for its use. EPA has relinquished control of the information and no longer has responsibility to protect the integrity, confidentiality, or availability of the information. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by EPA. The EPA seal and logo shall not be used in any manner to imply endorsement of any commercial product or activity by EPA or the United States Government.
+

openswmm-5.3.0.dev0.dist-info/RECORD

@@ -0,0 +1,36 @@
+openswmm/CMakeLists.txt,sha256=A_mLTvbKrRqNZ5SoAPhH0xu85xnq2DDP9yYV7mG70H4,760
+openswmm/__init__.py,sha256=0N2CX2E9fmAyxp8sIKLVwk5rI4O4IML8rtH7aewPJvM,1370
+openswmm/_openswmm.pyx,sha256=Iu-auvAriOBhm0LC8l38sDaoAPQ7WI-7J8EV9Rt3Okg,264
+openswmm/openswmm.pxd,sha256=OMqMgHZmVYeaeIfMxuoUZAom_EC_sBav_V3MXvkK-9g,229
+openswmm/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+openswmm/gym/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+openswmm/output/CMakeLists.txt,sha256=LuxgOUNV001ovki7m8jgS3l4g-9hivYxbe7IaJyCASg,1184
+openswmm/output/__init__.pxd,sha256=P6aSBhYtq4_LcjyBO5jLgzxev7uhGVWDs_X3jp_0SP8,22
+openswmm/output/__init__.py,sha256=QrGifWqsEpA21kA2LdemrQOn6X-rrIBl9BsgzZ_zjOk,234
+openswmm/output/_output.pyi,sha256=qzbt0wJoKeMjH8L5CIL1bi9q41069EcuQSkO-MYL-Yc,23295
+openswmm/output/_output.pyx,sha256=_9PKgrbDdXdakHntsh-VKlPInlrbrkfnnG-NMg80hU0,53961
+openswmm/output/output.pxd,sha256=ZWU41p8DJMtE2g5tTX0NG2MjU4s_CO9WR7CuV4_q3yU,17355
+openswmm/solver/CMakeLists.txt,sha256=5_rUGyggKj7u05KZan2G-KjqmKnQY_Z6xkhZc8Dz9mI,1207
+openswmm/solver/__init__.pxd,sha256=c66v4fkTN-lP6A1fu8npq6NMbVY0YFSEG2ygkckxc0Y,22
+openswmm/solver/__init__.py,sha256=lhuOzlodkJgHxhl2Ka92rlpPPfQzUknuEZVKqsQvUwQ,509
+openswmm/solver/_solver.pyi,sha256=uIa_ogbdIl7qUp21Ew0dsU7_XbqKtkfy5sqGms9ezss,26817
+openswmm/solver/_solver.pyx,sha256=xoYA_HRo57Ypa-fKT25AhnaxqaRfos5Jxt21g0PHNYI,54435
+openswmm/solver/solver.pxd,sha256=u2QTMcqcnlb29Spd83-6Yr0-I21FIecfcm-K33bcfqg,14937
+openswmm-5.3.0.dev0.dist-info/licenses/LICENSE,sha256=pyk0dQPNVU8Nr7nMpIJNOppXsEEe1nlGhTiXTj_DIfM,1389
+tests/.DS_Store,sha256=vN93C6eZoK3-GKyUUv1QMNsGTWu6xkchU5AwXTaaEQw,6148
+tests/__init__.py,sha256=g1vIT9Yhp2M6OJgLRzr6oB2psjt_V3ZJwx9MvLA8keY,88
+tests/test_swmm_solver.py,sha256=wZ0-sITfrwOpSB05l8hDFGm6-wMQgPO3Lvn-S8sEAK4,26116
+tests/test_swwm_output.py,sha256=aThj81Ptn4rCWezihxSRe5aT3fqV2sXKinh7IR8KrF4,37248
+tests/data/.DS_Store,sha256=rzJQ_pMUQarbrfiMJi5XBuCMJFbMPNrGUbE2z7Bmf2M,6148
+tests/data/__init__.py,sha256=siayQrR2VgBLjA6OmCUnPR_ce6EDTmfIkUevsjWRgBQ,67
+tests/data/output/__init__.py,sha256=V8pp4cxOqbTOyFRr2ERitWrCvqTV8w7rf0lw_xokB7c,485
+tests/data/output/example_output_1.out,sha256=L06BtY_yhe6lhaJROvI1GGPdwnwDV4VnPP-VROUcgsg,44018
+tests/data/output/json_time_series.pickle,sha256=g1twKdx_6Er_fHSqAkqs9t_DRBgPFsG97iHoZSGptOQ,4122
+tests/data/solver/__init__.py,sha256=HqluSGqEm-1d18UzfPLzXiv9rglPJqwFbdcW63fm1Xw,413
+tests/data/solver/non_existent_input_file.rpt,sha256=KT3GMFWzj6zNhX5cBL2Amh9-Rx9JKHr0h4jM4ogCQQM,156405
+tests/data/solver/site_drainage_example.inp,sha256=3xSxNmT8eVKqACHmeJfsC5ODksPPZrMr6bvJB2Vfg18,26004
+tests/data/solver/site_drainage_example.rpt,sha256=RZs4sePs7l3t8tVOcbSHvKRv2X6iT3EVin-rwWI77yY,17841
+openswmm-5.3.0.dev0.dist-info/METADATA,sha256=0HanNUpA7s_4HqoCW_eJ4fs8K_rovAFWTis1uCrWWpg,12528
+openswmm-5.3.0.dev0.dist-info/WHEEL,sha256=m-nq1aIDeuxRdjfTNeALjyq_QDrHE03qCc8i5s_UmRs,86
+openswmm-5.3.0.dev0.dist-info/top_level.txt,sha256=oBBb61VpbXAWx6CEnYYRQgwSvdrcqVqDuY3ocrC404A,15
+openswmm-5.3.0.dev0.dist-info/RECORD,,

openswmm-5.3.0.dev0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: skbuild 0.18.1
+Root-Is-Purelib: true
+Tag: py3-none-any
+

openswmm-5.3.0.dev0.dist-info/licenses/LICENSE

@@ -0,0 +1,12 @@
+Copyright 2026 HydroCouple
+
+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.

openswmm-5.3.0.dev0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+openswmm
+tests

tests/__init__.py

@@ -0,0 +1,3 @@
+# Description: 
+# Created by: Caleb Buahin (EPA/ORD/CESER/WID)
+# Created on: 2024-11-19

tests/data/__init__.py

@@ -0,0 +1,3 @@
+import os
+
+DATA_PATH = os.path.dirname(os.path.realpath(__file__))