Merge branch 'latest-os-hpxml' of https://github.com/NREL/OpenStudio-ERI

into ansi_301_2022_envelope
NREL · Mar 25, 2024 · 5cd5596 · 5cd5596
2 parents 82ae6df + ef0da90
commit 5cd5596
Show file tree

Hide file tree

Showing 280 changed files with 205,634 additions and 171,540 deletions.
diff --git a/.github/workflows/config.yml b/.github/workflows/config.yml
@@ -13,7 +13,7 @@ jobs:
     container:
       image: docker://nrel/openstudio:3.7.0
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
 
@@ -38,7 +38,7 @@ jobs:
           bundle exec rake test_rulesets
 
       - name: Store code coverage
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: coverage
           name: coverage
@@ -49,7 +49,7 @@ jobs:
           make html SPHINXOPTS="-W --keep-going -n"
 
       - name: Save Docs
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: documentation
           path: docs/_build/html/
@@ -59,7 +59,7 @@ jobs:
     container:
       image: docker://nrel/openstudio:3.7.0
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
 
@@ -72,7 +72,7 @@ jobs:
           bundle exec rake test_sample_files1
 
       - name: Store results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: workflow/tests/test_results
           name: test_results_sample_files1
@@ -82,7 +82,7 @@ jobs:
     container:
       image: docker://nrel/openstudio:3.7.0
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
 
@@ -95,7 +95,7 @@ jobs:
           bundle exec rake test_sample_files2
 
       - name: Store results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: workflow/tests/test_results
           name: test_results_sample_files2
@@ -105,7 +105,7 @@ jobs:
     container:
       image: docker://nrel/openstudio:3.7.0
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
 
@@ -118,7 +118,7 @@ jobs:
           bundle exec rake test_real_homes
 
       - name: Store results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: workflow/tests/test_results
           name: test_results_real_homes
@@ -128,7 +128,7 @@ jobs:
     container:
       image: docker://nrel/openstudio:3.7.0
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
 
@@ -141,15 +141,15 @@ jobs:
           bundle exec rake test_other
 
       - name: Store results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: workflow/tests/test_results
           name: test_results_other
 
   run-windows-tests:
     runs-on: windows-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
       - name: Install software and run test
@@ -161,59 +161,47 @@ jobs:
           tar -xzf Windows.tar.gz
           & .\OpenStudio-${env:OS_VERSION}+${env:OS_SHA}-Windows\bin\openstudio.exe workflow\energy_rating_index.rb -x workflow\sample_files\base.xml --hourly ALL --add-component-loads
 
+  merge-results:
+    runs-on: ubuntu-latest
+    needs: [run-sample-files1-tests, run-sample-files2-tests, run-real-home-tests, run-other-tests]
+    steps:
+      - name: Merge Artifacts
+        uses: actions/upload-artifact/merge@v4
+        with:
+          name: results
+          pattern: test_results_*
+          delete-merged: true
+
   compare-results:
     if: github.event_name == 'pull_request'
     runs-on: ubuntu-latest
-    needs: [run-sample-files1-tests, run-sample-files2-tests, run-real-home-tests, run-other-tests]
+    needs: merge-results
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.base.sha }}
 
       - name: Store base results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: workflow/tests/base_results
           name: base_results
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha }}
 
       - name: Download base results
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
-          path: |
-            base_results
+          path: base_results
           name: base_results
 
-      - name: Download Sample Files 1 feature results
-        uses: actions/download-artifact@v3
-        with:
-          path: |
-            results
-          name: test_results_sample_files1
-
-      - name: Download Sample Files 2 feature results
-        uses: actions/download-artifact@v3
+      - name: Download feature results
+        uses: actions/download-artifact@v4
         with:
-          path: |
-            results
-          name: test_results_sample_files2
-
-      - name: Download Real Home feature results
-        uses: actions/download-artifact@v3
-        with:
-          path: |
-            results
-          name: test_results_real_homes
-
-      - name: Download Other feature results
-        uses: actions/download-artifact@v3
-        with:
-          path: |
-            results
-          name: test_results_other
+          path: results
+          name: results
 
       - name: Compare results
         run: |
@@ -230,46 +218,24 @@ jobs:
           python hpxml-measures/workflow/tests/compare.py -a visualize
 
       - name: Store comparisons
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: workflow/tests/comparisons
           name: comparisons
 
   update-results:
     runs-on: ubuntu-latest
-    needs: [run-sample-files1-tests, run-sample-files2-tests, run-real-home-tests, run-other-tests]
+    needs: merge-results
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
 
-      - name: Download Sample Files 1 feature results
-        uses: actions/download-artifact@v3
+      - name: Download feature results
+        uses: actions/download-artifact@v4
         with:
-          path: |
-            results
-          name: test_results_sample_files1
-
-      - name: Download Sample Files 2 feature results
-        uses: actions/download-artifact@v3
-        with:
-          path: |
-            results
-          name: test_results_sample_files2
-
-      - name: Download Real Home feature results
-        uses: actions/download-artifact@v3
-        with:
-          path: |
-            results
-          name: test_results_real_homes
-
-      - name: Download Other feature results
-        uses: actions/download-artifact@v3
-        with:
-          path: |
-            results
-          name: test_results_other
+          path: results
+          name: results
 
       - name: Commit latest results
         shell: bash        

diff --git a/Changelog.md b/Changelog.md
@@ -5,13 +5,20 @@ __New Features__
   - `ERICalculation/Version` and `CO2IndexCalculation/Version` can now be "2022C" or "2022".
   - Allows modeling electric battery storage, including shared batteries ("2022C" or newer).
   - The `ElectricAuxiliaryEnergy` input for boilers is no longer used.
+- **Breaking change**: ERI_Results.csv and ERI_Worksheet.csv combined into a single ERI_Results.csv that better reflects the current ERI calculation components; additional fields (e.g., PEfrac) added and a few renamed/removed.
 - **Breaking change**: Each `VentilationFan` must have one (and only one) `UsedFor...` element set to true.
+- Allows `AverageCeilingHeight` to be optionally provided for infiltration calculations.
 - Ground source heat pump model enhancements.
 - Allows `Roof/RadiantBarrier` to be omitted; defaults to false.
 - Adds more error-checking for inappropriate inputs (e.g., HVAC SHR=0 or clothes washer IMEF=0).
 - Allows `FractionDuctArea` as alternative to `DuctSurfaceArea`
+- Now defaults to -20F for `CompressorLockoutTemperature` for variable-speed air-to-air heat pumps.
+- Clarifies that Capacity=-1 can be used to autosize HVAC equipment for research purposes or to run tests.
+  - It should *not* be used for a real home; a warning will be issued when it's used.
+- Allow alternative label energy use (W) input for ceiling fans.
 
 __Bugfixes__
+- Fixes incorrect Reference Home mechanical ventilation flowrate for attached units (when Aext is not 1).
 - Fixes possible 301ruleset.rb error due to floating point arithmetic.
 
 ## OpenStudio-ERI v1.7.0