Skip to content

Commit

Permalink
Merge pull request #597 from NREL/end-use-heating-hp-backup
Browse files Browse the repository at this point in the history 
Latest OS-HPXML
  • Loading branch information
@shorowit
shorowit authored Apr 8, 2022
2 parents 664fed3 + d925e75 commit c801d2f
Show file tree
Hide file tree
Showing 75 changed files with 57,314 additions and 1,372 deletions.
4 changes: 4 additions & 0 deletions Changelog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ __New Features__
- Adds calculation of CO2e Rating Index and CO2e/NOx/SO2 emissions (annual and hourly).
- Adds support for shared hot water recirculation systems controlled by temperature.
- **Breaking change**: `/HPXML/Building/Site` is now required with `Address/StateCode` and `Address/ZipCode` child elements.
- Output changes:
- Adds "Energy Use: Total" and "Energy Use: Net" columns to the ERI____Home.csv output files; allows hourly outputs.
- **Breaking change**: New "End Use: \<Fuel\>: Heating Heat Pump Backup" output, disaggregated from "End Use: \<Fuel\>: Heating".
- **Breaking change**: Deprecates duct leakage to outside exemptions; software tools must provide duct leakage to outside or DSE. `SoftwareInfo/extension/ERICalculation/Version` enumerations "2014ADEGL", "2014ADEG", "2014ADE" are replaced by "2014AEG" and "2014AE".
- Allows modeling an electric storage battery.
- Allows `AirInfiltrationMeasurement/InfiltrationHeight` as an optional input; if not provided, it is inferred from other inputs as before.
Expand All @@ -14,6 +17,7 @@ __New Features__
__Bugfixes__
- Adds more stringent limits for `AirflowDefectRatio` (now allows values from 1/10th to 10x the design value).
- Fixes opaque door R-value in the Reference Home in IECC climate zone 1.
- Hourly output fixes: some outputs off by 1 hour; possible negative combi boiler values.

## OpenStudio-ERI v1.3.0

Expand Down
17 changes: 9 additions & 8 deletions docs/source/workflow_inputs.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1700,14 +1700,15 @@ HPXML Batteries

A single battery can be entered as a ``/HPXML/Building/BuildingDetails/Systems/Batteries/Battery``.

==================================================== ======= ========= =========== ======== ======== ============================================
Element Type Units Constraints Required Default Notes
==================================================== ======= ========= =========== ======== ======== ============================================
``SystemIdentifier`` id Yes Unique identifier
``Location`` string See [#]_ Yes Location
``BatteryType`` string See [#]_ Yes Battery type
``NominalCapacity[Units="kWh"]/Value`` double kWh >= 0 Yes Nominal (not usable) capacity
==================================================== ======= ========= =========== ======== ======== ============================================
==================================================== ======= ========= ======================= ======== ======== ============================================
Element Type Units Constraints Required Default Notes
==================================================== ======= ========= ======================= ======== ======== ============================================
``SystemIdentifier`` id Yes Unique identifier
``Location`` string See [#]_ Yes Location
``BatteryType`` string See [#]_ Yes Battery type
``NominalCapacity[Units="kWh"]/Value`` double kWh >= 0 Yes Nominal (total) capacity
``UsableCapacity[Units="kWh"]/Value`` double kWh >= 0, < NominalCapacity Yes Usable capacity
==================================================== ======= ========= ======================= ======== ======== ============================================

.. [#] Location choices are "living space", "basement - conditioned", "basement - unconditioned", "crawlspace - vented", "crawlspace - unvented", "attic - vented", "attic - unvented", "garage", or "outside".
.. [#] BatteryType only choice is "Li-ion".
Expand Down
132 changes: 70 additions & 62 deletions docs/source/workflow_outputs.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,68 +77,75 @@ End uses are listed below.
Note that all end uses are mutually exclusive -- the "Electricity: Heating" end use, for example, excludes energy reported in the "Electricity: Heating Fans/Pumps" end use.
So the sum of all end uses for a given fuel (e.g., sum of all "End Use: Natural Gas: \*") equal the above reported fuel use (e.g., "Fuel Use: Natural Gas: Total").

========================================================== ====================================================
Type Notes
========================================================== ====================================================
Electricity: Heating (MBtu) Excludes fans/pumps
Electricity: Heating Fans/Pumps (MBtu)
Electricity: Cooling (MBtu) Excludes fans/pumps
Electricity: Cooling Fans/Pumps (MBtu)
Electricity: Hot Water (MBtu) Excludes recirc pump and solar thermal pump
Electricity: Hot Water Recirc Pump (MBtu)
Electricity: Hot Water Solar Thermal Pump (MBtu) Non-zero only when using detailed (not simple) solar thermal inputs
Electricity: Lighting Interior (MBtu)
Electricity: Lighting Garage (MBtu)
Electricity: Lighting Exterior (MBtu)
Electricity: Mech Vent (MBtu) Excludes preheating/precooling
Electricity: Mech Vent Preheating (MBtu) Shared ventilation preconditioning system
Electricity: Mech Vent Precooling (MBtu) Shared ventilation preconditioning system
Electricity: Whole House Fan (MBtu)
Electricity: Refrigerator (MBtu)
Electricity: Dehumidifier (MBtu)
Electricity: Dishwasher (MBtu)
Electricity: Clothes Washer (MBtu)
Electricity: Clothes Dryer (MBtu)
Electricity: Range/Oven (MBtu)
Electricity: Ceiling Fan (MBtu)
Electricity: Television (MBtu)
Electricity: Plug Loads (MBtu) Excludes independently reported plug loads (e.g., well pump)
Electricity: PV (MBtu) Negative value for any power produced
Electricity: Generator (MBtu) Negative value for any power produced
Natural Gas: Heating (MBtu)
Natural Gas: Hot Water (MBtu)
Natural Gas: Clothes Dryer (MBtu)
Natural Gas: Range/Oven (MBtu)
Natural Gas: Mech Vent Preheating (MBtu) Shared ventilation preconditioning system
Natural Gas: Generator (MBtu) Positive value for any fuel consumed
Fuel Oil: Heating (MBtu)
Fuel Oil: Hot Water (MBtu)
Fuel Oil: Clothes Dryer (MBtu)
Fuel Oil: Range/Oven (MBtu)
Fuel Oil: Mech Vent Preheating (MBtu) Shared ventilation preconditioning system
Propane: Heating (MBtu)
Propane: Hot Water (MBtu)
Propane: Clothes Dryer (MBtu)
Propane: Range/Oven (MBtu)
Propane: Mech Vent Preheating (MBtu) Shared ventilation preconditioning system
Propane: Generator (MBtu) Positive value for any fuel consumed
Wood Cord: Heating (MBtu)
Wood Cord: Hot Water (MBtu)
Wood Cord: Clothes Dryer (MBtu)
Wood Cord: Range/Oven (MBtu)
Wood Cord: Mech Vent Preheating (MBtu) Shared ventilation preconditioning system
Wood Pellets: Heating (MBtu)
Wood Pellets: Hot Water (MBtu)
Wood Pellets: Clothes Dryer (MBtu)
Wood Pellets: Range/Oven (MBtu)
Wood Pellets: Mech Vent Preheating (MBtu) Shared ventilation preconditioning system
Coal: Heating (MBtu) Not used by OS-ERI
Coal: Hot Water (MBtu) Not used by OS-ERI
Coal: Clothes Dryer (MBtu) Not used by OS-ERI
Coal: Range/Oven (MBtu) Not used by OS-ERI
Coal: Mech Vent Preheating (MBtu) Not used by OS-ERI
Coal: Generator (MBtu) Not used by OS-ERI
========================================================== ====================================================
=================================================================== ====================================================
Type Notes
=================================================================== ====================================================
End Use: Electricity: Heating (MBtu) Excludes heat pump backup and fans/pumps
End Use: Electricity: Heating Heat Pump Backup (MBtu)
End Use: Electricity: Heating Fans/Pumps (MBtu)
End Use: Electricity: Cooling (MBtu) Excludes fans/pumps
End Use: Electricity: Cooling Fans/Pumps (MBtu)
End Use: Electricity: Hot Water (MBtu) Excludes recirc pump and solar thermal pump
End Use: Electricity: Hot Water Recirc Pump (MBtu)
End Use: Electricity: Hot Water Solar Thermal Pump (MBtu) Non-zero only when using detailed (not simple) solar thermal inputs
End Use: Electricity: Lighting Interior (MBtu)
End Use: Electricity: Lighting Garage (MBtu)
End Use: Electricity: Lighting Exterior (MBtu)
End Use: Electricity: Mech Vent (MBtu) Excludes preheating/precooling
End Use: Electricity: Mech Vent Preheating (MBtu) Shared ventilation preconditioning system
End Use: Electricity: Mech Vent Precooling (MBtu) Shared ventilation preconditioning system
End Use: Electricity: Whole House Fan (MBtu)
End Use: Electricity: Refrigerator (MBtu)
End Use: Electricity: Dehumidifier (MBtu)
End Use: Electricity: Dishwasher (MBtu)
End Use: Electricity: Clothes Washer (MBtu)
End Use: Electricity: Clothes Dryer (MBtu)
End Use: Electricity: Range/Oven (MBtu)
End Use: Electricity: Ceiling Fan (MBtu)
End Use: Electricity: Television (MBtu)
End Use: Electricity: Plug Loads (MBtu) Excludes independently reported plug loads (e.g., well pump)
End Use: Electricity: PV (MBtu) Negative value for any power produced
End Use: Electricity: Generator (MBtu) Negative value for any power produced
End Use: Natural Gas: Heating (MBtu) Excludes heat pump backup
End Use: Natural Gas: Heating Heat Pump Backup (MBtu)
End Use: Natural Gas: Hot Water (MBtu)
End Use: Natural Gas: Clothes Dryer (MBtu)
End Use: Natural Gas: Range/Oven (MBtu)
End Use: Natural Gas: Mech Vent Preheating (MBtu) Shared ventilation preconditioning system
End Use: Natural Gas: Generator (MBtu) Positive value for any fuel consumed
End Use: Fuel Oil: Heating (MBtu) Excludes heat pump backup
End Use: Fuel Oil: Heating Heat Pump Backup (MBtu)
End Use: Fuel Oil: Hot Water (MBtu)
End Use: Fuel Oil: Clothes Dryer (MBtu)
End Use: Fuel Oil: Range/Oven (MBtu)
End Use: Fuel Oil: Mech Vent Preheating (MBtu) Shared ventilation preconditioning system
End Use: Propane: Heating (MBtu) Excludes heat pump backup
End Use: Propane: Heating Heat Pump Backup (MBtu)
End Use: Propane: Hot Water (MBtu)
End Use: Propane: Clothes Dryer (MBtu)
End Use: Propane: Range/Oven (MBtu)
End Use: Propane: Mech Vent Preheating (MBtu) Shared ventilation preconditioning system
End Use: Propane: Generator (MBtu) Positive value for any fuel consumed
End Use: Wood Cord: Heating (MBtu) Excludes heat pump backup
End Use: Wood Cord: Heating Heat Pump Backup (MBtu)
End Use: Wood Cord: Hot Water (MBtu)
End Use: Wood Cord: Clothes Dryer (MBtu)
End Use: Wood Cord: Range/Oven (MBtu)
End Use: Wood Cord: Mech Vent Preheating (MBtu) Shared ventilation preconditioning system
End Use: Wood Pellets: Heating (MBtu) Excludes heat pump backup
End Use: Wood Pellets: Heating Heat Pump Backup (MBtu)
End Use: Wood Pellets: Hot Water (MBtu)
End Use: Wood Pellets: Clothes Dryer (MBtu)
End Use: Wood Pellets: Range/Oven (MBtu)
End Use: Wood Pellets: Mech Vent Preheating (MBtu) Shared ventilation preconditioning system
End Use: Coal: Heating (MBtu) Excludes heat pump backup
End Use: Coal: Heating Heat Pump Backup (MBtu)
End Use: Coal: Hot Water (MBtu) Not used by OS-ERI
End Use: Coal: Clothes Dryer (MBtu) Not used by OS-ERI
End Use: Coal: Range/Oven (MBtu) Not used by OS-ERI
End Use: Coal: Mech Vent Preheating (MBtu) Not used by OS-ERI
End Use: Coal: Generator (MBtu) Not used by OS-ERI
=================================================================== ====================================================

Annual Emissions
^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -292,6 +299,7 @@ Depending on the outputs requested, CSV files may include:
=================================== =====
Type Notes
=================================== =====
Total Consumptions Energy use for building total.
Fuel Consumptions Energy use for each fuel type (in kBtu for fossil fuels and kWh for electricity).
End Use Consumptions Energy use for each end use type (in kBtu for fossil fuels and kWh for electricity).
Emissions Emissions (e.g., CO2e, NOx, SO2), both total and disaggregated by fuel type.
Expand Down
12 changes: 8 additions & 4 deletions hpxml-measures/.github/pull_request_template.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,15 @@

## Checklist

Not all may apply:
PR Author: Check these when they're done. Not all may apply. ~~strikethrough~~ and check any that do not apply.

- [ ] EPvalidator.xml has been updated
- [ ] Tests (and test files) have been updated
PR Reviewer: Verify each has been completed.

- [ ] Schematron validator (`EPvalidator.xml`) has been updated
- [ ] Sample files have been added/updated (via `tasks.rb`)
- [ ] Unit tests have been added/updated (e.g., `HPXMLtoOpenStudio/tests`)
- [ ] Documentation has been updated
- [ ] Changelog has been updated
- [ ] `openstudio tasks.rb update_measures` has been run
- [ ] No unexpected regression test changes on CI (checked comparison artifacts)
- [ ] Checked the code coverage report on CI
- [ ] No unexpected changes to simulation results of sample files
Loading

0 comments on commit c801d2f

Please sign in to comment.