Merge pull request #688 from NREL/latest-os-hpxml

OS-HPXML v1.7.0

.github/workflows/config.yml

@@ -11,7 +11,7 @@ jobs:
   run-unit-tests:
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:3.6.1
+      image: docker://nrel/openstudio:3.7.0
     steps:
       - uses: actions/checkout@v3
         with:
@@ -57,7 +57,7 @@ jobs:
   run-eri-tests:
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:3.6.1
+      image: docker://nrel/openstudio:3.7.0
     steps:
       - uses: actions/checkout@v3
         with:
@@ -80,7 +80,7 @@ jobs:
   run-real-home-tests:
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:3.6.1
+      image: docker://nrel/openstudio:3.7.0
     steps:
       - uses: actions/checkout@v3
         with:
@@ -103,7 +103,7 @@ jobs:
   run-resnet-tests:
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:3.6.1
+      image: docker://nrel/openstudio:3.7.0
     steps:
       - uses: actions/checkout@v3
         with:
@@ -126,7 +126,7 @@ jobs:
   run-es-zerh-tests:
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:3.6.1
+      image: docker://nrel/openstudio:3.7.0
     steps:
       - uses: actions/checkout@v3
         with:
@@ -155,8 +155,8 @@ jobs:
       - name: Install software and run test
         shell: pwsh
         run: |
-          $env:OS_VERSION="3.6.1"
-          $env:OS_SHA="bb9481519e"
+          $env:OS_VERSION="3.7.0"
+          $env:OS_SHA="d5269793f1"
           Invoke-WebRequest -OutFile Windows.tar.gz -URI "https://github.com/NREL/OpenStudio/releases/download/v${env:OS_VERSION}/OpenStudio-${env:OS_VERSION}+${env:OS_SHA}-Windows.tar.gz"
           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

Changelog.md

@@ -1,15 +1,34 @@
 ## OpenStudio-ERI v1.7.0
 
 __New Features__
-- **Breaking change**: Disaggregates "EC_x Vent" and "EC_x Dehumid" from "EC_x L&A" in `ERI_Results.csv`.
-- Allow JSON output files instead of CSV via a new `--output-format JSON` commandline argument.
-- Updates to ZERH Single Family v2 windows SHGC in climate zone 4 through 8.
+- Updates to OpenStudio 3.7.0/EnergyPlus 23.2.
+- **Breaking change**: Updates to HPXML v4.0-rc2:
+  - HPXML namespace changed from http://hpxmlonline.com/2019/10 to http://hpxmlonline.com/2023/09.
+  - Replaces "living space" with "conditioned space", which better represents what is modeled.
+  - Replaces `PortableHeater` and `FixedHeater` with `SpaceHeater`.
+- HVAC updates:
+  - Updated assumptions for variable-speed air conditioners, heat pumps, and mini-splits based on NEEP data. Expect results to change, potentially significantly so depending on the scenario.
+  - Updates deep ground temperatures (used for modeling ground-source heat pumps) using L. Xing's simplified design model (2014).
+  - Replaces inverse calculations, used to calculate COPs from rated efficiencies, with regressions for single/two-speed central ACs and ASHPs.
+- Output updates:
+  - **Breaking change**: Disaggregates "EC_x Vent" and "EC_x Dehumid" from "EC_x L&A" in `ERI_Results.csv`.
+  - Adds "Peak Electricity: Annual Total (W)" output.
 - Relaxes requirements for some inputs:
   - `SolarAbsorptance` and `Emittance` now only required for *exterior* walls & rim joists (i.e., ExteriorAdjacentTo=outside).
   - `Window/PerformanceClass` no longer required (defaults to "residential").
+  - Allows above-grade basements/crawlspaces defined solely with Wall (not FoundationWall) elements.
+- Updates to ZERH Single Family v2 windows SHGC in climate zone 4 through 8.
+- Allow JSON output files instead of CSV via a new `--output-format JSON` commandline argument.
 
 __Bugfixes__
+- Fixes possible "Electricity category end uses do not sum to total" error for a heat pump w/o backup.
+- Fixes error if conditioned basement has `InsulationSpansEntireSlab=true`.
+- Fixes error if heat pump `CompressorLockoutTemperature` == `BackupHeatingLockoutTemperature`.
+- Fixes ground source heat pump fan/pump adjustment to rated efficiency.
+- Fixes missing radiation exchange between window and sky.
+- Minor HVAC design load calculation bugfixes for foundation walls.
 - Fixes `nEC_x` calculation for a fossil fuel water heater w/ UEF entered.
+- Various HVAC sizing bugfixes and improvements.
 
 ## OpenStudio-ERI v1.6.2
 

docs/source/usage_instructions.rst

@@ -6,7 +6,7 @@ Setup
 
 To get started:
 
-#. Either download `OpenStudio 3.6.1 <https://github.com/NREL/OpenStudio/releases/tag/v3.6.1>`_ and install the Command Line Interface/EnergyPlus/C++ API components, or use the `nrel/openstudio docker image <https://hub.docker.com/r/nrel/openstudio>`_.
+#. Either download `OpenStudio 3.7.0 <https://github.com/NREL/OpenStudio/releases/tag/v3.7.0>`_ and install the Command Line Interface/EnergyPlus components, or use the `nrel/openstudio docker image <https://hub.docker.com/r/nrel/openstudio>`_.
 #. Download the `latest release <https://github.com/NREL/OpenStudio-ERI/releases>`_ release.
 
 .. note::