OpenStudio-HPXML v1.3.0
OpenStudio-HPXML version 1.3.0 has been released. The OpenStudio-HPXML workflow uses HPXML building description files to run residential simulations on the Department of Energy's OpenStudio/EnergyPlus building simulation platform.
Two packages are available, a minimal zip with a handful of weather files and full zip with all US TMY3 weather files. OpenStudio-HPXML v1.3.0 uses OpenStudio v3.3.0, EnergyPlus v9.6.0, and a proposed HPXML v4.0. Please visit the OpenStudio-HPXML v1.3.0 documentation for instructions on how to get started, how to generate an appropriate HPXML file, etc.
New Features
- Updates to OpenStudio 3.3.0/EnergyPlus 9.6.0.
- Breaking change: Replaces "Unmet Load" outputs with "Unmet Hours".
- Breaking change: Renames "Load: Heating" and "Peak Load: Heating" (and Cooling) outputs to include "Delivered".
- Breaking change: Any heat pump backup heating requires
HeatPump/BackupType
("integrated" or "separate") to be specified. - Breaking change: For homes with multiple PV arrays, all inverter efficiencies must have the same value.
- Breaking change: HPXML schema version must now be '4.0' (proposed).
- Moves
ClothesDryer/extension/IsVented
toClothesDryer/Vented
. - Moves
ClothesDryer/extension/VentedFlowRate
toClothesDryer/VentedFlowRate
. - Moves
FoundationWall/Insulation/Layer/extension/DistanceToTopOfInsulation
toFoundationWall/Insulation/Layer/DistanceToTopOfInsulation
. - Moves
FoundationWall/Insulation/Layer/extension/DistanceToBottomOfInsulation
toFoundationWall/Insulation/Layer/DistanceToBottomOfInsulation
. - Moves
Slab/PerimeterInsulationDepth
toSlab/PerimeterInsulation/Layer/InsulationDepth
. - Moves
Slab/UnderSlabInsulationWidth
toSlab/UnderSlabInsulation/Layer/InsulationWidth
. - Moves
Slab/UnderSlabInsulationSpansEntireSlab
toSlab/UnderSlabInsulation/Layer/InsulationSpansEntireSlab
.
- Moves
- Initial release of BuildResidentialHPXML measure, which generates an HPXML file from a set of building description inputs.
- Expanded capabilities for scheduling:
- Allows modeling detailed occupancy via a schedule CSV file.
- Introduces a measure for automatically generating detailed smooth/stochastic schedule CSV files.
- Expands simplified weekday/weekend/monthly schedule inputs to additional building features.
- Allows
HeatingSeason
&CoolingSeason
to be specified for defining heating and cooling equipment availability.
- Adds a new results_hpxml.csv output file to summarize HPXML values (e.g., surface areas, HVAC capacities).
- Allows modeling lithium ion batteries.
- Allows use of
HeatPump/BackupSystem
for modeling a standalone (i.e., not integrated) backup heating system. - Allows conditioned crawlspaces to be specified; modeled as crawlspaces that are actively maintained at setpoint.
- Allows non-zero refrigerant charge defect ratios for ground source heat pumps.
- Expands choices allowed for
Siding
(Wall/RimJoist) andRoofType
(Roof) elements. - Allows "none" for wall/rim joist siding.
- Allows interior finish inputs (e.g., 0.5" drywall) for walls, ceilings, and roofs.
- Allows specifying the foundation wall type (e.g., solid concrete, concrete block, wood, etc.).
- Allows additional fuel types for generators.
- Switches to the EnergyPlus Fan:SystemModel object for all HVAC systems.
- Introduces a small amount of infiltration for unvented spaces.
- Updates the assumption of flue losses vs tank losses for higher efficiency non-electric storage water heaters.
- Revises shared mechanical ventilation preconditioning control logic to operate less often.
- Adds alternative inputs:
- Window/skylight physical properties (
GlassLayers
,FrameType
, etc.) instead ofUFactor
&SHGC
. Ducts/FractionDuctArea
instead ofDucts/DuctSurfaceArea
.Length
instead ofArea
for foundation walls.Orientation
instead ofAzimuth
for all applicable surfaces, PV systems, and solar thermal systems.- CEER (Combined Energy Efficiency Ratio) instead of EER for room ACs.
UsageBin
instead ofFirstHourRating
(for water heaters w/ UEF metric).CFM50
instead ofCFM25
orPercent
for duct leakage.
- Window/skylight physical properties (
- Allows more defaulting (optional inputs):
- Mechanical ventilation airflow rate per ASHRAE 62.2-2019.
- HVAC/DHW system efficiency (by age).
- Mechanical ventilation fan power (by type).
- Color (solar absorptance) for walls, roofs, and rim joists.
- Foundation wall distance to top/bottom of insulation.
- Door azimuth.
- Radiant barrier grade.
- Whole house fan airflow rate and fan power.
- Adds more warnings of inputs based on ANSI/BPI 2400 Standard.
- Removes error-check for number of bedrooms based on conditioned floor area, per RESNET guidance.
- Updates the reporting measure to register all outputs from the annual CSV with the OS runner (for use in, e.g., PAT).
- Removes timeseries CSV output columns that are all zeroes to reduce file size and processing time.
- Improves consistency of installation quality calculations for two/variable-speed air source heat pumps and ground source heat pumps.
- Relaxes requirement for heating (or cooling) setpoints so that they are only needed if heating (or cooling) equipment is present.
- Adds an
--ep-input-format
argument to run_simulation.rb to choose epJSON as the EnergyPlus input file format instead of IDF. - Eliminates EnergyPlus warnings related to unused objects or invalid output meters/variables.
- Allows modeling PTAC and PTHP HVAC systems.
- Allows user inputs for partition wall mass and furniture mass.
Bugfixes
- Improves ground reflectance when there is shading of windows/skylights.
- Improves HVAC fan power for central forced air systems.
- Fixes mechanical ventilation compartmentalization area calculation for SFA/MF homes with surfaces with InteriorAdjacentTo==ExteriorAdjacentTo.
- Negative
DistanceToTopOfInsulation
values are now disallowed. - Fixes workflow errors if a
VentilationFan
has zero airflow rate or zero hours of operation. - Fixes duct design load calculations for HPXML files with multiple ducted HVAC systems.
- Fixes ground source heat pump rated airflow.
- Relaxes
Overhangs
DistanceToBottomOfWindow vs DistanceToBottomOfWindow validation when Depth is zero. - Fixes possibility of double-counting HVAC distribution losses if an
HVACDistribution
element has both AirDistribution properties and DSE values - Fixes possibility of incorrect "Peak Electricity: Winter Total (W)" and "Peak Electricity: Summer Total (W)" outputs for homes with duct losses.
- Fixes heating/cooling seasons (used for e.g. summer vs winter window shading) for the southern hemisphere.
- Fixes possibility of EnergyPlus simulation failure for homes with ground-source heat pumps and airflow and/or charge defects.
- Fixes peak load/electricity outputs for homes with ground-source heat pumps and airflow and/or charge defects.