Merge pull request #4176 from karthikeyad-pnnl/issue2180_BoilerPlant_Nov23

Issue2180 boiler plant nov23

Author: AntoineGautier

.github/workflows/formatting.yml

@@ -24,7 +24,7 @@ jobs:
     # Skip if the commit message contains "ci skip"
     if: "!contains(github.event.head_commit.message, 'ci skip')"
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
 
     steps:
       # Checks-out repository under $GITHUB_WORKSPACE, so job can access it
@@ -33,14 +33,14 @@ jobs:
 
       - uses: actions/setup-python@v4
         with:
-          python-version: '3.8.10' # Version range or exact version of a Python version to use, using SemVer's version range syntax
+          python-version: '3.10.11' # Version range or exact version of a Python version to use, using SemVer's version range syntax
           architecture: 'x64'      # optional x64 or x86. Defaults to x64 if not specified
 
       - name: "Install pip"
         run: pip3 install --upgrade pip wheel
 
       - name: "Install BuildingsPy"
-        run: pip3 install git+https://github.com/lbl-srg/BuildingsPy@50ac74d8e4fd067179bb38bc23140c2c9254c94c
+        run: pip3 install git+https://github.com/lbl-srg/BuildingsPy@v5.2.0
 
       - name: Check for UTF-8 BOM
         run : |
@@ -55,9 +55,11 @@ jobs:
       - name: "Test experiment setup"
         run : ../bin/runUnitTests.py --validate-experiment-setup
 
-      - name: "Test if package.order are correct"
+      - name: "Test if package.order are correct, and revert order in UsersGuide"
         run : |
               python -c 'import buildingspy.development.refactor as r; r.write_package_order(".", recursive=True)'
+              git checkout UsersGuide/ReleaseNotes/package.order
+              git checkout UsersGuide/package.order
               git diff --exit-code .
 
       - name: "Verify files for invalid strings"
@@ -119,3 +121,17 @@ jobs:
                    chmod u=rw,og=rw $ff
                 done
               done
+
+  test-checksum:
+    # Skip if the commit message contains "ci skip"
+    if: "!contains(github.event.head_commit.message, 'ci skip')"
+
+    runs-on: ubuntu-22.04
+
+    steps:
+      # Checks-out repository under $GITHUB_WORKSPACE, so job can access it
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Compute the checksum and check that it matches the value from the last commit
+        run: ./Resources/Scripts/travis/templates/checkandrun.sh --checksum --skip --diffhead

.travis.yml

@@ -30,24 +30,26 @@ services:
 
 env:
   global:
-    - BUILDINGSPY_VERSION=BuildingsPy@50ac74d8e4fd067179bb38bc23140c2c9254c94c
-    - OMC_VERSION=ubuntu-2004-omc:1.20.0_dev-314-g3033f43-1
-    - OPTIMICA_VERSION=travis-ubuntu-2204-optimica:1.40
-    - DYMOLA_VERSION=travis_ubuntu-2004_dymola:2023x-x86_64
-    - ENERGYPLUS_VERSION=EnergyPlus-9.6.0-f420c06a69-Linux-Ubuntu20.04-x86_64
+    - DOCKER_REPONAME=lbnlblum
+    - BUILDINGSPY_VERSION=BuildingsPy@v5.2.0
+    - OMC_VERSION=ubuntu-2204-omc:1.24.0-1
+    - OPTIMICA_VERSION=travis-ubuntu-2204-optimica:1.55.11
+    - DYMOLA_VERSION=travis_ubuntu-2004_dymola:2025x-x86_64_rev-1
+    - ENERGYPLUS_9_6_0=EnergyPlus-9.6.0-f420c06a69-Linux-Ubuntu20.04-x86_64
+    - ENERGYPLUS_23_1_0=EnergyPlus-23.1.0-87ed9199d4-Linux-Ubuntu20.04-x86_64
     - MODELICA_JSON_VERSION=6d950c3592fa021aa914ba4ff34a67cbb69962c6
     - MODELICA_JSON_HOME=${TRAVIS_BUILD_DIR}/modelica-json
 
   jobs:
     - TEST_ARG="make test-cdl-conformance"
-    - TEST_ARG="make test-energyplus-validations test-dymola-spawn-spaces test-openmodelica-spawn-spaces" #target test-optimica-spawn-fmu removed as it requires a local installation of OCT
+    - TEST_ARG="make test-energyplus-validations test-dymola-spawn-spaces test-openmodelica-spawn-spaces test-openmodelica-cdl" #target test-optimica-spawn-fmu removed as it requires a local installation of OCT
     - TEST_ARG="make test-bestest"
     - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.{Air,Examples}\""
     - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.{Air,Examples}\""
     - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.{Air,Examples}\""
-    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.ThermalZones.EnergyPlus_9_6_0\""
-    - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.ThermalZones.EnergyPlus_9_6_0\""
-    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.ThermalZones.EnergyPlus_9_6_0\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.ThermalZones.EnergyPlus_24_2_0\""
+    - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.ThermalZones.EnergyPlus_24_2_0\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.ThermalZones.EnergyPlus_24_2_0\""
     - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.ThermalZones.Detailed.{BaseClasses,Constructions,Examples}\""
     - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.ThermalZones.Detailed.{BaseClasses,Constructions,Examples}\""
     - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.ThermalZones.Detailed.{BaseClasses,Constructions,Examples}\""
@@ -63,9 +65,15 @@ env:
     - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.ThermalZones.{ISO13790,ReducedOrder}\""
     - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.ThermalZones.{ISO13790,ReducedOrder}\""
     - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.ThermalZones.{ISO13790,ReducedOrder}\""
-    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.{Applications,Experimental}\""
-    - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.{Applications,Experimental}\""
-    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.{Applications,Experimental}\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Applications\""
+    - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.Applications\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Applications\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.DHC.{ETS,Loads,Networks,Plants}\""
+    - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.DHC.{ETS,Loads,Networks,Plants}\" SINGLEPROC=\"true\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.DHC.{ETS,Loads,Networks,Plants}\""
+    - TEST_ARG="make test-dymola  PACKAGE=\"Buildings.DHC.Examples\""
+    - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.DHC.Examples\" SINGLEPROC=\"true\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.DHC.Examples\""
     - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Fluid.{Actuators,BaseClasses,Boilers,Chillers,CHPs,Delays}\""
     - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.Fluid.{Actuators,BaseClasses,Boilers,Chillers,CHPs,Delays}\""
     - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Fluid.{Actuators,BaseClasses,Boilers,Chillers,CHPs,Delays}\""
@@ -75,9 +83,9 @@ env:
     - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Fluid.FixedResistances\""
     - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.Fluid.FixedResistances\""
     - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Fluid.FixedResistances\""
-    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Fluid.{Geothermal,HeatExchangers,HeatPumps,Humidifiers,Interfaces}\""
-    - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.Fluid.{Geothermal,HeatExchangers,HeatPumps,Humidifiers,Interfaces}\""
-    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Fluid.{Geothermal,HeatExchangers,HeatPumps,Humidifiers,Interfaces}\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Fluid.{Geothermal,HeatExchangers,HeatPumps,Humidifiers,HydronicConfigurations,Interfaces}\""
+    - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.Fluid.{Geothermal,HeatExchangers,HeatPumps,Humidifiers,HydronicConfigurations,Interfaces}\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Fluid.{Geothermal,HeatExchangers,HeatPumps,Humidifiers,HydronicConfigurations,Interfaces}\""
     - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Fluid.{MassExchangers,MixingVolumes,Movers,Sensors,SolarCollectors,Sources,Storage,Utilities}\""
     - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.Fluid.{MassExchangers,MixingVolumes,Movers,Sensors,SolarCollectors,Sources,Storage,Utilities}\""
     - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Fluid.{MassExchangers,MixingVolumes,Movers,Sensors,SolarCollectors,Sources,Storage,Utilities}\""
@@ -96,22 +104,32 @@ env:
     - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Utilities\""
     - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.Utilities\""
     - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Utilities\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Templates\""
+    - TEST_ARG="make test-openmodelica  PACKAGE=\"Buildings.Templates\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Templates\""
+    - TEST_ARG="make test-templates-dymola"
 
 before_install:
   - echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin
-  - if [[ "$TEST_ARG" == *test-dymola* || "$TEST_ARG" == *test-bestest* || "$TEST_ARG" == *spawn-portability* ]]; then
-       docker pull "$DOCKER_USERNAME"/${DYMOLA_VERSION};
+  - if [[ "$TEST_ARG" == *test-dymola* || "$TEST_ARG" == *test-templates-dymola* || "$TEST_ARG" == *test-bestest* || "$TEST_ARG" == *spawn-portability* ]]; then
+       docker pull "$DOCKER_REPONAME"/${DYMOLA_VERSION};
        cp Buildings/Resources/Scripts/travis/dymola/dymola $HOME/bin/;
     fi;
-  - if [[ "$TEST_ARG" == *test-optimica* ]]; then
-       docker pull "$DOCKER_USERNAME"/${OPTIMICA_VERSION};
+  - if [[ "$TEST_ARG" == *test-optimica* || "$TEST_ARG" == *test-templates-optimica* ]]; then
+       docker pull "$DOCKER_REPONAME"/${OPTIMICA_VERSION};
        cp Buildings/Resources/Scripts/travis/optimica/jm_ipython.sh $HOME/bin/jm_ipython.sh;
     fi;
+# The Spawn idf reference results are generated with EnergyPlus 9.6.0,
+# while others use a more recent EnergyPlus, hence we install both
   - if [[ "$TEST_ARG" == *test-energyplus* ]]; then
-      wget --no-verbose https://github.com/NREL/EnergyPlus/releases/download/v9.6.0/${ENERGYPLUS_VERSION}.tar.gz;
-      tar xzf ${ENERGYPLUS_VERSION}.tar.gz;
-      rm ${ENERGYPLUS_VERSION}.tar.gz;
-      echo "Installed EnergyPlus in ${PWD}/${ENERGYPLUS_VERSION}";
+      wget --no-verbose https://github.com/NREL/EnergyPlus/releases/download/v9.6.0/${ENERGYPLUS_9_6_0}.tar.gz;
+      tar xzf ${ENERGYPLUS_9_6_0}.tar.gz;
+      rm ${ENERGYPLUS_9_6_0}.tar.gz;
+      echo "Installed EnergyPlus in ${PWD}/${ENERGYPLUS_9_6_0}";
+      wget --no-verbose https://github.com/NREL/EnergyPlus/releases/download/v23.1.0/${ENERGYPLUS_23_1_0}.tar.gz;
+      tar xzf ${ENERGYPLUS_23_1_0}.tar.gz;
+      rm ${ENERGYPLUS_23_1_0}.tar.gz;
+      echo "Installed EnergyPlus in ${PWD}/${ENERGYPLUS_23_1_0}";
     fi;
   - if [[ "$TEST_ARG" == *test-cdl-conformance* ]]; then
       wget --no-verbose https://github.com/lbl-srg/modelica-json/archive/${MODELICA_JSON_VERSION}.tar.gz;
@@ -124,8 +142,8 @@ before_install:
       cd -;
       echo "Installed modelica-json in ${MODELICA_JSON_HOME}";
     fi;
-  - if [[ "$TEST_ARG" == *test-openmodelica* ]]; then
-       docker pull "$DOCKER_USERNAME"/${OMC_VERSION};
+  - if [[ "$TEST_ARG" == *test-openmodelica* || "$TEST_ARG" == *test-templates-openmodelica* ]]; then
+       docker pull lbnlblum/${OMC_VERSION};
        cp Buildings/Resources/Scripts/travis/omc/omc $HOME/bin/omc;
     fi;
 
@@ -138,18 +156,30 @@ install:
   - pip3 install --upgrade pip wheel
   - pip3 install --only-binary=numpy,scipy,matplotlib numpy==1.21.4 scipy==1.7.3 matplotlib==3.5.1
   - pip3 install git+https://github.com/lbl-srg/${BUILDINGSPY_VERSION}
-  - if [[ "$TEST_ARG" == *test-energyplus* ]]; then
-      export PATH=${PATH}:${TRAVIS_BUILD_DIR}/${ENERGYPLUS_VERSION};
+  - if [[ "$TEST_ARG" == *test-energyplus* ]] || [[ "$TEST_ARG" == *test-templates* ]]; then
+      export ENERGYPLUS_9_6_0=${ENERGYPLUS_9_6_0};
+      export ENERGYPLUS_23_1_0=${ENERGYPLUS_23_1_0};
       pip3 install pandas==1.3.5;
     fi;
-  - if [[ "$TEST_ARG" == *EnergyPlus_9_6_0* ]] || [[ "$TEST_ARG" == *Buildings.{Applications,Experimental}* ]] || [[ "$TEST_ARG" == *spawn* ]]; then
+  - if [[ "$TEST_ARG" == *EnergyPlus_24_2_0* ]] || [[ "$TEST_ARG" == *Buildings.{Obsolete* ]] || [[ "$TEST_ARG" == *Buildings.DHC.{ETS,Loads,Networks,Plants}* ]] || [[ "$TEST_ARG" == *spawn* ]]; then
       echo "Installing Spawn binaries";
       Buildings/Resources/src/ThermalZones/install.py --binaries-for-os-only;
     fi;
+  - if [[ "$TEST_ARG" == *SINGLEPROC* ]]; then
+      export NPROC=1;
+    else
+      export NPROC=10;
+    fi;
 
 # Execute tests
 script:
-  - (cd Buildings/Resources/Scripts/travis && travis_wait 90 $TEST_ARG)
+  - |
+    TRAVIS_WAIT=90
+    if [[ "$TEST_ARG" == *test-templates* ]]; then
+      TRAVIS_WAIT=120
+    fi
+    (cd Buildings/Resources/Scripts/travis && travis_wait $TRAVIS_WAIT $TEST_ARG)
+
 
 after_failure:
   - |