Merge pull request #96 from OpenWaterAnalytics/release_version

v.0.9.0 release draft

Author: abhiramm7

.github/workflows/python-package.yml

@@ -7,9 +7,73 @@ env:
 
 
 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@v2
+        with:
+          submodules: true
+
+      - name: Install Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+
+      - name: Build wheel
+        run: |
+            pip install wheel
+            python setup.py bdist_wheel
+      - uses: actions/upload-artifact@v2
+        with:
+          path: nrtest-swmm/dist/*.whl
+
+  build_conda_wheels:
+    name: Conda wheel test mac
+    runs-on: macos-latest
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+        with:
+          submodules: true
+
+      - uses: conda-incubator/setup-miniconda@v2
+        with:
+          auto-update-conda: true
+          channels: conda-forge
+          python-version: 3.8
+
+      - name: Install required system packages
+        run: brew install swig ninja
+
+      - name: Install requirements
+        run: |
+          cd swmm-toolkit
+          conda activate test
+          conda install --yes --file build-requirements.txt
+          python setup.py bdist_wheel
+
+      - name: Test wheel
+        run: |
+          cd swmm-toolkit
+          conda activate test
+          conda install --yes --file test-requirements.txt
+          python -m pip install --no-index --find-links=./dist swmm_toolkit --user
+          pytest
+
+
   build_linux_wheels:
     name: Build wheels on linux
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
 
     steps:
       - name: Checkout repo
@@ -43,10 +107,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
 
@@ -85,4 +149,4 @@ jobs:
       - name: Upload artifacts
         uses: actions/upload-artifact@v2
         with:
-          path: swmm-toolkit/dist/*.whl
+          path: swmm-toolkit/dist/*.whl

.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/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]

swmm-toolkit/AUTHORS

@@ -1,6 +1,10 @@
 # Authors ordered by first contribution
 
 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/README.md

@@ -3,45 +3,27 @@
 `swmm-toolkit` contains SWIG generated Python wrappers for the swmm-solver and swmm-output libraries. 
 
 
-## Features
+## Build Status
 
-`swmm-toolkit` makes SWMM a fully fledged Python extension with:  
-
- - Python integration at the speed of C
- - Full access to library APIs
- - Pythonic naming, enums, exceptions, and return value handling 
+![Build Wheels](https://github.com/SWMM-Project/swmm-python/workflows/Build%20Wheels/badge.svg)
 
 
 ## Installation
 
+[![version](https://img.shields.io/pypi/v/swmm-toolkit.svg?maxAge=3600)](https://pypi.org/project/swmm-toolkit/) [![Downloads](https://pepy.tech/badge/swmm-toolkit)](https://pepy.tech/project/swmm-toolkit)
 
-## Build 
-1. Initialize submodule
-```cmd
-git submodule init
-git submodule update 
-```
-2. Create virtual environment
-3. `pip install` from requirements.txt
-4. `python setup.py build`
- 
-## Troubleshoot
-
-Steps to try if `python setup.py build` fails 
+  ``pip install swmm-toolkit``
 
-### Establish working swmm-solver build
-1. Create an environment variable `BOOST_ROOT_1_67_0` and set the variable to boost install location
-2. Confirm swmm-solver directory is initialized
-3. Confirm swmm-solver build is working 
 
-```
-cd swmm-solver 
-mkdir buildprod
-cd buildprod
-cmake -G "Visual Studio 14 2015 Win64" ..
-cmake --build . --config Release --target install 
-```
+## Features
 
+`swmm-toolkit` makes SWMM a fully fledged Python extension with:  
+ - Compatibility with USEPA SWMM
+ - Python integration at the speed of C
+ - Full access to library APIs
+ - Pythonic naming, enums, exceptions, and return value handling 
+ 
+ 
 ## Basic Usage
 
 Run a SWMM simulation. 

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,
@@ -109,18 +109,18 @@ def exclude_files(cmake_manifest):
     maintainer_email='[email protected]',
     license='CC0',
 
-    keywords="swmm5, swmm, stormwater, hydraulics, hydrology, ",
+    keywords="swmm5, swmm, stormwater, hydraulics, hydrology",
     classifiers=[
         "Topic :: Scientific/Engineering",
         "Operating System :: Microsoft :: Windows",
         "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",
+        "Development Status :: 5 - Production/Stable",
     ]
 )

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

@@ -4,22 +4,22 @@
 #  __init__.py - SWMM toolkit package
 #
 #  Created:    Aug 9, 2018
-#  Updated:    May 19, 2021
+#  Updated:    July 2, 2022
 #
 #  Author:     See AUTHORS
 #
 
-'''
+"""
 A low level pythonic API for the swmm-output and swmm-solver dlls using SWIG.
-'''
+"""
 
 
 __author__ = "See AUTHORS"
 __copyright__ = "None"
 __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"
@@ -29,13 +29,17 @@
 
 import os
 import platform
+import sys
 
 
 # Adds directory containing swmm libraries to path
 if platform.system() == "Windows":
     libdir = os.path.join(os.path.dirname(__file__), "../../swmm_toolkit")
 
     if hasattr(os, 'add_dll_directory'):
+        conda_exists = os.path.exists(os.path.join(sys.prefix, 'conda-meta'))
+        if conda_exists:
+            os.environ['CONDA_DLL_SEARCH_MODIFICATION_ENABLE'] = "1"
         os.add_dll_directory(libdir)
     else:
         os.environ["PATH"] = libdir + ";" + os.environ["PATH"]