Merge pull request #94 from karosc/dev

Update swmm-python to latest OWA SWMM

Author: abhiramm7

.github/workflows/python-package.yml

@@ -71,10 +71,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [windows-2016, macos-10.15]
-        py: [3.6, 3.7, 3.8, 3.9]
+        os: [windows-2022, macos-10.15]
+        py: ["3.7", "3.8", "3.9", "3.10"]
         include:
-          - os: windows-2016
+          - os: windows-2022
             sys_pkgs: choco install swig
             activate: ./build-env/Scripts/activate
 

.gitmodules

@@ -1,4 +1,4 @@
 [submodule "swmm-toolkit/swmm-solver"]
     path = swmm-toolkit/swmm-solver
     url = https://github.com/OpenWaterAnalytics/Stormwater-Management-Model.git
-    branch = swig
+	branch = develop

swmm-toolkit/AUTHORS

@@ -5,3 +5,6 @@ Michael Tryby <[email protected]> (public domain)
 Jennifer Wu <[email protected]>
 Caleb Buahin <[email protected]>
 Laurent Courty <[email protected]>
+Constantine Karos <[email protected]>
+Abhiram Mullapudi <[email protected]>
+Brooke Mason <[email protected]>

swmm-toolkit/CMakeLists.txt

@@ -15,7 +15,7 @@ cmake_minimum_required (VERSION 3.17)
 
 project(swmm-toolkit
     VERSION
-        0.8.2
+        0.9.0
 )
 
 

swmm-toolkit/build-requirements.txt

@@ -4,4 +4,4 @@
 setuptools==41.4.0
 wheel==0.33.6
 scikit-build==0.11.1
-cmake==3.18.4
+cmake==3.21

swmm-toolkit/setup.py

@@ -65,7 +65,7 @@ def run(self):
 
 # Set Platform specific cmake args here
 if platform_system == "Windows":
-    cmake_args = ["-GVisual Studio 15 2017 Win64"]
+    cmake_args = ["-GVisual Studio 17 2022","-Ax64"]
 
 elif platform_system == "Darwin":
     cmake_args = ["-GNinja","-DCMAKE_OSX_DEPLOYMENT_TARGET:STRING=10.9"]
@@ -88,7 +88,7 @@ def exclude_files(cmake_manifest):
 
 setup(
     name = "swmm-toolkit",
-    version = "0.8.2",
+    version = "0.9.0",
 
     packages = ["swmm_toolkit", "swmm.toolkit"],
     package_dir = package_dir,
@@ -116,10 +116,10 @@ def exclude_files(cmake_manifest):
         "Operating System :: POSIX :: Linux",
         "Operating System :: MacOS",
         "License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication",
-        "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
         "Programming Language :: C",
         "Development Status :: 4 - Beta",
     ]

swmm-toolkit/src/swmm/toolkit/CMakeLists.txt

@@ -139,6 +139,7 @@ target_link_libraries(solver
 set_target_properties(solver
     PROPERTIES
         SUFFIX ${PYTHON_SUFFIX}
+        SWIG_COMPILE_DEFINITIONS EXPORT_TOOLKIT
         MACOSX_RPATH TRUE
         SKIP_BUILD_RPATH FALSE
         BUILD_WITH_INSTALL_RPATH FALSE

swmm-toolkit/src/swmm/toolkit/__init__.py

@@ -19,7 +19,7 @@
 __credits__ = "Colleen Barr, Sam Hatchett"
 __license__ = "CC0 1.0 Universal"
 
-__version__ = "0.8.2"
+__version__ = "0.9.0"
 __date__ = "June 7, 2021"
 
 __maintainer__ = "Michael Tryby"

swmm-toolkit/src/swmm/toolkit/output_metadata.py

@@ -194,7 +194,9 @@ def __init__(self, output_handle):
             shared_enum.SystemAttribute.VOLUME_STORED:
                 ("Volume Stored", self._unit_labels[shared_enum.BaseUnits.VOLUME]),
             shared_enum.SystemAttribute.EVAP_RATE:
-                ("Evaporation Rate", self._unit_labels[shared_enum.BaseUnits.EVAP_RATE])
+                ("Evaporation Rate", self._unit_labels[shared_enum.BaseUnits.EVAP_RATE]),
+            shared_enum.SystemAttribute.PTNL_EVAP_RATE:
+                ("Potential Evaporation Rate", self._unit_labels[shared_enum.BaseUnits.EVAP_RATE])
         }
 
         self._build_pollut_metadata(output_handle)

swmm-toolkit/src/swmm/toolkit/shared_enum.py

@@ -304,6 +304,7 @@ class SystemAttribute(Enum, start = 0):
     :attr:`~OUTFALL_FLOWS`        outfall outflow
     :attr:`~VOLUME_STORED`        storage volume
     :attr:`~EVAP_RATE`            evaporation
+    :attr:`~PTNL_EVAP_RATE`       potential evapotranspiration
     ============================= ====================
     """
     AIR_TEMP = 0
@@ -320,6 +321,7 @@ class SystemAttribute(Enum, start = 0):
     OUTFALL_FLOWS = 11
     VOLUME_STORED = 12
     EVAP_RATE = 13
+    PTNL_EVAP_RATE = 14
 
 
 #
@@ -430,6 +432,7 @@ class NodeResult(Enum):
     :attr:`~DEPTH`
     :attr:`~HEAD`
     :attr:`~LATERAL_INFLOW`
+    :attr:`~HYD_RES_TIME`
     """
     TOTAL_INFLOW = 0
     TOTAL_OUTFLOW = 1
@@ -439,14 +442,19 @@ class NodeResult(Enum):
     DEPTH = 5
     HEAD = 6
     LATERAL_INFLOW = 7
+    HYD_RES_TIME = 8
 
 
 class NodePollutant(Enum):
     """Node Pollutant enum class.
 
     :attr:`~QUALITY`
+    :attr:`~INFLOW_CONC`
+    :attr:`~REACTOR_CONC`
     """
     QUALITY = 0
+    INFLOW_CONC = 1
+    REACTOR_CONC = 2
 
 
 class LinkProperty(Enum):
@@ -496,9 +504,11 @@ class LinkPollutant(Enum):
 
     :attr:`~QUALITY`
     :attr:`~TOTAL_LOAD`
+    :attr:`~REACTOR_CONC`
     """
     QUALITY = 0
     TOTAL_LOAD = 1
+    REACTOR_CONC = 2
 
 
 class SubcatchProperty(Enum):

swmm-toolkit/src/swmm/toolkit/solver.i

@@ -39,6 +39,10 @@
     Py_INCREF($result);
 }
 
+%typemap(out) int swmm_getVersion {
+  $result = PyInt_FromLong($1);
+}
+
 
 %apply int *OUTPUT {
     int *index,
@@ -178,6 +182,22 @@
 }
 
 
+/* INSERTS CUSTOM EXCEPTION HANDLING IN WRAPPER */
+%exception swmm_getSemVersion
+{
+    $function
+}
+
+%exception swmm_getBuildId
+{
+    $function
+}
+
+%exception swmm_getVersion
+{
+    $function
+}
+
 /* INSERTS CUSTOM EXCEPTION HANDLING IN WRAPPER */
 %exception
 {
@@ -209,7 +229,8 @@
 %ignore swmm_getObjectIndex;
 %ignore swmm_freeMemory;
 
+
 %include "toolkit.h"
 
 
-%exception;
+%exception;

swmm-toolkit/src/swmm/toolkit/solver_docs.i

@@ -664,6 +664,26 @@ flowrate: double
 ) swmm_setNodeInflow;
 
 
+%feature("autodoc", 
+"Set node pollutant concentration
+
+Parameters
+----------
+index: int
+    The node index.
+type: SM_NodePollut
+    The property type code (see :ref: SM_NodePollut). Currently Only QUALITY (0) is supported.
+pollutant_index: int
+    The index of the pollutant to set.
+pollutant_value:
+    The new pollutant concentration to set.
+
+"
+) swmm_setNodePollut;
+
+
+
+
 %feature("autodoc", 
 "Get a node statistics.
 
@@ -863,6 +883,23 @@ setting: double
 ) swmm_setLinkSetting;
 
 
+%feature("autodoc", 
+"Set link pollutant concentration
+
+Parameters
+----------
+index: int
+    The link index.
+type: SM_LinkPollut
+    The property type code (see :ref: SM_LinkPollut). Currently Only QUALITY (0) is supported.
+pollutant_index: int
+    The index of the pollutant to set.
+pollutant_value:
+    The new pollutant concentration to set.
+
+"
+) swmm_setLinkPollut;
+
 %feature("autodoc", 
 "Get link statistics.
 

swmm-toolkit/src/swmm/toolkit/solver_rename.i

@@ -44,6 +44,7 @@
 %rename(node_set_parameter)                 swmm_setNodeParam;
 %rename(node_get_result)                    swmm_getNodeResult;
 %rename(node_get_pollutant)                 swmm_getNodePollut;
+%rename(node_set_pollutant)                 swmm_setNodePollut;
 %rename(node_get_total_inflow)              swmm_getNodeTotalInflow;
 %rename(node_set_total_inflow)              swmm_setNodeInflow;
 %rename(node_get_stats)                     swmm_getNodeStats;
@@ -63,6 +64,7 @@
 %rename(link_set_parameter)                 swmm_setLinkParam;
 %rename(link_get_result)                    swmm_getLinkResult;
 %rename(link_get_pollutant)                 swmm_getLinkPollut;
+%rename(link_set_pollutant)                 swmm_setLinkPollut;
 %rename(link_set_target_setting)            swmm_setLinkSetting;
 %rename(link_get_stats)                     swmm_getLinkStats;
 
@@ -99,4 +101,5 @@
 %rename(raingage_set_precipitation)         swmm_setGagePrecip;
 
 
-%rename(swmm_version_info)                  swmm_getVersionInfo;
+%rename(swmm_version_info)                  swmm_getSemVersion;
+%rename(swmm_build_id)                      swmm_getBuildId;

swmm-toolkit/swmm-solver

@@ -1,6 +1,6 @@
 
 
 
-pytest==6.1.1
-numpy==1.17.2
+pytest==7.1.1
+numpy==1.21.5
 aenum==2.2.6