Skip to content

Commit

Permalink
Merge branch 'latest-os-hpxml' of github.com:NREL/OpenStudio-ERI into…
Browse files Browse the repository at this point in the history 
… expose_hvac_detailed_perf_inputs
  • Loading branch information
@bpark1327
bpark1327 committed Mar 6, 2024
2 parents 4d6997a + 791f913 commit 83c9f54
Show file tree
Hide file tree
Showing 66 changed files with 5,457 additions and 2,065 deletions.
1 change: 1 addition & 0 deletions Changelog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ __New Features__
- Allows detailed heating and cooling performance data (min/max COPs and capacities at different outdoor temperatures) for variable-speed systems.

__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
Expand Down
52 changes: 29 additions & 23 deletions docs/source/workflow_inputs.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ For a multifamily building where the dwelling unit has another dwelling unit abo
``Azimuth`` integer deg >= 0, <= 359 No See [#]_ Azimuth (clockwise from North)
``SolarAbsorptance`` double >= 0, <= 1 Yes Solar absorptance
``Emittance`` double >= 0, <= 1 Yes Emittance
``Pitch`` integer ?:12 >= 0 Yes Pitch
``Pitch`` double ?/12 >= 0 Yes Pitch [#]_
``RadiantBarrier`` boolean No false Presence of radiant barrier
``RadiantBarrierGrade`` integer >= 1, <= 3 See [#]_ Radiant barrier installation grade
``Insulation/SystemIdentifier`` id Yes Unique identifier
Expand All @@ -378,6 +378,8 @@ For a multifamily building where the dwelling unit has another dwelling unit abo
See :ref:`hpxmllocations` for descriptions.
.. [#] If Azimuth not provided, and it's a *pitched* roof, modeled as four surfaces of equal area facing every direction.
Azimuth is irrelevant for *flat* roofs.
.. [#] Pitch is entered as vertical rise in inches for every 12 inches of horizontal run.
For example, 6.0 means a 6/12 roof, which has a 26.57-degree roof slope.
.. [#] RadiantBarrierGrade only required if RadiantBarrier=true.
.. [#] AssemblyEffectiveRValue includes all material layers, interior/exterior air films, and insulation installation grade.
Expand Down Expand Up @@ -2715,28 +2717,32 @@ HPXML Locations

The various locations used in an HPXML file are defined as follows:

============================== ================================== ============================================ =============
Value Description Temperature Building Type
============================== ================================== ============================================ =============
outside Ambient environment Weather data Any
ground EnergyPlus calculation Any
conditioned space Above-grade conditioned floor area EnergyPlus calculation Any
attic - vented EnergyPlus calculation Any
attic - unvented EnergyPlus calculation Any
basement - conditioned Below-grade conditioned floor area EnergyPlus calculation Any
basement - unconditioned EnergyPlus calculation Any
crawlspace - vented EnergyPlus calculation Any
crawlspace - unvented EnergyPlus calculation Any
garage Single-family (not shared parking) EnergyPlus calculation Any
other housing unit Unrated Conditioned Space Same as conditioned space SFA/MF only
other heated space Unrated Heated Space Avg of conditioned space/outside; min of 68F SFA/MF only
other multifamily buffer space Multifamily Buffer Boundary Avg of conditioned space/outside; min of 50F SFA/MF only
other non-freezing space Non-Freezing Space Floats with outside; minimum of 40F SFA/MF only
other exterior Water heater outside Weather data Any
exterior wall Ducts in exterior wall Avg of conditioned space/outside Any
under slab Ducts under slab (ground) EnergyPlus calculation Any
roof deck Ducts on roof deck (outside) Weather data Any
============================== ================================== ============================================ =============
============================== ============================================== ============================================ =============
Value Description Temperature Building Type
============================== ============================================== ============================================ =============
outside Ambient environment Weather data Any
ground EnergyPlus calculation Any
conditioned space Above-grade conditioned floor area EnergyPlus calculation Any
attic - vented EnergyPlus calculation Any
attic - unvented EnergyPlus calculation Any
basement - conditioned Below-grade conditioned floor area EnergyPlus calculation Any
basement - unconditioned EnergyPlus calculation Any
crawlspace - vented EnergyPlus calculation Any
crawlspace - unvented EnergyPlus calculation Any
garage Unconditioned garage (not shared parking) [#]_ EnergyPlus calculation Any
other housing unit Unrated Conditioned Space Same as conditioned space SFA/MF only
other heated space Unrated Heated Space Avg of conditioned space/outside; min of 68F SFA/MF only
other multifamily buffer space Multifamily Buffer Boundary Avg of conditioned space/outside; min of 50F SFA/MF only
other non-freezing space Non-Freezing Space Floats with outside; minimum of 40F SFA/MF only
other exterior Water heater outside Weather data Any
exterior wall Ducts in exterior wall Avg of conditioned space/outside Any
under slab Ducts under slab (ground) EnergyPlus calculation Any
roof deck Ducts on roof deck (outside) Weather data Any
============================== ============================================== ============================================ =============

.. [#] OpenStudio-ERI does not model "conditioned" or "heated" garages.
Many conditioned garages are not conditioned 24/7, rather they are only conditioned for short periods when occupants are in them and turn on the space conditioning equipment, so it is best to assume an unconditioned garage.
However, if a garage was converted into livable space, then "conditioned space" should be used instead.
Validating & Debugging Errors
-----------------------------
Expand Down
140 changes: 128 additions & 12 deletions hpxml-measures/BuildResidentialHPXML/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -245,33 +245,33 @@ Diffusivity of the ground soil. If provided, overrides the previous site and moi

<br/>

**Site: Zip Code**
**Site: IECC Zone**

Zip code of the home address.
IECC zone of the home address.

- **Name:** ``site_zip_code``
- **Type:** ``String``
- **Name:** ``site_iecc_zone``
- **Type:** ``Choice``

- **Required:** ``false``

- **Choices:** `1A`, `1B`, `1C`, `2A`, `2B`, `2C`, `3A`, `3B`, `3C`, `4A`, `4B`, `4C`, `5A`, `5B`, `5C`, `6A`, `6B`, `6C`, `7`, `8`

<br/>

**Site: IECC Zone**
**Site: City**

IECC zone of the home address.
City/municipality of the home address.

- **Name:** ``site_iecc_zone``
- **Type:** ``Choice``
- **Name:** ``site_city``
- **Type:** ``String``

- **Required:** ``false``

- **Choices:** `1A`, `1B`, `1C`, `2A`, `2B`, `2C`, `3A`, `3B`, `3C`, `4A`, `4B`, `4C`, `5A`, `5B`, `5C`, `6A`, `6B`, `6C`, `7`, `8`

<br/>

**Site: State Code**

State code of the home address.
State code of the home address. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.7.0/workflow_inputs.html#hpxml-site'>HPXML Site</a>) is used.

- **Name:** ``site_state_code``
- **Type:** ``Choice``
Expand All @@ -282,9 +282,20 @@ State code of the home address.

<br/>

**Site: Zip Code**

Zip code of the home address.

- **Name:** ``site_zip_code``
- **Type:** ``String``

- **Required:** ``false``

<br/>

**Site: Time Zone UTC Offset**

Time zone UTC offset of the home address. Must be between -12 and 14.
Time zone UTC offset of the home address. Must be between -12 and 14. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.7.0/workflow_inputs.html#hpxml-site'>HPXML Site</a>) is used.

- **Name:** ``site_time_zone_utc_offset``
- **Type:** ``Double``
Expand All @@ -295,6 +306,45 @@ Time zone UTC offset of the home address. Must be between -12 and 14.

<br/>

**Site: Elevation**

Elevation of the home address. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.7.0/workflow_inputs.html#hpxml-site'>HPXML Site</a>) is used.

- **Name:** ``site_elevation``
- **Type:** ``Double``

- **Units:** ``ft``

- **Required:** ``false``

<br/>

**Site: Latitude**

Latitude of the home address. Must be between -90 and 90. Use negative values for southern hemisphere. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.7.0/workflow_inputs.html#hpxml-site'>HPXML Site</a>) is used.

- **Name:** ``site_latitude``
- **Type:** ``Double``

- **Units:** ``deg``

- **Required:** ``false``

<br/>

**Site: Longitude**

Longitude of the home address. Must be between -180 and 180. Use negative values for the western hemisphere. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.7.0/workflow_inputs.html#hpxml-site'>HPXML Site</a>) is used.

- **Name:** ``site_longitude``
- **Type:** ``Double``

- **Units:** ``deg``

- **Required:** ``false``

<br/>

**Weather Station: EnergyPlus Weather (EPW) Filepath**

Path of the EPW file.
Expand Down Expand Up @@ -1753,6 +1803,17 @@ The output heating capacity of the heating system. If not provided, the OS-HPXML

<br/>

**Heating System: Heating Autosizing Factor**

The scaling factor applied to the auto-sizing methodology. If not provided, 1.0 is used.

- **Name:** ``heating_system_heating_autosizing_factor``
- **Type:** ``Double``

- **Required:** ``false``

<br/>

**Heating System: Fraction Heat Load Served**

The heating load served by the heating system.
Expand Down Expand Up @@ -1868,6 +1929,17 @@ The output cooling capacity of the cooling system. If not provided, the OS-HPXML

<br/>

**Cooling System: Cooling Autosizing Factor**

The scaling factor applied to the auto-sizing methodology. If not provided, 1.0 is used.

- **Name:** ``cooling_system_cooling_autosizing_factor``
- **Type:** ``Double``

- **Required:** ``false``

<br/>

**Cooling System: Fraction Cool Load Served**

The cooling load served by the cooling system.
Expand Down Expand Up @@ -2083,6 +2155,17 @@ The output heating capacity of the heat pump. If not provided, the OS-HPXML auto

<br/>

**Heat Pump: Heating Autosizing Factor**

The scaling factor applied to the auto-sizing methodology. If not provided, 1.0 is used.

- **Name:** ``heat_pump_heating_autosizing_factor``
- **Type:** ``Double``

- **Required:** ``false``

<br/>

**Heat Pump: Heating Capacity Retention Fraction**

The output heating capacity of the heat pump at a user-specified temperature (e.g., 17F or 5F) divided by the above nominal heating capacity. Applies to all heat pump types except ground-to-air. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.7.0/workflow_inputs.html#air-to-air-heat-pump'>Air-to-Air Heat Pump</a>, <a href='https://openstudio-hpxml.readthedocs.io/en/v1.7.0/workflow_inputs.html#mini-split-heat-pump'>Mini-Split Heat Pump</a>, <a href='https://openstudio-hpxml.readthedocs.io/en/v1.7.0/workflow_inputs.html#packaged-terminal-heat-pump'>Packaged Terminal Heat Pump</a>, <a href='https://openstudio-hpxml.readthedocs.io/en/v1.7.0/workflow_inputs.html#room-air-conditioner-w-reverse-cycle'>Room Air Conditioner w/ Reverse Cycle</a>) is used.
Expand Down Expand Up @@ -2122,6 +2205,17 @@ The output cooling capacity of the heat pump. If not provided, the OS-HPXML auto

<br/>

**Heat Pump: Cooling Autosizing Factor**

The scaling factor applied to the auto-sizing methodology. If not provided, 1.0 is used.

- **Name:** ``heat_pump_cooling_autosizing_factor``
- **Type:** ``Double``

- **Required:** ``false``

<br/>

**Heat Pump: Fraction Heat Load Served**

The heating load served by the heat pump.
Expand Down Expand Up @@ -2174,6 +2268,17 @@ The backup type of the heat pump. If 'integrated', represents e.g. built-in elec

<br/>

**Heat Pump: Backup Heating Autosizing Factor**

The scaling factor applied to the auto-sizing methodology if Backup Type is 'integrated'. If not provided, 1.0 is used. If Backup Type is 'separate', use Heating System 2: Heating Autosizing Factor.

- **Name:** ``heat_pump_backup_heating_autosizing_factor``
- **Type:** ``Double``

- **Required:** ``false``

<br/>

**Heat Pump: Backup Fuel Type**

The backup fuel type of the heat pump. Only applies if Backup Type is 'integrated'.
Expand Down Expand Up @@ -2605,6 +2710,17 @@ The output heating capacity of the second heating system. If not provided, the O

<br/>

**Heating System 2: Heating Autosizing Factor**

The scaling factor applied to the auto-sizing methodology. If not provided, 1.0 is used.

- **Name:** ``heating_system_2_heating_autosizing_factor``
- **Type:** ``Double``

- **Required:** ``false``

<br/>

**Heating System 2: Fraction Heat Load Served**

The heat load served fraction of the second heating system. Ignored if this heating system serves as a backup system for a heat pump.
Expand Down
Loading

0 comments on commit 83c9f54

Please sign in to comment.