Skip to content

Commit 9d7f612

Browse files
authored
Merge pull request #807 from NatLabRockies/latest-os-hpxml
Latest OS-HPXML
2 parents ebc4c45 + 3d82c78 commit 9d7f612

65 files changed

Lines changed: 244 additions & 203 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ concurrency:
1717
env:
1818
OS_VERSION: "3.11.0"
1919
OS_SHA: 241b8abb4d
20-
OS_URL: https://github.com/NREL/OpenStudio/releases/download
20+
OS_URL: https://github.com/NatLabRockies/OpenStudio/releases/download
2121

2222
jobs:
2323
run-ruleset-tests:
@@ -197,7 +197,7 @@ jobs:
197197
merge-multiple: true
198198

199199
- name: Delete artifacts
200-
uses: geekyeggo/delete-artifact@v5
200+
uses: geekyeggo/delete-artifact@v6
201201
with:
202202
name: test_results_*
203203

Changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -634,7 +634,7 @@ __Bugfixes__
634634
__Breaking changes__
635635
- OpenStudio version 2.9.1 is now required.
636636
- The `--hourly-output` argument now only generates hourly output for the Reference/Rated Homes, not the IAD Homes, for faster runtime.
637-
- Foundation walls described with the `Insulation/Layer` approach now require two layers (i.e., interior and exterior). (Foundation walls described using the `Insulation/AssemblyEffectiveRValue` approach are unchanged.) See [here](https://github.com/NREL/OpenStudio-HPXML/pull/120) for more information.
637+
- Foundation walls described with the `Insulation/Layer` approach now require two layers (i.e., interior and exterior). (Foundation walls described using the `Insulation/AssemblyEffectiveRValue` approach are unchanged.) See [here](https://github.com/NatLabRockies/OpenStudio-HPXML/pull/120) for more information.
638638

639639
__New Features__
640640
- Runtime performance improvements for all buildings.

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
OpenStudio®-ERI
22
==============
33

4-
[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/NREL/OpenStudio-ERI?include_prereleases)](https://github.com/NREL/OpenStudio-ERI/releases)
5-
[![ci](https://github.com/NREL/OpenStudio-ERI/actions/workflows/config.yml/badge.svg?branch=master)](https://github.com/NREL/OpenStudio-ERI/actions/workflows/config.yml)
4+
[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/NatLabRockies/OpenStudio-ERI?include_prereleases)](https://github.com/NatLabRockies/OpenStudio-ERI/releases)
5+
[![ci](https://github.com/NatLabRockies/OpenStudio-ERI/actions/workflows/config.yml/badge.svg?branch=master)](https://github.com/NatLabRockies/OpenStudio-ERI/actions/workflows/config.yml)
66
[![Documentation Status](https://readthedocs.org/projects/openstudio-eri/badge/?version=latest)](https://openstudio-eri.readthedocs.io/en/latest/?badge=latest)
77

88

99
The OpenStudio-ERI project allows calculating an Energy Rating Index (ERI) using the Department of Energy's [EnergyPlus™](https://energyplus.net/) simulation platform.
10-
The building description is provided in an [HPXML file](https://hpxml.nrel.gov/) format.
10+
The building description is provided in an [HPXML file](https://hpxml.nlr.gov/) format.
1111
OpenStudio-ERI is intended to be used by user interfaces or other automated software workflows that automatically produce the HPXML file.
1212

1313
The project supports:
@@ -18,7 +18,7 @@ The project supports:
1818

1919
For more information on running simulations, generating HPXML files, etc., please visit the [documentation](https://openstudio-eri.readthedocs.io/en/latest).
2020

21-
OpenStudio-ERI uses [OpenStudio-HPXML](https://github.com/NREL/OpenStudio-HPXML) to run the individual EnergyPlus simulations.
21+
OpenStudio-ERI uses [OpenStudio-HPXML](https://github.com/NatLabRockies/OpenStudio-HPXML) to run the individual EnergyPlus simulations.
2222
A high-level workflow diagram is shown below:
2323

2424
![Image](https://github.com/user-attachments/assets/9212f9ff-a1a3-4c9b-8b2e-09296a1d1b0b)
@@ -32,12 +32,12 @@ OpenStudio-ERI is used by a number of software products or organizations, includ
3232
- [HouseRater](https://www.houserater.com)
3333
- [REM/Rate™](https://www.remrate.com)
3434

35-
Are you using OpenStudio-ERI and want to be mentioned here? [Email us](mailto:scott.horowitz@nrel.gov) or [open a Pull Request](https://github.com/NREL/OpenStudio-ERI/edit/master/README.md).
35+
Are you using OpenStudio-ERI and want to be mentioned here? [Email us](mailto:scott.horowitz@nlr.gov) or [open a Pull Request](https://github.com/NatLabRockies/OpenStudio-ERI/edit/master/README.md).
3636

3737
## License
3838

3939
This workflow is available under a BSD-3-like license, which is a free, open-source, and permissive license.
40-
For more information, check out the [license file](https://github.com/NREL/OpenStudio-ERI/blob/master/LICENSE.md).
40+
For more information, check out the [license file](https://github.com/NatLabRockies/OpenStudio-ERI/blob/master/LICENSE.md).
4141

4242
## Disclaimer
4343

docs/source/intro.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Introduction
22
============
33

44
The OpenStudio-ERI project allows calculating an Energy Rating Index (ERI) using the Department of Energy's open-source `OpenStudio <https://www.openstudio.net/>`_/`EnergyPlus <https://energyplus.net/>`_ simulation platform.
5-
The building description is provided in an `HPXML file <https://hpxml.nrel.gov/>`_ format.
5+
The building description is provided in an `HPXML file <https://hpxml.nlr.gov/>`_ format.
66

77
The project supports:
88

@@ -14,7 +14,7 @@ The project supports:
1414
License
1515
-------
1616

17-
This workflow is available under a BSD-3-like license, which is a free, open-source, and permissive license. For more information, check out the `license file <https://github.com/NREL/OpenStudio-ERI/blob/master/LICENSE.md>`_.
17+
This workflow is available under a BSD-3-like license, which is a free, open-source, and permissive license. For more information, check out the `license file <https://github.com/NatLabRockies/OpenStudio-ERI/blob/master/LICENSE.md>`_.
1818

1919
Disclaimer
2020
----------

docs/source/packaging.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ First, OpenStudio must be available.
1212
Web applications may wish to use the `nrel/openstudio docker image <https://hub.docker.com/r/nrel/openstudio>`_.
1313
Alternatively, the OpenStudio installer can be executed on the web server -- only the EnergyPlus and Command Line Interface (CLI) components are required.
1414

15-
Then grab the latest `OpenStudio-ERI release <https://github.com/NREL/OpenStudio-ERI/releases>`_.
15+
Then grab the latest `OpenStudio-ERI release <https://github.com/NatLabRockies/OpenStudio-ERI/releases>`_.
1616

1717
Desktop Applications
1818
--------------------
@@ -23,4 +23,4 @@ First, OpenStudio must be bundled -- only the EnergyPlus and Command Line Interf
2323
Either the OpenStudio setup file can be automatically run as part of your install, or the OpenStudio application can be installed to a local computer and its contents can be re-bundled in your installer (there are no external dependencies required).
2424
The only required OpenStudio contents are the ``openstudio/bin`` and ``openstudio/EnergyPlus`` directories.
2525

26-
Then grab the latest `OpenStudio-ERI release <https://github.com/NREL/OpenStudio-ERI/releases>`_.
26+
Then grab the latest `OpenStudio-ERI release <https://github.com/NatLabRockies/OpenStudio-ERI/releases>`_.

docs/source/usage_instructions.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Setup
66

77
To get started:
88

9-
#. Either download `OpenStudio 3.11.0 <https://github.com/NREL/OpenStudio/releases/tag/v3.11.0>`_ and install the Command Line Interface/EnergyPlus components, or use the `nrel/openstudio docker image <https://hub.docker.com/r/nrel/openstudio>`_.
10-
#. Download the `latest release <https://github.com/NREL/OpenStudio-ERI/releases>`_ release.
9+
#. Either download `OpenStudio 3.11.0 <https://github.com/NatLabRockies/OpenStudio/releases/tag/v3.11.0>`_ and install the Command Line Interface/EnergyPlus components, or use the `nrel/openstudio docker image <https://hub.docker.com/r/nrel/openstudio>`_.
10+
#. Download the `latest release <https://github.com/NatLabRockies/OpenStudio-ERI/releases>`_ release.
1111

1212
.. note::
1313

docs/source/workflow_inputs.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Workflow Inputs
66
Introduction
77
------------
88

9-
OpenStudio-ERI requires a building description in an `HPXML file <https://hpxml.nrel.gov/>`_ format.
9+
OpenStudio-ERI requires a building description in an `HPXML file <https://hpxml.nlr.gov/>`_ format.
1010
HPXML is an open data standard for collecting and transferring home energy data.
1111
Using HPXML files reduces the complexity and effort for software developers to leverage the EnergyPlus simulation engine.
1212

@@ -244,7 +244,7 @@ Each fuel type available to the building is entered in ``/HPXML/Building/Buildin
244244
``Fuel`` string See [#]_ Yes Fuel name
245245
======== ======== ======= =========== ======== ======= ============================
246246

247-
.. [#] Fuel choices can be found at the `HPXML Toolbox website <https://hpxml.nrel.gov/datadictionary/3.0.0/Building/BuildingDetails/BuildingSummary/Site/FuelTypesAvailable/Fuel>`_.
247+
.. [#] Fuel choices can be found at the `HPXML Toolbox website <https://hpxml.nlr.gov/datadictionary/latest/Building/BuildingDetails/BuildingSummary/Site/FuelTypesAvailable/Fuel>`_.
248248
249249
.. note::
250250

@@ -2486,7 +2486,7 @@ A simple solar hot water system is entered as a ``/HPXML/Building/BuildingDetail
24862486
==================== ======= ===== ============ ======== ======== ======================
24872487

24882488
.. [#] Portion of total conventional hot water heating load (delivered energy plus tank standby losses).
2489-
Can be obtained from `Directory of SRCC OG-300 Solar Water Heating System Ratings <https://solar-rating.org/programs/og-300-program/>`_ or NREL's `System Advisor Model <https://sam.nrel.gov/>`_ or equivalent.
2489+
Can be obtained from `Directory of SRCC OG-300 Solar Water Heating System Ratings <https://solar-rating.org/programs/og-300-program/>`_ or NLR's `System Advisor Model <https://sam.nlr.gov/>`_ or equivalent.
24902490
.. [#] ConnectedTo must reference a ``WaterHeatingSystem``.
24912491
The referenced water heater cannot be a space-heating boiler nor attached to a desuperheater.
24922492
.. [#] If ConnectedTo not provided, solar fraction will apply to all water heaters in the building.
@@ -2529,7 +2529,7 @@ HPXML Photovoltaics
25292529

25302530
Each solar electric photovoltaic (PV) system is entered as a ``/HPXML/Building/BuildingDetails/Systems/Photovoltaics/PVSystem``.
25312531

2532-
Many of the inputs are adopted from the `PVWatts model <https://pvwatts.nrel.gov>`_.
2532+
Many of the inputs are adopted from the `PVWatts model <https://pvwatts.nlr.gov/>`_.
25332533

25342534
==================================== ======= ===== ================== ======== ======== ============================================
25352535
Element Type Units Constraints Required Default Notes
@@ -2551,7 +2551,7 @@ Many of the inputs are adopted from the `PVWatts model <https://pvwatts.nrel.gov
25512551
.. [#] ModuleType choices are "standard", "premium", or "thin film".
25522552
.. [#] Tracking choices are "fixed", "1-axis", "1-axis backtracked", or "2-axis".
25532553
.. [#] System losses due to soiling, shading, snow, mismatch, wiring, degradation, etc.
2554-
Default from the `PVWatts documentation <https://www.nrel.gov/docs/fy14osti/62641.pdf>`_ is 0.14, which breaks down as follows.
2554+
Default from the `PVWatts documentation <https://docs.nlr.gov/docs/fy14osti/62641.pdf>`_ is 0.14, which breaks down as follows.
25552555
Note that the total loss (14%) is not the sum of the individual losses but is calculated by multiplying the reduction due to each loss.
25562556
25572557
\- **Soiling**: 2%

hpxml-measures/.github/workflows/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ jobs:
170170
merge-multiple: true
171171

172172
- name: Delete artifacts
173-
uses: geekyeggo/delete-artifact@v5
173+
uses: geekyeggo/delete-artifact@v6
174174
with:
175175
name: results-*
176176

@@ -264,7 +264,7 @@ jobs:
264264
if [[ $(git diff --cached --exit-code) ]]; then
265265
git config --global user.email "github-action@users.noreply.github.com"
266266
git config --global user.name "GitHub Action"
267-
git commit -m "Latest results."
267+
git commit -m "Latest results. [skip ci]"
268268
echo "Pushing to branch: $branch_name"
269269
git push -u origin $branch_name
270270
fi

hpxml-measures/BuildResidentialHPXML/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1220,7 +1220,7 @@ The location of the water heater. Defaults based on the foundation/garage type.
12201220

12211221
- **Required:** ``false``
12221222

1223-
- **Choices:** <br/> - `Default`<br/> - `Conditioned Space`<br/> - `Basement`<br/> - `Garage`<br/> - `Crawlspace`<br/> - `Attic`<br/> - `Other Heated Space`<br/> - `Outside`
1223+
- **Choices:** <br/> - `Default`<br/> - `Conditioned Space`<br/> - `Basement`<br/> - `Garage`<br/> - `Crawlspace`<br/> - `Attic`<br/> - `SFA/MF Other Heated Space`<br/> - `Outside`
12241224

12251225

12261226
- **Default:** `Default`

hpxml-measures/BuildResidentialHPXML/measure.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<schema_version>3.1</schema_version>
44
<name>build_residential_hpxml</name>
55
<uid>a13a8983-2b01-4930-8af2-42030b6e4233</uid>
6-
<version_id>d78d122b-6e59-4fde-af8a-1708240ade46</version_id>
7-
<version_modified>2026-03-26T20:59:07Z</version_modified>
6+
<version_id>a388db27-a2f7-4811-8d2e-95ba875a8820</version_id>
7+
<version_modified>2026-04-02T19:43:52Z</version_modified>
88
<xml_checksum>2C38F48B</xml_checksum>
99
<class_name>BuildResidentialHPXML</class_name>
1010
<display_name>HPXML Builder</display_name>
@@ -6939,8 +6939,8 @@
69396939
<display_name>Attic</display_name>
69406940
</choice>
69416941
<choice>
6942-
<value>Other Heated Space</value>
6943-
<display_name>Other Heated Space</display_name>
6942+
<value>SFA/MF Other Heated Space</value>
6943+
<display_name>SFA/MF Other Heated Space</display_name>
69446944
</choice>
69456945
<choice>
69466946
<value>Outside</value>
@@ -11413,7 +11413,7 @@
1141311413
<filename>README.md</filename>
1141411414
<filetype>md</filetype>
1141511415
<usage_type>readme</usage_type>
11416-
<checksum>75446FA4</checksum>
11416+
<checksum>9F136C7C</checksum>
1141711417
</file>
1141811418
<file>
1141911419
<filename>README.md.erb</filename>
@@ -11562,7 +11562,7 @@
1156211562
<filename>options/dhw_water_heater_location.tsv</filename>
1156311563
<filetype>tsv</filetype>
1156411564
<usage_type>resource</usage_type>
11565-
<checksum>6DD86A53</checksum>
11565+
<checksum>9EC79B81</checksum>
1156611566
</file>
1156711567
<file>
1156811568
<filename>options/electric_vehicle.tsv</filename>

0 commit comments

Comments
 (0)