OpenStudio-HPXML version 1.9.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.9.0 uses OpenStudio v3.9.0, EnergyPlus v24.2.0, and HPXML v4.1-rc1. Please visit the OpenStudio-HPXML v1.9.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.9/EnergyPlus 24.2/HPXML v4.1-rc1.
- Allows
Site/Address/ZipCode
to be provided instead ofClimateandRiskZones/WeatherStation/extension/EPWFilePath
, in which case the closest TMY3 weather station will be automatically selected. - Allows optional inputs for modeling skylight curbs and/or shafts.
- Allows modeling exterior horizontal insulation for a slab-on-grade foundation (or basement/crawlspace floor).
- Allows alternative infiltration input
AirInfiltrationMeasurement/LeakinessDescription
, in which the infiltration level is estimated using age of home, climate zone, foundation type, etc. - Window shading enhancements:
- Allows optional
InteriorShading/Type
input (blinds, shades, curtains) as a way to default summer/winter shading coefficients. - Allows optional
ExteriorShading/Type
input (trees, solar screens/films, etc.) as a way to default summer/winter shading coefficients. - Allows optional
InsectScreen
input.
- Allows optional
- Adds optional
BuildingConstruction/UnitHeightAboveGrade
input for, e.g., apartment units of upper levels where the wind speed, and thus infiltration rate, is higher. - Updates operational calculations (i.e., when
NumberofResidents
provided):- Updates hot water usage based on FSEC study.
- Updates misc/tv plug load usage based on RECS 2020 data.
- Updates relationship between number of bedrooms and number of occupants to use RECS 2020 instead of RECS 2015.
- Allows optional
HeatingCapacity
andBackupHeatingCapacity
inputs for heat pump water heaters (HPWHs). - Central Fan Integrated Supply (CFIS) mechanical ventilation enhancements:
- Allows CFIS systems without automatic flow control of outdoor air (
CFISControls/HasOutdoorAirControl=false
). - Allows CFIS systems with no strategy to meet remainder of ventilation target (
CFISControls/AdditionalRuntimeOperatingMode="none"
). - Allows CFIS systems with supplemental fans that run simultaneously with the air handler (
CFISControls/extension/SupplementalFanRunsWithAirHandlerFan=true
). - Allows CFIS systems with timer control, in which ventilation operation occurs at a fixed interval (
CFISControls/extension/ControlType="timer"
). - Allows CFIS systems to be attached to ductless HVAC systems like PTHPs (requires using a DSE=1 distribution system, see documentation).
- Allows CFIS systems without automatic flow control of outdoor air (
- HVAC Manual J design load and sizing calculations:
- Adds optional
DistributionSystemType/AirDistribution/extension/ManualJInputs/BlowerFanHeatBtuh
input for HVAC equipment whose performance data has not been adjusted for blower heat. - Adds optional
DistributionSystemType/AirDistribution/extension/ManualJInputs/DefaultTableDuctLoad
input to use Manual J default duct factor tables instead of ASHRAE 152. - Adds optional
DistributionSystemType/HydronicDistribution/extension/ManualJInputs/HotWaterPipingBtuh
input to include hydronic distribution piping losses through unconditioned spaces. - Adds optional
HVACSizingControl/ManualJInputs/InfiltrationShieldingClass
input to specify wind shielding class for infiltration design load calculations. - Adds optional
HVACSizingControl/ManualJInputs/InfiltrationMethod
input to specify which method to use for infiltration design load calculations. - Updates heat pump HERS sizing methodology to better prevent unmet hours in warmer climates.
- Misc Manual J design load calculation improvements.
- Breaking change: Disaggregates "Walls" into "Above Grade Walls" and "Below Grade Walls" in results_design_load_details.csv output file.
- Significant speed improvements when using optional space-level design load calculations.
- Adds optional
- Advanced research features:
- Optional input
SimulationControl/AdvancedResearchFeatures/OnOffThermostatDeadbandTemperature
to model on/off thermostat deadband with start-up degradation for single and two speed AC/ASHP systems and time-based realistic staging for two speed AC/ASHP systems. - Optional input
SimulationControl/AdvancedResearchFeatures/HeatPumpBackupCapacityIncrement
to model multi-stage electric backup coils with time-based staging. - Maximum power ratio detailed schedule for variable-speed HVAC systems can now be used with
NumberofUnits
dwelling unit multiplier.
- Optional input
- BuildResidentialHPXML measure:
- Breaking change: Replaced
slab_under_width
andslab_perimeter_depth
arguments withslab_under_insulation_width
andslab_perimeter_insulation_depth
- Breaking change: Replaced
schedules_vacancy_periods
,schedules_power_outage_periods
, andschedules_power_outage_periods_window_natvent_availability
arguments withschedules_unavailable_period_types
,schedules_unavailable_period_dates
, andschedules_unavailable_period_window_natvent_availabilities
; this improves flexibility for handling more unavailable period types.
- Breaking change: Replaced
- Utility bill calculations:
- Allows OpenEI URDB tariffs that have $/day fixed charges.
- Updates
openei_rates.zip
with the latest residential utility rates from the OpenEI U.S. Utility Rate database.
- Adds a warning if the sum of supply/return duct leakage to outside values is very high.
Bugfixes
- Prevents possible error if only one of FracSensible/FracLatent are provided for a PlugLoad or FuelLoad; Breaking change: FracSensible and FracLatent must now be both be provided or omitted.
- Prevents possible error when using multiple
Attic
/Foundation
elements for the same attic/foundation type. - Adds error-checking for
NumberofConditionedFloorsAboveGrade
=0, which is not allowed per the documentation. - Fixes utility bill calculations if there is battery storage or a generator.
- BuildResidentialScheduleFile measure: Fixes possible divide by zero error during generation of stochastic clothes washer and dishwasher schedules.
- Allows negative values for
Building/Site/Elevation
. - Fixes lower element height for a water heater using the advanced
WaterHeatingSystem/extension/TankModelType=stratified
. - Fixes possible error for a combi boiler system.
- Fixes error if modeling a ground-to-air heat pump with a separate backup heating system.
- Fixes default CFIS fan power during ventilation only mode.
- Fixes a bug that potentially oversizes heat pumps when detailed performance capacity fractions are provided.
- For a CFIS system with a supplemental fan, fixes supplemental fan runtime when using sub-hourly timesteps.
- Fixes GSHP rated fan/pump powers in net to gross calculations and improves default modeled pump power (W/ton).