Update to EnergyPlus v24.2.0a

.github/workflows/clangformat.yml

@@ -20,7 +20,7 @@ jobs:
 
     - name: Upload clang-format patch as artifact
       if: ${{ failure() }}
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
           name: OpenStudio-${{ github.sha }}-clang_format.patch
           path: clang_format.patch

.github/workflows/cppcheck.yml

@@ -8,11 +8,22 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
-    container:
-      image: nrel/cppcheck:2.3
+    runs-on: ubuntu-20.04
+    # That container is too old to work with the actions that are on node20 now...
+    #container:
+    #  image: nrel/cppcheck:2.3
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
+
+    - name: Install cppcheck
+      shell: bash
+      run: |
+        # I made a PPA on launchpad where I built cppcheck 2.3 for focal
+        sudo add-apt-repository ppa:jmarrec/ppa
+        sudo apt update
+        sudo apt install -y cppcheck
+        cppcheck --version
+
     - name: Run cppcheck
       shell: bash
       run: |
@@ -57,7 +68,7 @@ jobs:
 
     - name: Upload cppcheck results as artifact
       if: ${{ always() }}
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
           name: OpenStudio-${{ github.sha }}-cppcheck_results.txt
           path: cppcheck.txt

.github/workflows/dependabot_conan.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v5
       with:
         python-version: '3.x'
 

CMake/FindEnergyPlus.cmake

@@ -81,7 +81,7 @@ foreach(PATH ${ENERGYPLUS_POSSIBLE_PATHS})
     endif()
 
     # we just need to read the first part of this large file
-    file(READ "${ENERGYPLUS_IDD}" IDD_TEXT LIMIT 1000) 
+    file(READ "${ENERGYPLUS_IDD}" IDD_TEXT LIMIT 1000)
     string(REGEX MATCH "!IDD_BUILD [0-9a-z][0-9a-z][0-9a-z][0-9a-z][0-9a-z][0-9a-z][0-9a-z][0-9a-z][0-9a-z][0-9a-z]" BUILD_SHA_LINE "${IDD_TEXT}")
     string(REGEX MATCH "[0-9a-z][0-9a-z][0-9a-z][0-9a-z][0-9a-z][0-9a-z][0-9a-z][0-9a-z][0-9a-z][0-9a-z]" BUILD_SHA "${BUILD_SHA_LINE}")
     set(ENERGYPLUS_GE_8_2_0 TRUE)

CMakeLists.txt

@@ -18,7 +18,7 @@ if(CCACHE_PROGRAM)
 endif()
 
 # Project macro can only take digits in the version, it splits these out to specific variables
-project(OpenStudio VERSION 3.8.0)
+project(OpenStudio VERSION 3.9.0)
 
 include(CMake/compiler_flags.cmake)
 
@@ -161,7 +161,7 @@ get_directory_property(hasParent PARENT_DIRECTORY)
 
 # TODO: Modify the more specific variables as needed to indicate prerelease, etc
 # Keep in beta in-between release cycles. Set to empty string (or comment out) for official)
-set(PROJECT_VERSION_PRERELEASE "")
+set(PROJECT_VERSION_PRERELEASE "alpha")
 
 # OpenStudio version: Only include Major.Minor.Patch, eg "3.0.0", even if you have a prerelease tag
 set(OPENSTUDIO_VERSION "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH}")
@@ -192,15 +192,15 @@ endif()
 
 # EnergyPlus Idd version
 set(ENERGYPLUS_VERSION_MAJOR 24)
-set(ENERGYPLUS_VERSION_MINOR 1)
+set(ENERGYPLUS_VERSION_MINOR 2)
 set(ENERGYPLUS_VERSION_PATCH 0)
 set(ENERGYPLUS_VERSION "${ENERGYPLUS_VERSION_MAJOR}.${ENERGYPLUS_VERSION_MINOR}.${ENERGYPLUS_VERSION_PATCH}")
 # Build SHA is not required to have a value, but if it does OpenStudio will require this build.
-set(ENERGYPLUS_BUILD_SHA "9d7789a3ac")
+set(ENERGYPLUS_BUILD_SHA "94a887817b")
 
 # ENERGYPLUS_RELEASE_NAME is used to locate the E+ download
 # from the github releases
-set(ENERGYPLUS_RELEASE_NAME "v24.1.0")
+set(ENERGYPLUS_RELEASE_NAME "v24.2.0a")
 
 set(ENERGYPLUS_REPO "NREL")
 
@@ -639,26 +639,30 @@ endif()
 if(UNIX)
   if(APPLE)
     if (ARCH MATCHES "arm64")
-      set(ENERGYPLUS_EXPECTED_HASH 3b465e87fc07e18db458e1d058da447b)
-      set(ENERGYPLUS_PLATFORM "Darwin-macOS12.1-arm64")
+      set(ENERGYPLUS_EXPECTED_HASH f36afc055a675ae95523d6f41ec478c0)
+      set(ENERGYPLUS_PLATFORM "Darwin-macOS13-arm64")
     else()
-      set(ENERGYPLUS_EXPECTED_HASH 4f15adccac3df1e699d26f815800c783)
-      set(ENERGYPLUS_PLATFORM "Darwin-macOS11.6-x86_64")
+      set(ENERGYPLUS_EXPECTED_HASH b2003c461277c0bd4e91a4c003b350ac)
+      set(ENERGYPLUS_PLATFORM "Darwin-macOS12.1-x86_64")
     endif()
   elseif(LSB_RELEASE_ID_SHORT MATCHES "CentOS")
-    set(ENERGYPLUS_EXPECTED_HASH c31dfb86d8967636fca0a1ecf4052f22)
+    set(ENERGYPLUS_EXPECTED_HASH 4000e06b944daf4f2b0841ac0d3873b5)
     set(ENERGYPLUS_PLATFORM "Linux-CentOS7.9.2009-x86_64")
   else()
-    if(LSB_RELEASE_VERSION_SHORT MATCHES "22.04")
+    if(LSB_RELEASE_VERSION_SHORT MATCHES "24.04")
       if (ARCH MATCHES "arm64")
-        set(ENERGYPLUS_EXPECTED_HASH 2e1e9516b39ca8046b7cf79ad3a81fa7)
+        set(ENERGYPLUS_EXPECTED_HASH afc61e89b7f9e2658c3d99778be50be0)
       else()
-        set(ENERGYPLUS_EXPECTED_HASH fb171a5da7d41da80da7868686b41126)
+        set(ENERGYPLUS_EXPECTED_HASH 22b3e5f6071d6011ffeeacf854a97c73)
       endif()
-    elseif(LSB_RELEASE_VERSION_SHORT MATCHES "20.04")
-      set(ENERGYPLUS_EXPECTED_HASH 4ea21126c3989cad35078a711573572e)
-    else() # 18.04
-      message(FATAL_ERROR "EnergyPlus no longer provides packages for Ubuntu 18.04")
+    elseif(LSB_RELEASE_VERSION_SHORT MATCHES "22.04")
+      if (ARCH MATCHES "arm64")
+        set(ENERGYPLUS_EXPECTED_HASH 3c18cb8063ec30ef591109ddf8842bf0)
+      else()
+        set(ENERGYPLUS_EXPECTED_HASH 9f11a16e6f8a7d658791c5389d700ef1)
+      endif()
+    else() # e.g., 18.04, 20.04
+      message(FATAL_ERROR "EnergyPlus no longer provides packages for Ubuntu < 22.04")
     endif()
     set(ENERGYPLUS_PLATFORM "Linux${ENERGYPLUS_SYSTEM_VERSION}-${ARCH}")
   endif()
@@ -685,19 +689,18 @@ if(UNIX)
     endif()
 
     execute_process(COMMAND ${CMAKE_COMMAND} -E remove_directory "${PROJECT_BINARY_DIR}/${ENERGYPLUS_PATH}")
-
+    file(REMOVE "${PROJECT_BINARY_DIR}/python/engine/pip_install_done.stamp")
   endif()
 
 elseif(WIN32)
   if(CMAKE_SIZEOF_VOID_P EQUAL 8) # 64 bit
     set(ENERGYPLUS_PATH "EnergyPlus-${ENERGYPLUS_VERSION}-${ENERGYPLUS_BUILD_SHA}-Windows-x86_64")
     set(ENERGYPLUS_ARCH 64)
-    set(ENERGYPLUS_EXPECTED_HASH c9dd8a23b64d1327d00c5d85896b46bb)
+    set(ENERGYPLUS_EXPECTED_HASH 6a2d1d43d64490c87d894ed58f71ccdc)
   else()
     set(ENERGYPLUS_PATH "EnergyPlus-${ENERGYPLUS_VERSION}-${ENERGYPLUS_BUILD_SHA}-Windows-i386")
     set(ENERGYPLUS_ARCH 32)
-    set(ENERGYPLUS_EXPECTED_HASH 766cf42388ca5b682800fe6ded8ac3ee)
-    set(ENERGYPLUS_REPO "jmarrec")
+    set(ENERGYPLUS_EXPECTED_HASH 7f0c2901399f43bff6e23c01a5992df1)
   endif()
   if(EXISTS "${PROJECT_BINARY_DIR}/${ENERGYPLUS_PATH}.zip")
     file(MD5 "${PROJECT_BINARY_DIR}/${ENERGYPLUS_PATH}.zip" ENERGYPLUS_HASH)
@@ -711,7 +714,7 @@ elseif(WIN32)
          EXPECTED_MD5 ${ENERGYPLUS_EXPECTED_HASH})
 
     execute_process(COMMAND ${CMAKE_COMMAND} -E remove_directory "${PROJECT_BINARY_DIR}/${ENERGYPLUS_PATH}")
-
+    file(REMOVE "${PROJECT_BINARY_DIR}/python/engine/pip_install_done.stamp")
   endif()
 
 endif()
@@ -1359,7 +1362,7 @@ install(FILES "${ENERGYPLUS_EPJSON_SCHEMA}" DESTINATION ./EnergyPlus/ COMPONENT
 install(PROGRAMS ${ENERGYPLUS_FILES} DESTINATION ./EnergyPlus/ COMPONENT EnergyPlus)
 install(PROGRAMS ${ENERGYPLUS_LIB_FILES} DESTINATION ./EnergyPlus/ COMPONENT EnergyPlus)
 install(PROGRAMS "${EXPAND_OBJECTS}" DESTINATION ./EnergyPlus/ COMPONENT EnergyPlus)
-install(DIRECTORY "${ENERGYPLUS_DIR}/python_standard_lib" DESTINATION ./EnergyPlus/ COMPONENT EnergyPlus)
+install(DIRECTORY "${ENERGYPLUS_DIR}/python_lib" DESTINATION ./EnergyPlus/ COMPONENT EnergyPlus)
 install(DIRECTORY "${ENERGYPLUS_DIR}/pyenergyplus" DESTINATION ./EnergyPlus/ COMPONENT EnergyPlus)
 
 if(APPLE)

Jenkinsfile_develop_code_coverage

@@ -1,7 +1,7 @@
 
 //Jenkins pipelines are stored in shared libaries. Please see: https://github.com/NREL/cbci_jenkins_libs
 
-@Library('cbci_shared_libs') _
+@Library('cbci_shared_libs@py3update') _
 
 // Build for PR to develop branch only.
 if ((env.CHANGE_ID) && (env.CHANGE_TARGET) ) {

Jenkinsfile_develop_osx

@@ -1,6 +1,6 @@
 //Jenkins pipelines are stored in shared libaries. Please see: https://github.com/NREL/cbci_jenkins_libs
 
-@Library('cbci_shared_libs') _
+@Library('cbci_shared_libs@py3update') _
 
 // Build for PR to develop branch only.
 if ((env.CHANGE_ID) && (env.CHANGE_TARGET) ) {

Jenkinsfile_develop_ubuntu_2204

@@ -1,7 +1,7 @@
 
 //Jenkins pipelines are stored in shared libaries. Please see: https://github.com/NREL/cbci_jenkins_libs
 
-@Library('cbci_shared_libs') _
+@Library('cbci_shared_libs@py3update') _
 
 // Build for PR to develop branch only.
 if ((env.CHANGE_ID) && (env.CHANGE_TARGET) ) {

Jenkinsfile_develop_ubuntu_1804 → Jenkinsfile_develop_ubuntu_2404

@@ -1,11 +1,11 @@
 
 //Jenkins pipelines are stored in shared libaries. Please see: https://github.com/NREL/cbci_jenkins_libs
 
-@Library('cbci_shared_libs') _
+@Library('cbci_shared_libs@py3update') _
 
 // Build for PR to develop branch only.
 if ((env.CHANGE_ID) && (env.CHANGE_TARGET) ) {
 
-  openstudio_incremental_develop_ubuntu_1804()
+  openstudio_incremental_develop_ubuntu_2404()
 
 }

Jenkinsfile_develop_windows

@@ -1,6 +1,6 @@
 //Jenkins pipelines are stored in shared libaries. Please see: https://github.com/NREL/cbci_jenkins_libs
 
-@Library('cbci_shared_libs') _
+@Library('cbci_shared_libs@py3update') _
 
 // Build for PR to develop branch only.
 if ((env.CHANGE_ID) && (env.CHANGE_TARGET) ) {

conanfile.py

@@ -101,7 +101,7 @@ def generate(self):
 
         if self.options.with_python:
             v = sys.version_info
-            if (v.major, v.minor) == (3, 8):
+            if (v.major, v.minor) == (3, 12):
                 python_version = f"{v.major}.{v.minor}.{v.micro}"
                 self.output.info(
                     f"Setting PYTHON_VERSION and Python_ROOT_DIR from your current python: {python_version}, '{sys.base_prefix}'"
@@ -110,8 +110,8 @@ def generate(self):
                 tc.cache_variables["Python_ROOT_DIR"] = str(Path(sys.base_prefix))
             else:
                 self.output.warning(
-                    "Your current python is not in the 3.8.x range, which is what we target.\n"
+                    "Your current python is not in the 3.12.x range, which is what we target.\n"
                     "You'll need to pass it properly when configuring CMake\n"
-                    "via -DPYTHON_VERSION:STRING='3.8.xx' and -DPython_ROOT_DIR:PATH='/path/to/python3.8/'"
+                    "via -DPYTHON_VERSION:STRING='3.12.xx' and -DPython_ROOT_DIR:PATH='/path/to/python3.12/'"
                 )
         tc.generate()

python/SetupPython.cmake

@@ -35,10 +35,6 @@ else()
   endif()
 endif()
 
-execute_process(COMMAND ${CMAKE_COMMAND} -E env --unset=PIP_REQUIRE_VIRTUALENV ${Python_EXECUTABLE}
-  -m pip install --target=${ENERGYPLUS_DIR}/python_standard_lib --upgrade -r ${PROJECT_SOURCE_DIR}/python/requirements.txt
-)
-
 get_filename_component(Python_PROGRAM_NAME ${Python_EXECUTABLE} NAME)
 
 get_filename_component(RESOLVED_PYTHON_LIBRARY "${Python_LIBRARIES}" REALPATH)

python/engine/CMakeLists.txt

@@ -45,6 +45,27 @@ target_compile_options(pythonengine PRIVATE
 
 target_compile_definitions(pythonengine PRIVATE openstudio_scriptengine_EXPORTS SHARED_OS_LIBS)
 
+# Add a command to pip install the requirements into the E+ folder and generate a stamp file
+# Make it depend on the requirements.txt, so that it reruns when it changes
+add_custom_command(
+  OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/pip_install_done.stamp"
+  COMMAND ${CMAKE_COMMAND} -E touch "${CMAKE_CURRENT_BINARY_DIR}/pip_install_done.stamp"
+  COMMAND ${CMAKE_COMMAND} -E env --unset=PIP_REQUIRE_VIRTUALENV ${Python_EXECUTABLE}
+    -m pip install --target=${ENERGYPLUS_DIR}/python_lib --upgrade -r ${PROJECT_SOURCE_DIR}/python/requirements.txt
+  DEPENDS ${PROJECT_SOURCE_DIR}/python/requirements.txt
+)
+
+# And a target that calls the above command. It is NOT called by default
+add_custom_target(pip_install
+  DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/pip_install_done.stamp"
+)
+
+if(BUILD_CLI)
+  # When you build CLI, we want the pip_install to run, so add it as a dependency
+  # which will ensure it's run (beforehand, at **build** not configure time)
+  add_dependencies(pythonengine pip_install)
+endif()
+
 if(BUILD_TESTING)
   set(pythonengine_test_depends
     openstudio_scriptengine

python/engine/PythonEngine.cpp

@@ -78,7 +78,7 @@ PythonEngine::PythonEngine(int argc, char* argv[]) : ScriptEngine(argc, argv), p
   Py_FrozenFlag = 1;
 
   // Path to the E+ shipped standard library
-  auto pathToPythonPackages = getEnergyPlusDirectory() / "python_standard_lib";
+  auto pathToPythonPackages = getEnergyPlusDirectory() / "python_lib";
 
   // The PYTHONPATH / PYTHONHOME should be set before initializing Python
   // If this Py_SetPath is called before Py_Initialize, then Py_GetPath won't attempt to compute a default search path

python/engine/test/PythonEngine_GTest.cpp

@@ -87,6 +87,7 @@ TEST_F(PythonEngineFixture, WrongMethodMeasure) {
 Traceback (most recent call last):
   File "{}", line 14, in arguments
     model.nonExistingMethod()
+    ^^^^^^^^^^^^^^^^^^^^^^^
 AttributeError: 'Model' object has no attribute 'nonExistingMethod')",
                 scriptPath.generic_string());
 
@@ -118,10 +119,13 @@ Traceback (most recent call last):
     s(10)
   File "{0}", line 6, in s
     return s(x)
+           ^^^^
   File "{0}", line 6, in s
     return s(x)
+           ^^^^
   File "{0}", line 6, in s
     return s(x)
+           ^^^^
   [Previous line repeated 996 more times]
 RecursionError: maximum recursion depth exceeded)",
                 scriptPath.generic_string());

python/requirements.txt

@@ -1,7 +1,7 @@
-jinja2 == 3.1.3
-numpy == 1.24.4
-pandas == 2.0.3
-pytest == 8.1.1
-coverage == 7.4.4
+jinja2 == 3.1.4
+numpy == 2.0.2
+pandas == 2.2.3
+pytest == 8.3.3
+coverage == 7.6.1
 pytest-cov == 5.0.0
-# pytest-xdist == 3.5.0
+# pytest-xdist == 3.6.1

resources/CMakeLists.txt

@@ -129,6 +129,7 @@ set(utilities_resources_src
   utilities/SqlFile/1ZoneEvapCooler-V23-1-0.sql
   utilities/SqlFile/1ZoneEvapCooler-V23-2-0.sql
   utilities/SqlFile/1ZoneEvapCooler-V24-1-0.sql
+  utilities/SqlFile/1ZoneEvapCooler-V24-2-0.sql
   utilities/xml/base.xml
   utilities/xml/hpxml_with_error.xml
   utilities/xml/schema/HPXML.xsd

resources/IdfFilesToTransition.lst.md

@@ -1,7 +1,8 @@
 - Run an initial build to produce build/resources/IdfFilesToTransition.lst from resources/IdfFilesToTransition.lst.in.
 - Install the appropriate version of EnergyPlus.
-- Open EnergyPlus/PreProcess/IDFVersionUpdater/IDFVersionUpdate.exe.
+- Open EnergyPlus/PreProcess/IDFVersionUpdater/IDFVersionUpdater.exe.
 - Choose File to Update... > build/resources/IdfFilesToTransition.lst.
 - New Version should auto-populate to version of EnergyPlus.
 - Create Intermediate Version Files > No.
 - Delete Original Files > Yes.
+- Click Update File.

resources/energyplus/5ZoneAirCooled/in.idf

@@ -100,7 +100,7 @@
 ! Environmental Emissions:        None
 ! Utility Tariffs:                None
 
-  Version,24.1;
+  Version,24.2;
 
   Building,
     Building,                !- Name

resources/energyplus/AllFuelTypes/in.idf

@@ -1,4 +1,4 @@
-  Version,24.1;
+  Version,24.2;
 
   Timestep,6;
 

resources/energyplus/BestestEx/in.idf

@@ -5,7 +5,7 @@
 !BESTEST-EX Case L200EX-PH BASE-CASE, developed by NREL
 !Use EnergyPlus IDFEditor to view inputs in IP units
 
-  Version,24.1;
+  Version,24.2;
 
   SimulationControl,
     No,                      !- Do Zone Sizing Calculation