Skip to content

OpenStudio-HPXML v1.8.0
Compare
Choose a tag to compare
@shorowit shorowit released this 29 May 23:28
· 1521 commits to master since this release
v1.8.0
32afb15
This commit was created on github.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.

OpenStudio-HPXML version 1.8.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.8.0 uses OpenStudio v3.8.0, EnergyPlus v24.1.0, and HPXML v4.0-rc4. Please visit the OpenStudio-HPXML v1.8.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.8/EnergyPlus 24.1/HPXML v4.0-rc4.
  • Adds BPI-2400 HPXML test files and results; see Testing Framework for more information.
  • Updates per ANSI/RESNET/ICC 301-2022 w/ Addendum C:
    • Breaking change: For shared water heaters, NumberofUnitsServed is replaced by extension/NumberofBedroomsServed.
    • Breaking change: For shared hot water recirculation systems, NumberofUnitsServed is replaced by NumberofBedroomsServed.
    • Allows shared batteries (batteries serving multiple dwelling units).
    • Updated default CFIS fan power to 0.58 W/cfm.
    • Removed natural ventilation availability RH constraint; HR constraint remains.
    • Refrigerator and freezer schedules may now be based on ambient temperature using new TemperatureScheduleCoefficients and ConstantScheduleCoefficients inputs; the refrigerator default schedule uses these new inputs.
    • Default schedules updated for cooking ranges, lighting, plug loads, televisions, hot water recirculation pumps, and occupant heat gains.
    • Adds schedule inputs for hot water recirculation pumps and general water use internal gains.
    • Updated water heater installation default location.
    • Updated calculation of hot water piping length for buildings with both conditioned and unconditioned basements to avoid double counting.
    • Updated how imbalanced infiltration and mechanical ventilation are combined on an hourly basis.
    • Updated handling of duct leakage imbalance induced infiltration.
    • Small change to default flow rate for imbalanced mechanical ventilation systems.
    • Updated window default interior shade coefficients to be calculated based on SHGC.
    • AverageCeilingHeight now used in natural ACH/CFM infiltration calculations.
  • Breaking change: Replaces BuildingSummary/Site/extension/GroundConductivity with BuildingSummary/Site/Soil/Conductivity.
  • Breaking change: Modeling whole SFA/MF buildings is now specified using a SoftwareInfo/extension/WholeSFAorMFBuildingSimulation=true element instead of building-id=ALL argument.
  • Breaking change: Skylights attached to roofs of attics (e.g., with shafts or sun tunnels) must include the Skylight/AttachedToFloor element.
  • Air source heat pump/air conditioner enhancements:
    • Adds heat pump backup autosizing methodology input (HeatPumpBackupSizingMethodology) with choices of "emergency" and "supplemental".
    • Allows autosizing with detailed performance data inputs for variable-speed HVAC systems using CapacityFractionOfNominal.
    • Now defaults to -20F for CompressorLockoutTemperature for variable-speed heat pump systems.
  • Ground source heat pump enhancements:
    • Allows optional detailed inputs related to geothermal loop (HVACPlant/GeothermalLoop).
    • Allows optional ground diffusivity input.
    • Updates to using G-Functions from the G-Function Library for Modeling Vertical Bore Ground Heat Exchanger.
    • Updated heating/cooling performance curves to reflect newer equipment.
    • Adds geothermal loop outputs (number/length of boreholes) to annual results output file.
  • HVAC Manual J design load and sizing calculations:
    • Breaking change: Outputs for "Infiltration/Ventilation" category disaggregated into "Infiltration" and "Ventilation".
    • Breaking change: Outputs for "Windows" category no longer includes AED excursion; now a separate "AED Excursion" category.
    • Allows optional HeatingAutosizingFactor, CoolingAutosizingFactor, BackupHeatingAutosizingFactor inputs to scale HVAC capacities for autosized equipment.
    • Allows optional HeatingAutosizingLimit, CoolingAutosizingLimit, BackupHeatingAutosizingLimit inputs to set maximum HVAC capacities ceiling for autosized equipment.
    • Allows optional zone-level and space-level design load calculations using HPXML Zones/Zone[ZoneType="conditioned"]/Spaces/Space elements.
    • Allows additional outdoor design condition inputs: DailyTemperatureRange and HumidityDifference.
    • Adds a new detailed output file with block/space load details by surface, AED curves, etc.
    • Miscellaneous improvements.
  • Allows optional Ducts/DuctShape and Ducts/DuctFractionRectangular inputs, which affect duct effective R-value used for modeling.
  • Adds optional Slab/extension/GapInsulationRValue input for cases where a slab has horizontal (under slab) insulation.
  • Allows radiant barriers for additional locations (attic gable walls and floor); reduced emissivity due to dust assumed for radiant barriers on attic floor.
  • Adds window and skylight GlassType options of "low-e, high-solar-gain" and "low-e, low-solar-gain"; updates U-factor/SHGC lookup tables.
  • Updates default temperature capacitance multiplier from 1 to 7, an average value found in the literature when calibrating timeseries EnergyPlus indoor temperatures to field data.
  • Allows optional building site inputs (GeoLocation/Latitude, GeoLocation/Longitude, Elevation); useful when located far from, or at a very different elevation than, the EPW weather station.
  • Updates default ShieldingofHome to be "well-shielded" for single-family attached and multifamily dwelling units.
  • Improves heating/cooling component loads; for timesteps where there is no heating/cooling load, assigns heat transfer to heating or cooling by comparing indoor temperature to the average of heating/cooling setpoints.
  • Adds net energy and net electricity timeseries output columns even when there is no PV or generator.
  • Allow alternative label energy use (W) input for ceiling fans.
  • Replaced state-average default fuel prices with EIA State Energy Data System (SEDS) prices.
  • Adds more error-checking for inappropriate inputs (e.g., HVAC SHR=0 or clothes washer IMEF=0).
  • Updates to run_simulation.rb script:
    • Allows requesting timeseries outputs with different frequencies (e.g., --hourly enduses --monthly temperatures).
    • Breaking change: Deprecates --add-timeseries-output-variable; EnergyPlus output variables can now be requested like other timeseries categories (using e.g. --hourly 'Zone People Occupant Count').
    • Adds an optional --skip-simulation argument that allows skipping the EnergyPlus simulation.
  • BuildResidentialHPXML measure:
    • Breaking change: Replaces roof_radiant_barrier/roof_radiant_barrier_grade arguments with radiant_barrier_attic_location/radiant_barrier_grade.
    • Allows specifying number of bedrooms served by the water heater which is used for apportioning tank losses; Breaking change: Replaces water_heater_num_units_served with water_heater_num_bedrooms_served.
    • Allows defining multiple unavailable periods; Breaking change: arguments renamed to schedules_vacancy_periods, schedules_power_outage_periods, and schedules_power_outage_periods_window_natvent_availability.
    • Adds detailed performance data inputs for variable-speed air source HVAC systems.
    • Adds heat pump backup sizing methodology input.
    • Add soil and moisture type arguments (for determining ground conductivity and diffusivity) and optional geothermal loop arguments for ground source heat pumps.
    • The "Geometry: Building Number of Units" input is now written to the HPXML NumberofUnitsInBuilding element.
    • Adds a blower fan efficiency input for specifying fan power W/cfm at maximum speed.
  • BuildResidentialScheduleFile measure:
    • Allows appending columns to an existing CSV file rather than overwriting.
    • Other plug load schedules now use Other schedule fractions per ANSI/RESNET/ICC 301-2022 Addendum C.
    • TV plug load schedules now use TV schedule fractions from the American Time Use Survey and monthly multipliers from the 2010 Building America Analysis Spreadsheets.
    • Ceiling fan schedules now use ceiling fan schedule fractions and monthly multipliers from ANSI/RESNET/ICC 301-2022 Addendum C.
  • ReportUtilityBills measure:
    • Adds new optional arguments for registering (with the OpenStudio runner) annual or monthly utility bills.
  • Advanced research features:
    • Breaking change: Replaces SimulationControl/TemperatureCapacitanceMultiplier with SimulationControl/AdvancedResearchFeatures/TemperatureCapacitanceMultiplier.
    • Allows an optional boolean input SimulationControl/AdvancedResearchFeatures/DefrostModelType for heat pump advanced defrost model.
    • Adds maximum power ratio detailed schedule for variable-speed HVAC systems to model shedding controls per AHRI 1380.

Bugfixes

  • Fixes error if using AllowIncreasedFixedCapacities=true w/ HP detailed performance data.
  • Prevents mains water temperature from going below freezing (0 C).
  • Fixes error if HPXML has emissions scenario and abbreviated run period.
  • Fixes detailed schedule error-checking where schedules with MAX < 1 were incorrectly allowed.
  • Fixes error if using MF space types (e.g., "other heated space") and the building has no HVAC equipment.
  • Fixes ManualJInputs/HumiditySetpoint not being used in the design load calculation.
  • Fixes possible EnergyPlus error when a Slab representing a crawlspace dirt floor has perimeter or under slab insulation.
  • Prevents errors due to incorrect Floor/FloorOrCeiling input; issues a warning when detected.
  • Apportion shared water heater tank losses for HPWHs and combi systems.
  • Fixes buried duct effective R-values.
  • Fixes shared boiler default location (which could result in assuming there's a flue in conditioned space impacting infiltration).
  • Fixes timeseries hot water energy consumption adjustment lag (associated with hot water distribution).
  • Fixes possibility of negative timeseries delivered loads when there is a dehumidifier.
Assets 3
Loading