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

Latest OS-HPXML

.github/workflows/config.yml

@@ -11,7 +11,7 @@ jobs:
   run-ruleset-tests:
     runs-on: ubuntu-22.04
     container:
-      image: docker://nrel/openstudio:3.8.0
+      image: docker://nrel/openstudio:dev-3.9.0-rc1
     steps:
       - uses: actions/checkout@v4
         with:
@@ -62,7 +62,7 @@ jobs:
   run-sample-files1-tests:
     runs-on: ubuntu-22.04
     container:
-      image: docker://nrel/openstudio:3.8.0
+      image: docker://nrel/openstudio:dev-3.9.0-rc1
     steps:
       - uses: actions/checkout@v4
         with:
@@ -85,7 +85,7 @@ jobs:
   run-sample-files2-tests:
     runs-on: ubuntu-22.04
     container:
-      image: docker://nrel/openstudio:3.8.0
+      image: docker://nrel/openstudio:dev-3.9.0-rc1
     steps:
       - uses: actions/checkout@v4
         with:
@@ -108,7 +108,7 @@ jobs:
   run-real-home-tests:
     runs-on: ubuntu-22.04
     container:
-      image: docker://nrel/openstudio:3.8.0
+      image: docker://nrel/openstudio:dev-3.9.0-rc1
     steps:
       - uses: actions/checkout@v4
         with:
@@ -131,7 +131,7 @@ jobs:
   run-other-tests:
     runs-on: ubuntu-22.04
     container:
-      image: docker://nrel/openstudio:3.8.0
+      image: docker://nrel/openstudio:dev-3.9.0-rc1
     steps:
       - uses: actions/checkout@v4
         with:
@@ -160,8 +160,8 @@ jobs:
       - name: Install software and run test
         shell: pwsh
         run: |
-          $env:OS_VERSION="3.8.0"
-          $env:OS_SHA="f953b6fcaf"
+          $env:OS_VERSION="3.9.0-rc1"
+          $env:OS_SHA="fb69e5479c"
           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 --daily ALL --add-component-loads --diagnostic-output

Changelog.md

@@ -1,10 +1,26 @@
 ## OpenStudio-ERI v1.9.0
 
 __New Features__
+- Updates to OpenStudio 3.9/EnergyPlus 24.2/HPXML v4.0 final release.
+- Adds 2024 IECC ERI pathway calculation.
+- **Breaking change**: Renamed `Emissions: <EmissionsType>: RESNET: XXX` to `Emissions: <EmissionsType>: ANSI301: XXX` in Annual Home CSV output files.
+- Implements ANSI/RESNET/ICC Standard 301-2022 Addendum E for CFIS systems.
+  - `ERICalculation/Version` and `CO2IndexCalculation/Version` can now be "2022CE".
+  - **Breaking change**: Removes `FanPower`/`FanPowerDefaulted` and `VentilationOnlyModeAirflowFraction` inputs for CFIS systems.
+  - **Breaking change**: Adds `CFISControls/HasOutdoorAirControl` and `CFISControls/extension/ControlType` inputs for CFIS systems.
+  - Adds choice of "none" for `CFISControls/AdditionalRuntimeOperatingMode` input for CFIS systems.
+  - Adds optional `CFISControls/extension/SupplementalFanRunsWithAirHandlerFan` input for CFIS systems.
 - Adds inputs for modeling skylight curbs and/or shafts.
+- Relaxes IECC climate zone requirements.
+  - IECC climate zone years other than 2006 are now always optional; for programs that use specific IECC climate zone years (e.g., 2021 for ZERH SF 2.0), that year is used if provided, otherwise the next earliest provided year will be used with the assumption that the climate zone has not changed across the years.
+  - See [the documentation](https://openstudio-eri.readthedocs.io/en/latest/workflow_inputs.html#hpxml-climate-zones) for more information.
+- Updates HERS Diagnostic Output to v0.3.0.
 
 __Bugfixes__
 - Adds error-checking for `NumberofConditionedFloorsAboveGrade`=0, which is not allowed per the documentation.
+- Fixes error if a heating system and a heat pump (that only provides cooling) are attached to the same distribution system.
+- Fixes double counting of battery storage losses in ERI calculation; CO2e Index is unaffected.
+- Misc Manual J design load calculation improvements.
 
 ## OpenStudio-ERI v1.8.0
 

docs/source/capabilities.rst

@@ -23,6 +23,7 @@ The following IECC ERI versions are supported:
 - 2015
 - 2018
 - 2021
+- 2024
 
 The following DOE ZERH versions are supported:
 

docs/source/usage_instructions.rst

@@ -6,7 +6,7 @@ Setup
 
 To get started:
 
-#. Either download `OpenStudio 3.8.0 <https://github.com/NREL/OpenStudio/releases/tag/v3.8.0>`_ and install the Command Line Interface/EnergyPlus components, or use the `nrel/openstudio docker image <https://hub.docker.com/r/nrel/openstudio>`_.
+#. Either download `OpenStudio 3.9.0 <https://github.com/NREL/OpenStudio/releases/tag/v3.9.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:: 
@@ -18,31 +18,27 @@ To get started:
 Running Calculations
 --------------------
 
-Run all calculations (e.g., ERI, ENERGY STAR, etc.) on a provided sample HPXML file as follows:
-``openstudio workflow/energy_rating_index.rb -x workflow/sample_files/base.xml``
+| Run all calculations (e.g., ERI, ENERGY STAR, etc.) on a provided sample HPXML file as follows:
+| ``openstudio workflow/energy_rating_index.rb -x workflow/sample_files/base.xml``
 
 Note that all simulations will be executed in parallel if there are sufficient cpus/cores available.
 
 This will generate output as shown below:
 
 .. image:: https://user-images.githubusercontent.com/5861765/178850875-12c90097-e1fd-48c5-888b-db4355d923e8.png
 
-You can also request generation of timeseries output CSV files as part of the calculation by providing one or more timeseries flags (``--hourly``, ``--daily``, or ``--monthly``).
+| You can also request generation of timeseries output CSV files by providing one or more timeseries flags. Some examples:
+| ``openstudio workflow/energy_rating_index.rb -x workflow/sample_files/base.xml --hourly ALL``
+| ``openstudio workflow/energy_rating_index.rb -x workflow/sample_files/base.xml --monthly fuels --monthly temperatures``
 
-For example, to request all possible hourly outputs:
-``openstudio workflow/energy_rating_index.rb -x workflow/sample_files/base.xml --hourly ALL``
+| You can also skip simulations (i.e., just generate the ERI Reference/Rated Home HPXMLs) by using, e.g.:
+| ``openstudio workflow/energy_rating_index.rb -x workflow/sample_files/base.xml --skip-simulation``
 
-Or for example, one or more specific monthly output types can be requested, e.g.:
-``openstudio workflow/energy_rating_index.rb -x workflow/sample_files/base.xml --monthly fuels --monthly temperatures``
+| Or you can request all output files in JSON (instead of CSV) format:
+| ``openstudio workflow/energy_rating_index.rb -x workflow/sample_files/base.xml --output-format json``
 
-You can also skip simulations (i.e., just generate the ERI Reference/Rated Home HPXMLs) by using, e.g.:
-``openstudio workflow/energy_rating_index.rb -x workflow/sample_files/base.xml --skip-simulation``
-
-Or you can request all output files in JSON (instead of CSV) format:
-``openstudio workflow/energy_rating_index.rb -x workflow/sample_files/base.xml --output-format json``
-
-Finally, you can generate a HERS diagnostic output file using, e.g.:
-``openstudio workflow/energy_rating_index.rb -x workflow/sample_files/base.xml --diagnostic-output``
+| Finally, you can generate a HERS diagnostic output file using, e.g.:
+| ``openstudio workflow/energy_rating_index.rb -x workflow/sample_files/base.xml --diagnostic-output``
 
 Run ``openstudio workflow/energy_rating_index.rb -h`` to see all available commands/arguments.