OpenStudio-HPXML v1.6.0
OpenStudio-HPXML version 1.6.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.
OpenStudio-HPXML v1.6.0 uses OpenStudio v3.6.1, EnergyPlus v23.1.0, and a proposed HPXML v4.0. Please visit the OpenStudio-HPXML v1.6.0 documentation for instructions on how to get started, how to generate an appropriate HPXML file, etc. The full set of US TMY3 weather files can be obtained from here.
New Features
- Updates to OpenStudio 3.6.1/EnergyPlus 23.1.
- Updates to newer proposed HPXML v4.0:
- Breaking change: Replaces
VentilationFan/Quantity
andCeilingFan/Quantity
withCount
. - Breaking change: Replaces
PVSystem/InverterEfficiency
withPVSystem/AttachedToInverter
andInverter/InverterEfficiency
. - Breaking change: Replaces
WaterHeatingSystem/extension/OperatingMode
withWaterHeatingSystem/HPWHOperatingMode
for heat pump water heaters.
- Breaking change: Replaces
- Output updates:
- Breaking change: Adds
End Use: Heating Heat Pump Backup Fans/Pumps
(disaggregated fromEnd Use: Heating Fans/Pumps
). - Breaking change: Replaces
Component Load: Windows
withComponent Load: Windows Conduction
andComponent Load: Windows Solar
. - Breaking change: Replaces
Component Load: Skylights
withComponent Load: Skylights Conduction
andComponent Load: Skylights Solar
. - Breaking change: Adds
Component Load: Lighting
(disaggregated fromComponent Load: Internal Gains
). - Breaking change: Adds "net" values for emissions; "total" values now exclude generation (e.g., PV).
- Adds
Load: Heating: Heat Pump Backup
(heating load delivered by heat pump backup systems). - Adds
System Use
outputs (end use outputs for each heating, cooling, and water heating system); allows requesting timeseries output. - All annual load outputs are now provided as timeseries outputs; previously only "Delivered" loads were available.
- Peak summer/winter electricity outputs are now based on Jun/July/Aug and Dec/Jan/Feb months, not HVAC heating/cooling operation.
- Allows specifying the number of decimal places for timeseries output.
- Msgpack outputs are no longer rounded (since there is no file size penalty to storing full precision).
- Annual emissions and utility bills now include all fuel/end uses, even if zero.
- ReportSimulationOutput measure: Allows disabling individual annual output sections.
- Breaking change: Adds
- Breaking change: Deprecates
OccupancyCalculationType
("asset" or "operational").- If
NumberofResidents
not provided, an asset calculation is performed assuming standard occupancy per ANSI/RESNET/ICC 301. - If
NumberofResidents
is provided, an operational calculation is performed using a relationship between #Bedrooms and #Occupants from RECS 2015.
- If
- Heat pump enhancements:
- Allows
HeatingCapacityRetention[Fraction | Temperature]
inputs to define cold-climate performance; likeHeatingCapacity17F
but can apply to autosized systems and can use a user-specified temperature. - Default mini-split heating capacity retention updated from 0.4 to 0.5 (at 5 deg-F).
- Allows
CompressorLockoutTemperature
as an optional input to control the minimum temperature the compressor can operate at. - Defaults for
CompressorLockoutTemperature
: 25F for dual-fuel, -20F for mini-split, 0F for all other heat pumps. - Defaults for
BackupHeatingLockoutTemperature
: 50F for dual-fuel, 40F for all other heat pumps. - Provides a warning if
BackupHeatingSwitchoverTemperature
orBackupHeatingLockoutTemperature
are low and may cause unmet hours. - Autosizing is no longer all-or-none; backup heating can be autosized (defaulted) while specifying the heat pump capacities, or vice versa.
- Allows
extension/CrankcaseHeaterPowerWatts
as an optional input; defaults to 50 W for central HPs/ACs and mini-splits. - Increased consistency between variable-speed central HP and mini-split HP models for degradation coefficients, gross SHR calculations, etc.
- Allows
- Infiltration changes:
- Breaking change: Infiltration for SFA/MF dwelling units must include
TypeOfInfiltrationLeakage
("unit total" or "unit exterior only"). - Breaking change: Replaces
BuildingConstruction/extension/HasFlueOrChimney
withAirInfiltration/extension/HasFlueOrChimneyInConditionedSpace
; defaults now incorporate HVAC/water heater location. - Allows infiltration to be specified using
CFMnatural
orEffectiveLeakageArea
.
- Breaking change: Infiltration for SFA/MF dwelling units must include
- Lighting changes:
- LightingGroups can now be specified using kWh/year annual consumption values as an alternative to fractions of different lighting types.
- LightingGroups for interior, exterior, and garage are no longer required; if not provided, these lighting uses will not be modeled.
- HVAC sizing enhancements:
- Allows optional inputs under
HVACSizingControl/ManualJInputs
to override Manual J defaults for HVAC autosizing calculations. - Updates to better align various default values and algorithms with Manual J.
- Updates design load calculations to handle conditioned basements with insulated slabs.
- Allows optional inputs under
- Duct enhancements:
- Allows modeling ducts buried in attic loose-fill insulation using
Ducts/DuctBuriedInsulationLevel
. - Allows specifying
Ducts/DuctEffectiveRValue
, the value that will be used in the model, though its use is not recommended.
- Allows modeling ducts buried in attic loose-fill insulation using
- Allows modeling a pilot light for non-electric heating systems (furnaces, stoves, boilers, and fireplaces).
- Allows summer vs winter shading seasons to be specified for windows and skylights.
- Allows defining one or more
UnavailablePeriods
(e.g., occupant vacancies or power outage periods). - Stochastic schedules for garage lighting and TV plug loads now use interior lighting and miscellaneous plug load schedules, respectively.
- Performance improvement for HPXML files w/ large numbers of
Building
elements. - Weather cache files (*foo-cache.csv) are no longer used/needed.
Bugfixes
- Fixes
BackupHeatingSwitchoverTemperature
for a heat pump w/ separate backup system; now correctly ceases backup operation above this temperature. - Fixes error if calculating utility bills for an all-electric home with a detailed JSON utility rate.
- Stochastic schedules now excludes columns for end uses that are not stochastically generated.
- Fixes operational calculation when the number of residents is set to zero.
- Fixes possible utility bill calculation error for a home with PV using a detailed electric utility rate.
- Fixes defaulted mechanical ventilation flow rate for SFA/MF buildings, with respect to infiltration credit.
- HPXML files w/ multiple
Building
elements now only show warnings for the singleBuilding
being simulated. - Adds a warning for SFA/MF dwelling units without at least one attached wall/ceiling/floor surface.
- Various fixes for window/skylight/duct design loads for Manual J HVAC autosizing calculations.
- Ensure that ductless HVAC systems do not have a non-zero airflow defect ratio specified.
- Fixes possible "A neighbor building has an azimuth (XX) not equal to the azimuth of any wall" for SFA/MF units with neighboring buildings for shade.
- Fixes reported loads when no/partial HVAC system (e.g., room air conditioner that meets 30% of the cooling load).