Draft for OWA_v5.1.14 release

.github/workflows/build-test.yml

@@ -2,7 +2,7 @@
 #  build-and-test.yml - GitHub Actions CI for swmm-solver
 #
 #  Created: May 19, 2020
-#  Updated: Aug 13, 2020
+#  Updated: Jun 22, 2021
 #
 #  Author: Michael E. Tryby
 #          US EPA - ORD/CESER
@@ -14,49 +14,54 @@
 name: Build and Test
 
 on: [push, pull_request]
-#  push:
-#    branches: [master release develop]
-#    tags:
-#      - 'v*.*.*'
-#  pull_request:
-#    branches: [master release develop]
 
 jobs:
   build:
     strategy:
       fail-fast: false
       matrix:
-        os: [windows-2016, ubuntu-16.04, macos-latest]
+        os: [windows-2022, ubuntu-20.04, macos-10.15]
         requirements: [requirements-swmm.txt]
         include:
-          - os: windows-2016
-            generator: Visual Studio 15 2017 Win64
-            experimental: true
-            script_extension: cmd
+          - os: windows-2022
+            sys_pkgs: choco install boost-msvc-14.1
+            build_unit_test: make.cmd /g "Visual Studio 17 2022" /A "x64" /t
+            build_reg_test: make.cmd /g "Visual Studio 17 2022" /A "x64"
+            before_reg_test: before-nrtest.cmd
+            run_reg_test: run-nrtests.cmd
+            build_id: "%GITHUB_RUN_ID%_%GITHUB_RUN_NUMBER%"
+            experimental: false
             artifacts_ext: zip
             artifact_content_type: zip
-            gh_run_number: "%GITHUB_RUN_ID%_%GITHUB_RUN_NUMBER%"
             defaults:
               run:
                 shell: cmd
                 working-directory: ./ci-tools/windows
-          - os: ubuntu-16.04
-            generator: "Unix Makefiles"
+
+          - os: ubuntu-20.04
+            sys_pkgs: sudo apt install libboost-dev libboost-all-dev
+            # Statically link libraries with -s switch to address GitHub Ubuntu 20.04 symbol errors (issue #340)
+            build_unit_test: make.sh -s -t -g "Unix Makefiles"
+            build_reg_test: make.sh -s -g "Unix Makefiles"
+            before_reg_test: before-nrtest.sh
+            run_reg_test: run-nrtests.sh
+            build_id: ${GITHUB_RUN_ID}_${GITHUB_RUN_NUMBER}
             experimental: true
-            script_extension: sh
-            gh_run_number: ${GITHUB_RUN_ID}_${GITHUB_RUN_NUMBER}
             artifacts_ext: tar.gz
             artifact_content_type: tar
             defaults:
               run:
                 shell: bash
                 working-directory: ./ci-tools/linux
-          - os: macos-latest
-            generator: Xcode
+
+          - os: macos-10.15
+            sys_pkgs: brew install libomp boost
+            build_unit_test: make.zsh -t -g "Xcode"
+            build_reg_test: make.zsh -g "Xcode"
+            before_reg_test: before-nrtest.zsh
+            run_reg_test: run-nrtests.zsh
+            build_id: ${GITHUB_RUN_ID}_${GITHUB_RUN_NUMBER}
             experimental: true
-            ci_tools_path: ci-tools/darwin
-            script_extension: zsh
-            gh_run_number: ${GITHUB_RUN_ID}_${GITHUB_RUN_NUMBER}
             artifacts_ext: tar.gz
             artifact_content_type: tar
             defaults:
@@ -75,14 +80,17 @@ jobs:
       PROJECT: swmm
       BUILD_HOME: build
       TEST_HOME: nrtests
-      NRTESTS_URL: https://github.com/OpenWaterAnalytics/swmm-nrtestsuite
-      # ACTIONS_ALLOW_UNSECURE_COMMANDS: true
 
     steps:
       - name: Checkout repo
         uses: actions/checkout@v2
+
+      - name: Clone ci-tools repo
+        uses: actions/checkout@v2
         with:
-          submodules: recursive
+          repository: OpenWaterAnalytics/ci-tools
+          ref: master
+          path: ci-tools
 
       - name: Setup python
         uses: actions/setup-python@v2
@@ -92,55 +100,29 @@ jobs:
       - name: Install requirements
         run: |
           python -m pip install --upgrade pip
-          python -m pip install -r ${{ matrix.requirements }}
+          python -m pip install -r requirements-swmm.txt
 
-      - name: Install Darwin requirements
-        if: ${{ contains(matrix.os, 'macos') }}
-        run: |
-          brew install libomp
-          brew install boost
+      - name: Install required system packages
+        run: ${{ matrix.sys_pkgs }}
 
       - name: Build and unit test
-        run: |
-          ./make.${{ matrix.script_extension }} -t -g "${{ matrix.generator }}"
+        run: ./${{ matrix.build_unit_test }}
 
       - name: Build for reg test
-        run: |
-          ./make.${{ matrix.script_extension }} -g "${{ matrix.generator }}"
+        run: ./${{ matrix.build_reg_test }}
 
       - name: Before reg test
-        run: |
-          ./before-nrtest.${{ matrix.script_extension }}
+        env:
+          NRTESTS_URL: https://github.com/OpenWaterAnalytics/swmm-nrtestsuite
+          BENCHMARK_TAG: v2.0.1
+        run: ./${{ matrix.before_reg_test }} ${{ env.BENCHMARK_TAG }}
 
       - name: Run reg test
-        run: |
-          ./run-nrtests.${{ matrix.script_extension }} ${{ matrix.gh_run_number }}
+        run: ./${{ matrix.run_reg_test }} ${{ matrix.build_id }}
 
       - name: Upload artifacts
         if: ${{ always() }}
         uses: actions/upload-artifact@v2
         with:
           name: build-test-artifacts
           path: upload/*.*
-
-      # - name: Create release
-      #   id: create_release
-      #   uses: actions/create-release@v1
-      #   env:
-      #     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      #   with:
-      #     tag_name: ${{ github.ref }}
-      #     release_name: Release ${{ github.ref }}
-      #     draft: true
-      #     prerelease: true
-
-      # - name: Upload release assets
-      #   id: upload-release-asset
-      #   uses: actions/upload-release-asset@v1
-      #   env:
-      #     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      #   with:
-      #     upload_url: ${{ steps.create_release.outputs.upload_url }}
-      #     asset_path: upload/${PROJECT}*.${{ matrix.artifacts_ext }}
-      #     asset_name: owa-${PROJECT}-${{ matrix.os }}-${{ github.ref }}.${{ matrix.artifacts_ext }}
-      #     asset_content_type: application/${{ matrix.artifact_content_type }}

.gitignore

@@ -21,6 +21,7 @@
 
 
 # Build files
+ci-tools/
 build/
 *.o
 /Debug/
@@ -45,3 +46,4 @@ tests/solver/data/feng*
 
 # Generated files
 *_export.h
+version.h

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "ci-tools"]
-	path = ci-tools
-	url = https://github.com/OpenWaterAnalytics/ci-tools.git

CITATION.cff

@@ -0,0 +1,23 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "McDonnell"
+  given-names: "Bryant"
+  orcid: "https://orcid.org/0000-0002-6250-2220"
+- family-names: "Wu"
+  given-names: "Jia Xin"
+  orcid: "https://orcid.org/0000-0003-2233-9542"
+- family-names: "Ratliff"
+  given-names: "Katherine"
+  orcid: "https://orcid.org/0000-0003-1410-2756"
+- family-names: "Mullapudi"
+  given-names: "Abhiram"
+  orcid: "https://orcid.org/0000-0001-8141-3621"
+- family-names: "Tryby"
+  given-names: "Michael"
+  orcid: "https://orcid.org/0000-0001-5525-0734"
+title: "Open Water Analytics Stormwater Management Model"
+version: 5.1.13
+doi: 10.5281/zenodo.5484299
+date-released: 2021-01-12
+url: "https://github.com/OpenWaterAnalytics/Stormwater-Management-Model"

CMakeFiles/cmake.check_cache

@@ -0,0 +1 @@
+# This file is generated by cmake for dependency checking of the CMakeCache.txt file

CMakeLists.txt

@@ -2,12 +2,16 @@
 # CMakeLists.txt - CMake configuration file for swmm-solver
 #
 # Created: July 11, 2019
-# Updated: May 29, 2020
+# Updated: May 19, 2021
 #
-# Author: Michael E. Tryby
-#         US EPA ORD/CESER
+# Authors: Michael E. Tryby
+#          US EPA ORD/CESER
 #
 
+################################################################################
+##################    CMAKELISTS FOR SWMM-SOLVER PROJECT    ####################
+################################################################################
+
 
 cmake_minimum_required (VERSION 3.13)
 
@@ -18,9 +22,9 @@ endif()
 
 
 project(swmm-solver
-    VERSION 5.1.13
+    VERSION 5.1.14
     LANGUAGES C CXX
-    )
+)
 
 # Append local dir to module search path
 # list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
@@ -41,9 +45,12 @@ set(LIBRARY_DIST "lib")
 set(CONFIG_DIST  "cmake")
 
 
+# Define build options
 option(BUILD_TESTS "Build component tests (requires Boost)" OFF)
 option(BUILD_DOCS "Build toolkit docs (requires Doxygen)" OFF)
 
+# Added option to statically link libraries to address GitHub Ubuntu 20.04 symbol errors (issue #340)
+option(BUILD_SHARED_LIBS "Build using shared libraries" ON)
 
 # Add project subdirectories
 if(BUILD_DOCS)
@@ -61,30 +68,26 @@ if(BUILD_TESTS)
 endif()
 
 
-# Pass var up the project tree
-if(APPLE)
-    set(EXTERN_LIB_PATH ${EXTERN_LIB_PATH} PARENT_SCOPE)
-endif()
-
-
 # Create install rules for vcruntime.dll, msvcp.dll, vcomp.dll etc.
-set(CMAKE_INSTALL_OPENMP_LIBRARIES TRUE)
+if(OpenMP_FOUND)
+    set(CMAKE_INSTALL_OPENMP_LIBRARIES TRUE)
+endif()
 include(InstallRequiredSystemLibraries)
 
 
-# Create install target for License and Authors files
+# Create install target for License and Contributors files
 install(
     FILES
         "LICENSE"
-        "AUTHORS"
+        "CONTRIBUTORS"
     DESTINATION
         "."
 )
 
 
 # Configure CPack driven installer package
 set(CPACK_GENERATOR "ZIP;TGZ")
-set(CPACK_PACKAGE_VENDOR "US_EPA")
+set(CPACK_PACKAGE_VENDOR "OWA")
 set(CPACK_ARCHIVE_FILE_NAME "swmm")
 
 include(CPack)