Staging for Release

.github/workflows/build_wheel.yml

@@ -0,0 +1,126 @@
+name: Build Wheels
+
+# Cross compile wheels only on main branch and tags
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+    tags:
+      - v*
+  workflow_dispatch:
+
+jobs:
+  build_nrtest_plugin:
+    name: Build nrtest-swmm plugin
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./nrtest-swmm
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+
+      - name: Install Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.7
+
+      - name: Build wheel
+        run: |
+            pip install wheel
+            python setup.py bdist_wheel
+      - uses: actions/upload-artifact@v3
+        with:
+          path: nrtest-swmm/dist/*.whl
+
+
+
+  build_wheels:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-2022, macos-12]
+        pyver: [cp38, cp39, cp310, cp311, cp312]
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+        with:
+            submodules: true
+
+      - name: Build wheels
+        uses: pypa/[email protected]
+        with:
+          package-dir: ./swmm-toolkit
+        env:
+          CIBW_TEST_COMMAND: "pytest {package}/tests"
+          CIBW_BEFORE_TEST: pip install -r {package}/test-requirements.txt
+          # mac needs ninja to build
+          CIBW_BEFORE_BUILD_MACOS: brew install ninja
+          # remove system swig (cmake bug doesn't respect python venv)
+          # https://github.com/swig/swig/issues/2481#issuecomment-1949573105
+          CIBW_BEFORE_BUILD_LINUX: rm -f $(which swig) && rm -f $(which swig4.0)
+          # configure cibuildwheel to build native archs ('auto'), and some emulated ones
+          CIBW_ARCHS_LINUX: x86_64
+          CIBW_ARCHS_WINDOWS: AMD64
+          CIBW_ARCHS_MACOS: x86_64
+          # only build current supported python: https://devguide.python.org/versions/
+          # don't build pypy or musllinux to save build time. TODO: find a good way to support those archs
+          CIBW_BUILD: ${{matrix.pyver}}-*
+          CIBW_SKIP: cp36-* cp37-* pp* *-musllinux*
+          # Will avoid testing on emulated architectures
+          # Skip trying to test arm64 builds on Intel Macs
+          CIBW_TEST_SKIP: "*-*linux_{aarch64,ppc64le,s390x} *-macosx_arm64 *-macosx_universal2:arm64"
+          CIBW_BUILD_VERBOSITY: 1
+
+      - uses: actions/upload-artifact@v3
+        with:
+          path: ./wheelhouse/*.whl
+
+  build_cross_wheels:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest,macos-12]
+        pyver: [cp38, cp39, cp310, cp311, cp312]
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+        with:
+            submodules: true
+
+      - name: Set up QEMU
+        if: runner.os == 'Linux'
+        uses: docker/setup-qemu-action@v2
+        with:
+          platforms: all
+
+      - name: Build wheels
+        uses: pypa/[email protected]
+        with:
+          package-dir: ./swmm-toolkit
+        env:
+          # remove system swig (cmake bug doesn't respect python venv)
+          # https://github.com/swig/swig/issues/2481#issuecomment-1949573105
+          CIBW_BEFORE_BUILD_LINUX: rm -f $(which swig) && rm -f $(which swig4.0)
+          # configure cibuildwheel to build native archs ('auto'), and some emulated ones
+          CIBW_ARCHS_LINUX: aarch64
+          CIBW_ARCHS_MACOS: arm64
+          # only build current supported python: https://devguide.python.org/versions/
+          # don't build pypy or musllinux to save build time. TODO: find a good way to support those archs
+          CIBW_BUILD: ${{matrix.pyver}}-*
+          CIBW_SKIP: cp36-* cp37-* pp* *-musllinux*
+          CIBW_BUILD_VERBOSITY: 1
+
+      - uses: actions/upload-artifact@v3
+        with:
+          path: ./wheelhouse/*.whl

.github/workflows/unit_test.yml

@@ -0,0 +1,63 @@
+name: Unit Test
+
+on: 
+  push:
+    branches-ignore:    
+      - 'master'
+    tags-ignore:
+      - v*
+  pull_request:
+    branches-ignore:    
+      - 'master'
+
+jobs:
+  build_and_test:
+    name: Build and test on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        working-directory: ./swmm-toolkit
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-2022, macos-12, ubuntu-latest]
+        include:
+          - os: windows-2022
+            sys_pkgs: choco install swig
+            activate: ./build-env/Scripts/activate
+
+          - os: macos-12
+            sys_pkgs: brew install swig ninja
+            activate: source ./build-env/bin/activate
+
+          - os: ubuntu-latest
+            activate: source ./build-env/bin/activate
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+
+      - name: Install Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install required system packages
+        run: ${{matrix.sys_pkgs}}
+
+      - name: Build wheel in virtual env
+        run: |
+          python -m venv --clear ./build-env
+          ${{matrix.activate}}
+          python -m pip install -r build-requirements.txt
+          python setup.py bdist_wheel
+          deactivate
+
+      - name: Test wheel
+        run: |
+          pip install -r test-requirements.txt
+          pip install --no-index --find-links=./dist swmm_toolkit
+          pytest

.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 = master

nrtest-swmm/nrtest_swmm/__init__.py

@@ -25,8 +25,8 @@
 __credits__ = "Colleen Barr, Maurizio Cingi, Mark Gray, David Hall, Bryant McDonnell"
 __license__ = "CC0 1.0 Universal"
 
-__version__ = "0.6.0"
-__date__ = "May 8, 2020"
+__version__ = "0.7.0"
+__date__ = "Jul 28, 2021"
 
 __maintainer__ = "Michael E. Tryby"
 __email__ = "[email protected]"
@@ -65,15 +65,15 @@ def swmm_allclose_compare(path_test, path_ref, rtol, atol):
     for (test, ref) in zip(ordr.output_generator(path_test),
                            ordr.output_generator(path_ref)):
 
-        if len(test[0]) != len(ref[0]):
-            raise ValueError('Inconsistent lengths')
+        # Compare arrays when lengths are unequal by truncating extra elements 
+        length = min(len(test[0]), len(ref[0]))
 
-        # Skip over results if they are equal
-        if (np.array_equal(test[0], ref[0])):
+        # Skip over results if they are equal to optimize performance
+        if (np.array_equal(test[0][:length], ref[0][:length])):
             continue
 
         else:
-            np.testing.assert_allclose(test[0], ref[0], rtol, atol)
+            np.testing.assert_allclose(test[0][:length], ref[0][:length], rtol, atol)
 
     return True
 

nrtest-swmm/nrtest_swmm/output_reader.py

@@ -18,7 +18,7 @@
 from itertools import islice
 
 # project import
-from swmm.toolkit import output, output_enum
+from swmm.toolkit import output, shared_enum
 
 
 def output_generator(path_ref):
@@ -40,7 +40,7 @@ def output_generator(path_ref):
     with OutputReader(path_ref) as reader:
 
         for period_index in range(0, reader.report_periods()):
-            for element_type in islice(output_enum.ElementType, 4):
+            for element_type in islice(shared_enum.ElementType, 4):
                 for element_index in range(0, reader.element_count(element_type)):
 
                     yield (reader.element_result(element_type, period_index, element_index),
@@ -57,10 +57,10 @@ def __init__(self, filename):
         self.handle = None
         self.count = None
         self.get_element_result = {
-            output_enum.ElementType.SUBCATCH: output.get_subcatch_result,
-            output_enum.ElementType.NODE: output.get_node_result,
-            output_enum.ElementType.LINK: output.get_link_result,
-            output_enum.ElementType.SYSTEM: output.get_system_result
+            shared_enum.ElementType.SUBCATCH: output.get_subcatch_result,
+            shared_enum.ElementType.NODE: output.get_node_result,
+            shared_enum.ElementType.LINK: output.get_link_result,
+            shared_enum.ElementType.SYSTEM: output.get_system_result
         }
 
     def __enter__(self):
@@ -73,7 +73,7 @@ def __exit__(self, type, value, traceback):
         output.close(self.handle)
 
     def report_periods(self):
-        return output.get_times(self.handle, output_enum.Time.NUM_PERIODS)
+        return output.get_times(self.handle, shared_enum.Time.NUM_PERIODS)
 
     def element_count(self, element_type):
         return self.count[element_type]

nrtest-swmm/scripts/report-diff

@@ -25,14 +25,14 @@ def _binary_diff(path_test, path_ref, min_cdd):
     for (test, ref) in zip(ordr.output_generator(path_test),
                            ordr.output_generator(path_ref)):
 
-        if len(test[0]) != len(ref[0]):
-            raise ValueError('Inconsistent lengths')
+        # Compare arrays when lengths are unequal by truncating extra elements
+        length = min(len(test[0]), len(ref[0]))
 
         # Skip over arrays that are equal
-        if np.array_equal(test[0], ref[0]):
+        if np.array_equal(test[0][:length], ref[0][:length]):
             continue
         else:
-            lre = _log_relative_error(test[0], ref[0])
+            lre = _log_relative_error(test[0][:length], ref[0][:length])
             idx = np.unravel_index(np.argmin(lre), lre.shape)
 
             if lre[idx] < min_cdd: