Skip to content

OpenStudio-HPXML v1.11.0

Choose a tag to compare

View all tags
@shorowit shorowit released this 16 Jan 21:48
· 543 commits to master since this release
v1.11.0
d64c6c9
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

OpenStudio-HPXML v1.11.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.11.0 uses OpenStudio v3.11.0, EnergyPlus v25.2.0, and HPXML v5.0-rc1. Please visit the OpenStudio-HPXML v1.11.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.11/EnergyPlus 25.2.
  • Updates to HPXML v5.0-rc1.
    • Breaking change: HPXML namespace changed from http://hpxmlonline.com/2023/09 to http://hpxmlonline.com/2025/12.
    • Breaking change: Replaces "none" with "not present" for InteriorFinish/Type, Siding, ExteriorShading/Type, InteriorShading/Type, Pool/Type, PermanentSpa/Type, Pump/Type, and Heater/Type.
    • Allows "stone veneer" for Wall/Siding and RimJoist/Siding.
    • Allows "medium light" for Roof/RoofColor, RimJoist/Color, and Wall/Color.
    • Allows SpecificLeakageArea for air infiltration measurements.
  • BuildResidentialHPXML measure:
    • Breaking change: New, simpler, easier to use option-based arguments (rather than detailed property arguments).
    • Automatically adjusts garage dimensions for dwelling units with small footprints to avoid errors.
  • Heat pump updates:
    • Updates default heating capacities at 17F per RESNET HERS Addendum 82 and NEEP database.
    • Updates supplemental heating energy use during defrost based on RESNET HERS Addendum 82.
    • Updates shared pump power for ground-source heat pumps on a shared recirculation loop to cycle with heating/cooling load rather than operate continuously per RESNET HERS Addendum 94.
    • Allows desuperheaters to be used with the experimental ground-source heat pump model.
    • Adds PanHeaterControlType="heat pump mode", in which the pan heater will run when the HP is running (and the outdoor temperature is below 32F).
    • Updates PanHeaterControlType="continuous" to avoid pan heater operation when the outdoor temperature is below the minimum compressor temperature.
  • Allows optional UsageMultiplier for electric vehicles described using Vehicles.
  • Water heater improvements:
    • Allows HPWHs to have exhaust air ducted to the outside using HPWHDucting/ExhaustAirTermination="outside".
    • Allows HPWH performance adjustment when installed in confined space per RESNET HERS Addendum 77. When extension/HPWHInConfinedSpaceWithoutMitigation is "true", extension/HPWHContainmentVolume is used to calculate the adjustment.
    • Improves HPWH tank volume defaulting, particularly when NumberofResidents is provided.
    • Improves electric water heater tank losses when using EnergyFactor as the metric; now consistent with how UniformEnergyFactor is handled.
  • Updated site defaults:
    • Address/CityMunicipality, Address/StateCode, GeoLocation/Latitude, GeoLocation/Longitude, and TimeZone/UTCOffset now default based on zip code if available.
    • TimeZone/DSTObserved now defaults to false if Address/StateCode is 'AZ' or 'HI'.
  • Minor PV improvements:
    • Allow PVSystem/AttachedToInverter to be omitted (unless there are multiple Inverter elements).
    • Allow multiple inverters with different efficiencies and use a weighted-average efficiency in the model (previously threw an error)
  • For storm windows, removes minimum base window U-factor limit and throws a warning instead if the base window U-factor is below 0.3.
  • Whole SFA/MF buildings:
    • Allows modeling inter-unit heat transfer using the @sameas attribute.
    • Allows modeling detailed electric vehicles.
    • Documents a workaround for modeling common spaces (conditioned or unconditioned).
    • See the documentation for more information.
  • Updated default utility bill rates per EIA energy cost data for 2023.
  • Adds "Electric Panel Load: Max Current Rating (A)" output to results_panel.csv.
  • Adds error-checking for when the sum of supply/return duct leakage to outside values is too high.
  • Adds error-checking for when HeatPump/HeatingCapacity17F is provided but HeatPump/HeatingCapacity is not.

Bugfixes

  • Fixes incorrect cooling design conditions when using TMYx weather files (OpenStudio bug).
  • Fixes ground-source heat pump plant loop fluid type (OpenStudio bug).
  • Fixes HERS sizing methodology when compressor lockout temperature is above the heating design temperature.
  • Fixes default hours driven per week for electric vehicles (8.88 -> 9.5).
  • Fixes empty TimeDST/TimeUTC columns in JSON timeseries data.
  • Fixes an EMS bug in heat pump defrost models that over-estimates defrost fractions.
  • Fixes zero mech vent fan energy when CFIS system w/ AdditionalRuntimeOperatingMode="air handler fan" has the airflow rate set to zero.
  • Fixes requested EnergyPlus timeseries output variables/meters not displayed in DView if they don't have units.
  • Fixes possible errors when small water flow rates for variable-speed experimental ground-source heat pump model.
  • Fixes possible ground-source heat pump sizing error if the heating or cooling design temperature differences are zero.
  • Fixes EMS discharge power program and assignment of default discharging schedule for detailed electric vehicles.
  • Avoids thin interior/exterior roof construction layers to help prevent attic temperature out of bounds errors.
Assets 3
Loading