OpenStudio-HPXML v1.10.0

OpenStudio-HPXML v1.10.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.10.0 uses OpenStudio v3.10.0, EnergyPlus v25.1.0, and HPXML v4.2-rc2. Please visit the OpenStudio-HPXML v1.10.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.10/EnergyPlus 25.1/HPXML v4.2-rc2.
• HVAC modeling updates per RESNET HERS Addendum 82:
  • Breaking change: CompressorType required for central and mini-split air conditioners and heat pumps as well as ground-to-air heat pumps.
  • Breaking change: Replaces HeatingCapacityRetention[Fraction | Temperature] with HeatingCapacityFraction17F.
  • Allows optional pan heater inputs (extension/PanHeaterPowerWatts and extension/PanHeaterControlType) for central and mini-split heat pumps; defaults to assuming a pan heater is present.
  • Allows optional EER2/EER inputs (AnnualCoolingEfficiency[Units="EER2" or Units="EER"]/Value) for central and mini-split air conditioners and heat pumps.
  • Deprecates SHR inputs (e.g., CoolingSensibleHeatFraction); they are no longer used.
  • Allows optional extension/FanMotorType input for central equipment; updates FanPowerWattsPerCFM defaults to be based on fan motor type.
  • Allows optional extension/EquipmentType inputs for central air conditioners and heat pumps; only used for SEER/SEER2, EER/EER2, and HSPF/HSPF2 conversions.
  • Allows optional design airflow rate inputs (extension/HeatingDesignAirflowCFM and extension/CoolingDesignAirflowCFM).
  • Updates default compressor lockout temperature for dual-fuel heat pumps from 25F to 40F.
  • Updates default design airflow rates to use cfm/ton assumptions rather than Manual S-based approach.
  • Updates defrost model to better account for load and energy use during defrost:
    • Allows optional defrost supplemental heat input (extension/BackupHeatingActiveDuringDefrost) for air-source heat pumps with integrated backup.
    • Deprecates SimulationControl/AdvancedResearchFeatures/DefrostModelType input.
  • Updates to detailed performance datapoints:
    • Breaking change: Updated requirements for allowed combinations of CapacityDescription and OutdoorTemperature; see the documentation for more details.
    • Detailed performance datapoints can now be specified for single stage and two stage equipment too.
    • Adds more error-checking to ensure appropriate data inputs.
• Optional GSHP input SimulationControl/AdvancedResearchFeatures/GroundToAirHeatPumpModelType to choose "standard" (default) or "experimental"; "experimental" model better accounts for coil staging.
• Updates asset calculations for dishwashers, clothes washers, fixtures, and hot water waste per RESNET HERS Addenda 81 and 90f.
• Allows optional ClothesDryer/DryingMethod input to inform whether the appliance is vented or ventless.
• Infiltration improvements:
  • Improves defaults for InfiltrationVolume, InfiltrationHeight, and AverageCeilingHeight.
  • Allows optional WithinInfiltrationVolume input for conditioned basements; defaults to true.
• Electric vehicle enhancements:
  • Allows detailed modeling of electric vehicles (batteries and charging/discharging) using Vehicles as an alternative to the simple EV charging PlugLoad.
  • Adds EV driving unmet hours output.
  • Updates the default schedule for the EV charging PlugLoad to better reflect real-world hourly/monthly variation.
• Electric panel NEC load calculations (experimental research feature):
  • Allows optional ElectricPanel inputs for describing branch circuits and service feeders
  • Optionally reports breaker spaces and calculated loads for specified NEC calculation types (SoftwareInfo/extension/ElectricPanelCalculations/ServiceFeeders/Type)
• Allows requesting timeseries EnergyPlus output meters (e.g., --hourly "MainsWater:Facility"), similar to requesting EnergyPlus output variables.
• BuildResidentialScheduleFile measure:
  • Adds stochastic schedule generation for electric vehicle charging (using Vehicles).
  • Removes generation of stochastic schedules for building components not present in the HPXML file.
• Output updates:
  • Breaking change: Adds generator electricity produced to total fuel/energy use; previously it was only included in net values.
  • Adds optional new outputs for timeseries zone conditions (humidity ratio and relative humidity and dewpoint, radiant, and operative temperatures).
  • Adds new outputs for net peak electricity (summer/winter/annual); same as total peak electricity outputs but subtracts power produced by PV.
  • Avoids writing the E+ eplustbl.htm by default; use the debug flag to get it.
  • Deletes eplusout*.msgpack files by default (run_simulation.rb only); use the debug flag to preserve them.
• Allows arbitrary columns to be present in a detailed schedule csv file with warning.

Bugfixes

• Fixes EPvalidator schematron file extension (.sch, not .xml).
• Fixes zero occupants specified for one unit in a whole MF building from being treated like zero occupants for every unit.
• Fixes using detailed schedules with higher resolution (e.g., 10-min data) than the simulation timestep (e.g., 60-min).
• Fixes possible heating/cooling spikes when using maximum power ratio detailed schedule for variable-speed HVAC systems.
• Fixes unavailable periods for two consecutive, but partial, days.
• Fixes error when specifying a glass block window without interior shading coefficients.
• Fixes battery charging/discharging not being included in peak electricity outputs.
• Fixes possible error if there's a surface w/ interior unconditioned space and exterior "other housing unit".
• Fixes default shading coefficients for window solar screens and solar film.
• Fixes SolarFraction documentation/error-checking for solar thermal systems; must now be <= 0.99.
• Fixes whole house fans so that they are unavailable during vacancies.
• Fixes error if there's a vented attic with zero roof pitch.
• Fixes tank loss coefficient when TankModelType=stratified for a conventional storage water heater.
• Fixes possibility of incorrect design duct load for really bad ducts (e.g., ducts with high surface area in a cold attic).
• Fixes duplicate emission end use rows for electricity in results_annual.csv.
• Adds error-checking to ensure TankModelType=stratified is not used with a non-electric water heater.
• BuildResidentialHPXML measure: Improves default duct areas/locations for 1-story buildings with a conditioned basement and ducts located in the attic.
• BuildResidentialHPXML measure: Fixes error when specifying a combi boiler as the water heater type and a shared boiler as the heating system type.
• BuildResidentialScheduleFile measure: Fixes out-of-sync shifting of occupancy and end use schedule resulting in activities even when there is no occupancy.
• BuildResidentialScheduleFile measure: Fixes a small bug in sink schedule generation resulting in more concentrated schedule.
• ReportUtilityBills measure: Apply fixed charges for fuels that are referenced by the HPXML file but consume no energy (e.g., gas heating system in Florida).