Skip to content

OpenStudio-HPXML v1.12.0

Latest

Choose a tag to compare

@shorowit shorowit released this 14 May 14:51
· 23 commits to master since this release

OpenStudio-HPXML v1.12.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.12.0 uses OpenStudio v3.11.0, EnergyPlus v25.2.0, and HPXML v5.0-rc1. Please visit the OpenStudio-HPXML v1.12.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

  • HVAC updates:
    • Adds a warning if there are more than 300 unmet hours for heating or cooling; setpoint tolerance increased from 0.36 deg-F (0.2 deg-C) to 0.5 deg-F.
    • Dual-fuel heat pumps with switchover temperatures > 25F are now autosized based on 25F to allow some additional heating capacity buffer.
    • Improves handling of duct leakage specified using cfm25/cfm50.
    • Allows multiple ground-source heat pumps attached to a single geothermal loop; yields runtime speed improvements.
    • Crankcase heating energy is now disabled during unavailable periods, e.g., power outages.
    • Adds advanced research feature to model latent degradation for cooling systems, including an input to specify an HVAC blower-off delay.
  • Output updates:
    • Breaking change: Annual peak load outputs for heating and cooling now use units of Btu/h instead of kBtu/h for consistency with other outputs.
    • Breaking change: Replaces "UnitX" prefixes with Building IDs in whole SFA/MF building timeseries outputs.
    • For whole SFA/MF building simulations, reports energy/fuel use by dwelling unit (i.e., "Dwelling Unit Energy Use: *" and "Dwelling Unit Fuel Use: *"). Timeseries outputs are also available.
    • Allows calculating utility bills for homes with HVAC distribution systems using simplified heating/cooling DSE values (previously unsupported).
  • Whole SFA/MF buildings:
    • Allows modeling batteries in individual dwelling units (previously unsupported).
  • Utility bill calculations:
    • Updated default state-average utility rates to EIA State Energy Data System (SEDS) 2024 data.
    • Updates openei_rates.zip with the latest residential utility rates from the OpenEI U.S. Utility Rate database.
  • Allows "other" for SoilType; adds variation to dry/wet soil conductivity and diffusivity values for unknown/other/loam soil types.
  • Updates schematron validation error messages to be more user friendly.
  • Adds a run_simulation.rb --ems-debug argument to generate the EnergyPlus EDD file for debugging EMS programs.

Bugfixes

  • Fixes a misleading warning about adjusting inverted setpoints when heating setpoint is greater than cooling setpoint during non-overlapping heating/cooling seasons.
  • Fixes possible incorrect unmet hours outputs for unavailable periods with no space heating only (or no space cooling only).
  • Fixes PanHeaterControlType="heat pump mode" incorrectly disallowed for mini-split heat pumps.
  • Fixes the design cooling temperature calculations for some vented attic roof types (shingles, plastic/rubber/synthetic sheeting, concrete, cool roof, expanded polystyrene sheathing)
  • Fixes unit multiplier ignored for EV charging using Vehicles.
  • Fixes handling of battery losses in the battery resilience output.
  • Fixes handling of zero occupants (i.e., unoccupied dwelling unit):
    • Fixes lighting and plug/fuel load energy use to not be zeroed out when a kWh/year or therm/year value is provided.
    • Fixes pool/spa energy use to be zeroed out when a kWh/year or therm/year value is not provided, or when there is a "Vacancy" unavailable period.
  • Fixes incorrect hot water (gallons) output for solar thermal systems using SolarFraction.
  • Small bugfixes when using the on/off thermostat deadband advanced research feature:
    • Fixes unmet hours outputs, which could be missing some periods of unmet hours.
    • Fixes timeseries outputs for heating/cooling setpoints.
  • Fixes logic in HP multi-stage backup advanced research feature.
  • Fixes PV grid connection fee applying in utility bill calculation even if the home has no PV.
  • Fixes possible "Failed to process String" EnergyPlus error when requesting component loads.
  • Fixes ducts in manufactured home belly from being incorrectly modeled as if they were outside.