Merge branch 'develop' into particle_gen3_csp

Author: qualand

.github/workflows/ci.yml

@@ -8,6 +8,8 @@ env:
   # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
   BUILD_TYPE: Release
   GTEST_REF: b85864c64758dec007208e56af933fc3f52044ee
+  ORTOOLS_VER: "9.14"
+  ORTOOLS_RELEASE: "6206"
 
 jobs:
   build-on-ubuntu:
@@ -27,7 +29,17 @@ jobs:
         echo "GTEST=$GTEST" >> $GITHUB_ENV
         SSCDIR=$GITHUB_WORKSPACE/ssc
         echo "SSCDIR=$SSCDIR" >> $GITHUB_ENV
+        ORTOOLSDIR=$GITHUB_WORKSPACE/or-tools_x86_64_Ubuntu-24.04_cpp_v$ORTOOLS_VER.$ORTOOLS_RELEASE
+        echo "ORTOOLSDIR=$ORTOOLSDIR" >> $GITHUB_ENV
     
+    - name: Download OR-Tools
+      if: steps.cached-ortools-restore.outputs.cache-hit != 'true'
+      shell: bash
+      run: |
+        curl -L https://github.com/google/or-tools/releases/download/v$ORTOOLS_VER/or-tools_amd64_ubuntu-24.04_cpp_v$ORTOOLS_VER.$ORTOOLS_RELEASE.tar.gz -o or-tools-$ORTOOLS_VER.tar.gz
+        tar xvzf or-tools-$ORTOOLS_VER.tar.gz
+
+
     - name: Get cached GTest
       uses: actions/cache@v4
       id: cachedgtest
@@ -49,27 +61,23 @@ jobs:
           export 
           mkdir ${GTEST}/build
           cd ${GTEST}/build
-          cmake -DCMAKE_CXX_FLAGS=-std=c++11 ..
+          cmake -DCMAKE_CXX_FLAGS=-std=c++17 ..
           make          
-    
+
     - name: Checkout SSC
       uses: actions/checkout@v4
       with:
          path: ssc
 
-    - name: Configure CMake
-      # Configure cmake to build ssc tests but not tools
-      run: |
-        mkdir ${SSCDIR}/build
-        cd ${SSCDIR}/build
-        cmake .. -DCMAKE_BUILD_TYPE=Release -DSAM_SKIP_TOOLS=1
-
-    - name: Build
-      # Build your program with the given configuration
+    - name: Build SSC
+      shell: bash
       run: |
-        cd ${SSCDIR}/build
+        # Downloaded OR-Tools has CoinOR enabled
+        mkdir $SSCDIR/build
+        cd $SSCDIR/build
+        cmake -DCMAKE_CONFIGURATION_TYPES="Release" -DENABLE_COVERAGE=1 -DSAM_SKIP_AUTOGEN=0 -DSAMAPI_EXPORT=1 -DSAM_SKIP_TOOLS=1  -DSAMPRIVATE=1 -DUSE_XPRESS=0 -DUSE_COINOR=1 -DCMAKE_SYSTEM_VERSION=10.0 -DCMAKE_SYSTEM_PREFIX_PATH=${ORTOOLSDIR} -Dabsl_DIR=${ORTOOLSDIR}\lib\cmake\absl" -Dutf8_range_DIR=${ORTOOLSDIR}\lib\cmake\utf8_range"  ..
         make -j4
-
+  
     - name: Test
       # Turn off fast fail for when the landbosse tests write to cerr
       run: |
@@ -118,13 +126,22 @@ jobs:
         echo "GTEST=$GTEST" >> $GITHUB_ENV
         SSCDIR=$GITHUB_WORKSPACE/ssc
         echo "SSCDIR=$SSCDIR" >> $GITHUB_ENV
+        ORTOOLSDIR=$GITHUB_WORKSPACE/or-tools_x86_64_macOS-15.5_cpp_v$ORTOOLS_VER.$ORTOOLS_RELEASE
+        echo "ORTOOLSDIR=$ORTOOLSDIR" >> $GITHUB_ENV
     
+    - name: Download OR-Tools
+      if: steps.cached-ortools-restore.outputs.cache-hit != 'true'
+      shell: bash
+      run: |
+        curl -L https://github.com/google/or-tools/releases/download/v$ORTOOLS_VER/or-tools_x86_64_macOS-15.5_cpp_v$ORTOOLS_VER.$ORTOOLS_RELEASE.tar.gz -o or-tools-$ORTOOLS_VER.tar.gz
+        tar xvzf or-tools-$ORTOOLS_VER.tar.gz
+ 
     - name: Get cached GTest
       uses: actions/cache@v4
       id: cachedgtest
       with:
         path: ${{env.GTEST}}/
-        key: gtest-${{ matrix.os }}
+        key: ortools-${{ matrix.os }}
     - name: Clone Gtest
       if: steps.cachedgtest.outputs.cache-hit != 'true'
       uses: actions/checkout@v4
@@ -139,7 +156,7 @@ jobs:
           export 
           mkdir ${GTEST}/build
           cd ${GTEST}/build
-          cmake -DCMAKE_CXX_FLAGS=-std=c++11 ..
+          cmake -DCMAKE_CXX_FLAGS=-std=c++17 ..
           make          
     
     - name: Checkout SSC
@@ -152,7 +169,7 @@ jobs:
       run: |
         mkdir ${SSCDIR}/build
         cd ${SSCDIR}/build
-        cmake .. -DCMAKE_BUILD_TYPE=Release -DSAM_SKIP_TOOLS=1 -DSAMAPI_EXPORT=0 
+        cmake .. -DCMAKE_BUILD_TYPE=Release -DSAM_SKIP_TOOLS=1 -DSAMAPI_EXPORT=0 -DCMAKE_INSTALL_PREFIX=${ORTOOLSDIR}
 
     - name: Build
       # Build your program with the given configuration
@@ -211,6 +228,8 @@ jobs:
     runs-on: windows-latest
 
     steps:
+    - uses: actions/checkout@v4
+
     - name: Setup cmake
       uses: jwlawson/actions-setup-cmake@v2
       with:
@@ -225,7 +244,17 @@ jobs:
         echo "GTEST=$GTEST" >> $GITHUB_ENV
         SSCDIR=$GITHUB_WORKSPACE/ssc
         echo "SSCDIR=$SSCDIR" >> $GITHUB_ENV
-    
+        ORTOOLSDIR=$GITHUB_WORKSPACE/or-tools_x64_VisualStudio2022_cpp_v$ORTOOLS_VER.$ORTOOLS_RELEASE
+        echo "ORTOOLSDIR=$ORTOOLSDIR" >> $GITHUB_ENV
+
+
+    - name: Download OR-Tools
+      if: steps.cached-ortools-restore.outputs.cache-hit != 'true'
+      shell: bash
+      run: |
+        curl -L https://github.com/google/or-tools/releases/download/v$ORTOOLS_VER/or-tools_x64_VisualStudio2022_cpp_v$ORTOOLS_VER.$ORTOOLS_RELEASE.zip -o or-tools-$ORTOOLS_VER.zip
+        7z x or-tools-$ORTOOLS_VER.zip
+
     - name: Get cached GTest
       uses: actions/cache@v4
       id: cachedgtest
@@ -245,7 +274,6 @@ jobs:
       if: steps.cachedgtest.outputs.cache-hit != 'true'
       shell: bash
       run: | 
-          export 
           mkdir ${GTEST}/build
           cd ${GTEST}/build
           cmake -Dgtest_force_shared_crt=ON ..
@@ -256,19 +284,18 @@ jobs:
       with:
           path: ssc
 
-    - name: Configure CMake
+    - name: Build SSC
       shell: bash
-      # Configure cmake to build ssc tests but not tools
       run: |
-        mkdir ${SSCDIR}/build
-        cd ${SSCDIR}/build
-        cmake .. -DSAM_SKIP_TOOLS=1 -DCMAKE_CONFIGURATION_TYPES="Release"
-        cmake --build . --config Release -j4
+        # Downloaded OR-Tools has CoinOR enabled
+        mkdir $SSCDIR/build
+        cd $SSCDIR/build
+        cmake -G "Visual Studio 17 2022" -DCMAKE_CONFIGURATION_TYPES="Release"  -DSAM_SKIP_AUTOGEN=0 -DSAMAPI_EXPORT=1 -DSAM_SKIP_TOOLS=1  -DSAMPRIVATE=1 -DUSE_XPRESS=0 -DUSE_COINOR=1 -DCMAKE_SYSTEM_VERSION=10.0 -DCMAKE_SYSTEM_PREFIX_PATH=${ORTOOLSDIR} -Dabsl_DIR=${ORTOOLSDIR}\lib\cmake\absl" -Dutf8_range_DIR=${ORTOOLSDIR}\lib\cmake\utf8_range"  ..
+        cmake --build . --config Release -j4 --target Test
         cp ssc/Release/* test/Release
 
     - name: Test
       shell: bash
-      # Turn off fast fail for when the landbosse tests write to cerr
       run: |
         cd ${SSCDIR}/build/test/Release
         LOG_FILE=${SSCDIR}/build/test/gtest.log

.github/workflows/coverage.yml

@@ -8,6 +8,7 @@ env:
   # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
   BUILD_TYPE: Debug
   GTEST_REF: b85864c64758dec007208e56af933fc3f52044ee
+  ORTOOLS_VER: "9.14"
 
 jobs:
   coveralls-on-ubuntu:
@@ -30,13 +31,49 @@ jobs:
         echo "GTEST=$GTEST" >> $GITHUB_ENV
         SSCDIR=$GITHUB_WORKSPACE/ssc
         echo "SSCDIR=$SSCDIR" >> $GITHUB_ENV
+        ORTOOLSDIR=$GITHUB_WORKSPACE/or-tools-$ORTOOLS_VER/install_release
+        echo "ORTOOLSDIR=$ORTOOLSDIR" >> $GITHUB_ENV
+
     
     - name: Install OS dependencies
       run: |
         sudo apt-get update --fix-missing
         sudo apt-get install -y \
           lcov
 
+    - name: Restore cached OR-Tools
+      id: cached-ortools-restore
+      uses: actions/cache/restore@v4
+      with:
+        key: ortools-${{env.ORTOOLS_VER}}-linux-debug
+        path: ${{env.ORTOOLSDIR}}/
+
+    - name: Download OR-Tools
+      if: steps.cached-ortools-restore.outputs.cache-hit != 'true'
+      shell: bash
+      run: |
+        curl -L https://github.com/google/or-tools/releases/download/v$ORTOOLS_VER/or-tools-$ORTOOLS_VER.tar.gz -o or-tools-$ORTOOLS_VER.tar.gz
+        tar xvzf or-tools-$ORTOOLS_VER.tar.gz
+
+    - name: build OR-Tools
+      if: steps.cached-ortools-restore.outputs.cache-hit != 'true'
+      shell: bash
+      run: | 
+          mkdir ${ORTOOLSDIR}
+          cd or-tools-$ORTOOLS_VER
+          mkdir build
+          cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug -DBUILD_DEPS=ON -DUSE_COINOR=ON -DUSE_GLPK=ON -DBUILD_EXAMPLES=OFF -DBUILD_SAMPLES=OFF -DBUILD_DOC=OFF -DINSTALL_DOC=OFF -DCMAKE_INSTALL_PREFIX=${ORTOOLSDIR}
+          cmake --build build --config Debug --target all -j4 -v
+          cmake --build build --config Debug --target install -v
+
+    - name: Always save OR-Tools build
+      id: cached-ortools-save
+      if: always() && steps.cached-ortools-restore.outputs.cache-hit != 'true'
+      uses: actions/cache/save@v4
+      with:
+        key: ${{ steps.cached-ortools-restore.outputs.cache-primary-key }}
+        path: ${{env.ORTOOLSDIR}}/
+
 
     - name: Get cached GTest
       uses: actions/cache@v4
@@ -59,25 +96,21 @@ jobs:
           export 
           mkdir ${GTEST}/build
           cd ${GTEST}/build
-          cmake -DCMAKE_CXX_FLAGS=-std=c++11 ..
+          cmake -DCMAKE_CXX_FLAGS=-std=c++17 ..
           make          
     
     - name: Checkout SSC
       uses: actions/checkout@v4
       with:
          path: ssc
 
-    - name: Configure CMake
-      # Configure cmake to build ssc tests but not tools
-      run: |
-        mkdir ${SSCDIR}/build
-        cd ${SSCDIR}/build
-        cmake .. -DCMAKE_BUILD_TYPE=Debug -DENABLE_COVERAGE=1 -DSAM_SKIP_TOOLS=1 
-
-    - name: Build
-      # Build your program with the given configuration
+    - name: Build SSC
+      shell: bash
       run: |
-        cd ${SSCDIR}/build
+        # Downloaded OR-Tools has CoinOR enabled
+        mkdir $SSCDIR/build
+        cd $SSCDIR/build
+        cmake -DCMAKE_BUILD_TYPE=Debug -DENABLE_COVERAGE=1 -DSAM_SKIP_TOOLS=1 -DUSE_XPRESS=0 -DUSE_COINOR=1 -DCMAKE_SYSTEM_VERSION=10.0 -DCMAKE_SYSTEM_PREFIX_PATH=${ORTOOLSDIR} -Dabsl_DIR=${ORTOOLSDIR}\lib\cmake\absl" -Dutf8_range_DIR=${ORTOOLSDIR}\lib\cmake\utf8_range"  ..
         make -j4
 
     - name: Test

.github/workflows/release.yml

@@ -46,4 +46,4 @@ jobs:
         git add '${{ github.workspace }}/ssc/test/elapsed_time_release'
         git commit -m "Update Test Elapsed Time CSVs for new Release"
         git push origin update_test_times
-        gh pr create -B develop -H update_test_times --title 'Merge update_test_times into develop' --body 'Created by Github action'
+        gh pr create -B develop -H update_test_times --title 'Merge update_test_times into develop' --body 'As part of automated release process, run the SSC tests and update the test times CSV. This allows tracking of the test times across releases, and for comparison of feature branchs' test times to that of the latest release.\n\nCreated via release.yml by Github action'

.gitignore

@@ -33,6 +33,8 @@ bld/
 build/
 cmake-build-debug/
 cmake-build-release/
+CMakeFiles
+CMakeCache.txt
 test/Test
 
 # Visual Studio 2015 cache/options directory
@@ -344,6 +346,7 @@ build_osx/Test
 build_linux/Test
 build_linux/config.status
 linux_test\.txt
+build2
 
 nlopt/config.h
 nlopt/config.status
@@ -360,3 +363,5 @@ ssc/ssc\.exp
 ssc/sscd\.exp
 
 build_android/lib_oldssc.zip
+
+or-tools

CMakeLists.txt

@@ -16,6 +16,18 @@ option(SAM_SKIP_TESTS "Skips building tests" OFF)
 
 option(SAMAPI_EXPORT "Export of ssc binaries to the SAM_api directory; for Unix, compile ssc libraries for SAM_api" ON)
 
+include(CMakeDependentOption)
+
+CMAKE_DEPENDENT_OPTION(BUILD_DEPS "Build OR-Tools dependencies" ON "NOT SKIP_ORTOOLS" OFF)
+CMAKE_DEPENDENT_OPTION(USE_COINOR "Use the COIN-OR solver" OFF "NOT SKIP_ORTOOLS" OFF)
+CMAKE_DEPENDENT_OPTION(USE_HIGHS "Use the HiGHS solver" OFF "NOT SKIP_ORTOOLS" OFF)
+CMAKE_DEPENDENT_OPTION(BUILD_EXAMPLES "Build examples" OFF "NOT SKIP_ORTOOLS" OFF)
+CMAKE_DEPENDENT_OPTION(BUILD_SAMPLES "Build samples" OFF "NOT SKIP_ORTOOLS" OFF)
+CMAKE_DEPENDENT_OPTION(INSTALL_DOC "Install doc" OFF "NOT SKIP_ORTOOLS" OFF)
+CMAKE_DEPENDENT_OPTION(USE_COINOR "Use COINOR solvers" OFF "NOT SKIP_ORTOOLS" OFF)
+CMAKE_DEPENDENT_OPTION(USE_XPRESS "Adds support for the XPRESS Solver" OFF "NOT SKIP_ORTOOLS" OFF)
+
+
 #
 # If project isn't system_advisor_model and SAM_SKIP_TOOLS=1,
 #   environment vars LK_LIB and LKD_LIB can be used to specify where to find those libraries
@@ -25,12 +37,28 @@ if(APPLE)
     set(CMAKE_OSX_DEPLOYMENT_TARGET "12" CACHE STRING "Minimum OS X deployment version")
 endif()
 
+if (UNIX AND NOT CMAKE_C_COMPILER)
+    set(CMAKE_C_COMPILER gcc)
+    set(CMAKE_CXX_COMPILER g++)
+endif()
+
+set(CMAKE_CXX_STANDARD 20)
+
 if ( NOT APPLE)
     set(CURL_DIR build_resources/libcurl_ssl_x64)
 endif()
 
 Project(sam_simulation_core VERSION 1.0.0 LANGUAGES CXX C)
 
+if(MSVC)
+    set(CMAKE_CONFIGURATION_TYPES "Debug;Release" CACHE STRING "Debug and Release Builds Configured" FORCE)
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /std:c++20")
+    # for linking to Release build of ortools 
+    set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreadedDLL")
+    # Get the current debug flags and remove the /D_DEBUG option.
+    string(REPLACE "/D_DEBUG" "" CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG}")
+ endif()
+
 
 #####################################################################################################################
 #
@@ -39,7 +67,6 @@ Project(sam_simulation_core VERSION 1.0.0 LANGUAGES CXX C)
 #####################################################################################################################
 set(CMAKE_VERBOSE_MAKEFILE ON)
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
-set(CMAKE_CXX_STANDARD 11)
 
 function(set_no_warnings target)
     get_target_property(MAIN_CFLAGS ${target} COMPILE_FLAGS)
@@ -76,7 +103,11 @@ function(set_default_compile_options target)
         set(MAIN_CFLAGS "")
     endif()
     set(MAIN_CFLAGS "${MAIN_CFLAGS} -D__64BIT__")
-    set_property(TARGET ${target} PROPERTY CXX_STANDARD 11)
+    if (MSVC)
+        set_property(TARGET ${target} PROPERTY CXX_STANDARD 20)
+    else()
+        set_property(TARGET ${target} PROPERTY CXX_STANDARD 17)
+    endif()
     set_property(TARGET ${target} PROPERTY CXX_STANDARD_REQUIRED ON)
     if(MSVC)
         set(MAIN_CFLAGS "${MAIN_CFLAGS} /bigobj /MP")
@@ -120,7 +151,7 @@ function(set_tools_compile_options target)
         if (APPLE)
             set(MAIN_CFLAGS "${MAIN_CFLAGS} -D__WXOSX__")
         endif()
-        set(MAIN_CFLAGS "${MAIN_CFLAGS} -Wall -Wno-deprecated -Wno-unknown-pragmas -Wno-overloaded-virtual -fno-common -std=c++11")
+        set(MAIN_CFLAGS "${MAIN_CFLAGS} -Wall -Wno-deprecated -Wno-unknown-pragmas -Wno-overloaded-virtual -fno-common")
         set(MAIN_CFLAGS "${MAIN_CFLAGS} -DLK_USE_WXWIDGETS")
     endif(MSVC)
     set_target_properties(${target} PROPERTIES COMPILE_FLAGS ${MAIN_CFLAGS})
@@ -151,11 +182,11 @@ add_subdirectory(tcs)
 add_subdirectory(ssc)
 
 if (NOT SAM_SKIP_TOOLS)
-	add_subdirectory(sdktool)
+    add_subdirectory(sdktool)
 endif()
 
 if (NOT SAM_SKIP_TESTS)
-	add_subdirectory(test)
+    add_subdirectory(test)
 endif()
 
 if(CMAKE_BUILD_TYPE STREQUAL "Debug"

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2017, 2022 Alliance for Sustainable Energy, LLC
+Copyright (c) 2017, 2022 Alliance for Energy Innovation, LLC
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without