OpenStudio-HPXML v1.5.1

OpenStudio-HPXML version 1.5.1 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.5.1 uses OpenStudio v3.5.0, EnergyPlus v22.2.0, and a proposed HPXML v4.0. Please visit the OpenStudio-HPXML v1.5.1 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

• When Battery/Location not provided, now defaults to garage if present, otherwise outside.
• BuildResidentialScheduleFile measure:
  • Allows requesting a subset of end uses (columns) to be generated.

Bugfixes

• Fixes total/net electricity timeseries outputs to include battery charging/discharging energy.
• Fixes error when a non-electric water heater has jacket insulation and the UEF metric is used.

OpenStudio-HPXML v1.5.0

OpenStudio-HPXML version 1.5.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.5.0 uses OpenStudio v3.5.0, EnergyPlus v22.2.0, and a proposed HPXML v4.0. Please visit the OpenStudio-HPXML v1.5.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.5.0/EnergyPlus 22.2.
• Updates to newer proposed HPXML v4.0:
  • Breaking Change: Replaces FrameFloors/FrameFloor with Floors/Floor.
  • Breaking change: Floor/FloorType (WoodFrame, StructuralInsulatedPanel, SteelFrame, or SolidConcrete) is a required input.
  • Breaking Change: All Ducts must now have a SystemIdentifier.
  • Breaking Change: Replaces WallType/StructurallyInsulatedPanel with WallType/StructuralInsulatedPanel.
  • Breaking change: Replaces SoftwareInfo/extension/SimulationControl/DaylightSaving/Enabled with Building/Site/TimeZone/DSTObserved.
  • Breaking Change: Replaces StandbyLoss with StandbyLoss[Units="F/hr"]/Value for an indirect water heater.
  • Breaking Change: Replaces BranchPipingLoopLength with BranchPipingLength for a hot water recirculation system.
  • Breaking Change: Replaces Floor/extension/OtherSpaceAboveOrBelow with Floor/FloorOrCeiling.
  • Breaking change: For PTAC with heating, replaces HeatingSystem of type PackagedTerminalAirConditionerHeating with CoolingSystem/IntegratedHeating* elements.
• Breaking Change: Now performs full HPXML XSD schema validation (previously just limited checks); yields runtime speed improvements.
• Breaking Change: HVAC/DHW equipment efficiencies can no longer be defaulted (e.g., based on age of equipment); they are now required.
• Breaking Change: Deprecates ReportHPXMLOutput measure; HVAC autosized capacities & design loads moved to results_annual.csv.
• Breaking change: BuildResidentialHPXML measure: Replaces arguments using 'auto' for defaults with optional arguments of the appropriate data type.
• Utility bill calculations:
  • Breaking change: Removes utility rate and PV related arguments from the ReportUtilityBills measure in lieu of HPXML file inputs.
  • Allows calculating one or more utility bill scenarios (e.g., net metering vs feed-in tariff compensation types for a simulation with PV).
  • Adds detailed calculations for tiered, time-of-use, or real-time pricing electric rates using OpenEI tariff files.
• Lithium ion battery:
  • Allows detailed charging/discharging schedules via CSV files.
  • Allows setting round trip efficiency.
  • Breaking change: Lifetime model is temporarily disabled; Battery/extension/LifetimeModel is not allowed.
• Allows SEER2/HSPF2 efficiency types for central air conditioners and heat pumps.
• Allows setting the natural ventilation availability (days/week that operable windows can be opened); default changed from 7 to 3 (M/W/F).
• Allows specifying duct surface area multipliers.
• Allows modeling CFIS ventilation systems with supplemental fans.
• Allows shared dishwasher/clothes washer to be attached to a hot water distribution system instead of a single water heater.
• Allows heating/cooling seasons that don't span the entire year.
• Allows modeling room air conditioners with heating or reverse cycle.
• Allows setting the ground soil conductivity used for foundation heat transfer and ground source heat pumps.
• Allows setting the EnergyPlus temperature capacitance multiplier.
• EnergyPlus modeling changes:
  • Switches Kiva foundation model timestep from 'Hourly' to 'Timestep'; small increase in runtime for sub-hourly simulations.
  • Improves Kiva foundation model heat transfer by providing better initial temperature assumptions based on foundation type and insulation levels.
• Annual/timeseries outputs:
  • Allows timeseries timestamps to be start or end of timestep convention; Breaking change: now defaults to start of timestep.
  • Adds annual emission outputs disaggregated by end use; timeseries emission outputs disaggregated by end use can be requested.
  • Allows generating timeseries unmet hours for heating and cooling.
  • Allows CSV timeseries output to be formatted for use with the DView application.
  • Adds heating/cooling setpoints to timeseries outputs when requesting zone temperatures.
  • Disaggregates Battery outputs from PV outputs.
  • Design temperatures, used to calculate design loads for HVAC equipment autosizing, are now output in in.xml and results_annual.csv.

Bugfixes

• Fixes possible incorrect autosizing of heat pump separate backup systems with respect to duct loads.
• Fixes incorrect autosizing of heat pump integrated backup systems if using MaxLoad/HERS sizing methodology and cooling design load exceeds heating design load.
• Fixes heating (or cooling) setpoints affecting the conditioned space temperature outside the heating (or cooling) season.
• Fixes handling non-integer number of occupants when using the stochastic occupancy schedule generator.
• Fixes units for Peak Loads (kBtu/hr, not kBtu) in annual results file.
• Fixes possible output error for ground source heat pumps with a shared hydronic circulation loop.
• Provides an error message if the EnergyPlus simulation used infinite energy.
• Fixes zero energy use for a ventilation fan w/ non-zero fan power and zero airflow rate.
• Fixes excessive heat transfer when foundation wall interior insulation does not start from the top of the wall.
• Fixes how relative paths are treated when using an OpenStudio Workflow.
• Fixes possible simulation error if a slab has an ExposedPerimeter near zero.
• Fixes possible "Could not identify surface type for surface" error.
• Fixes possible ruby error when defaulting water heater location.
• Battery round trip efficiency now correctly affects results.
• BuildResidentialHPXML measure:
  • Fixes aspect ratio convention for single-family attached and multifamily dwelling units.

OpenStudio-HPXML v1.4.0

OpenStudio-HPXML version 1.4.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.

Two packages are available, a minimal zip with a handful of weather files and a full zip with all US TMY3 weather files. OpenStudio-HPXML v1.4.0 uses OpenStudio v3.4.0, EnergyPlus v22.1.0, and a proposed HPXML v4.0. Please visit the OpenStudio-HPXML v1.4.0 documentation for instructions on how to get started, how to generate an appropriate HPXML file, etc.

New Features

• Updates to OpenStudio 3.4.0/EnergyPlus 22.1.
• High-level optional OccupancyCalculationType input to specify operational vs asset calculation. Defaults to asset. If operational, NumberofResidents is required.
• Allows calculating one or more emissions scenarios (e.g., high renewable penetration vs business as usual) for different emissions types (e.g., CO2e).
• New ReportUtilityBills reporting measure: adds a new results_bills.csv output file to summarize calculated utility bills.
• Switches from EnergyPlus SQL output to MessagePack output for faster performance and reduced file sizes when requesting timeseries outputs.
• New heat pump capabilities:
  • Breaking change: Replaces the UseMaxLoadForHeatPumps sizing option with HeatPumpSizingMethodology, which has three choices:
    • ACCA: nominal capacity sized per ACCA Manual J/S based on cooling design loads, with some oversizing allowances for larger heating design loads.
    • HERS (default): nominal capacity sized equal to the larger of heating/cooling design loads.
    • MaxLoad: nominal capacity sized based on the larger of heating/cooling design loads, while taking into account the heat pump's capacity retention at the design temperature.
  • Allows the separate backup system to be a central system (e.g., central furnace w/ ducts). Previously only non-central system types were allowed.
  • Heat pumps with switchover temperatures are now autosized by taking into account the switchover temperature, if higher than the heating design temperature.
  • Allows BackupHeatingLockoutTemperature as an optional input to control integrated backup heating availability during, e.g., a thermostat heating setback recovery event; defaults to 40F.
• New water heating capabilities:
  • Allows conventional storage tank water heaters to use a stratified (rather than mixed) tank model via extension/TankModelType; higher precision but runtime penalty. Defaults to mixed.
  • Allows operating mode (standard vs heat pump only) for heat pump water heaters (HPWHs) via extension/OperatingMode. Defaults to standard.
  • Updates combi boiler model to be simpler, faster, and more robust by using separate space/water heating plant loops and boilers.
• New capabilities for hourly/sub-hourly scheduling via schedule CSV files:
  • Detailed HVAC and water heater setpoints.
  • Detailed heat pump water heater operating modes.
• EnergyPlus modeling changes:
  • Switches from ScriptF to CarrollMRT radiant exchange algorithm.
  • Updates HVAC fans to use fan power law (cubic relationship between fan speed and power).
  • Updates HVAC rated fan power assumption per ASHRAE 1449-RP.
• Allows specifying a StormWindow element for windows/skylights; U-factors and SHGCs are automatically adjusted.
• Allows an optional AirInfiltrationMeasurement/InfiltrationHeight input.
• Allows an optional Battery/UsableCapacity input; now defaults to 0.9 x NominalCapacity (previously 0.8).
• For CFIS systems, allows an optional extension/VentilationOnlyModeAirflowFraction input to address duct losses during ventilation only mode.
• Breaking change: Each VentilationFan must have one (and only one) UsedFor... element set to true.
• BuildResidentialHPXML measure:
  • Breaking change: Changes the zip code argument name to site_zip_code.
  • Adds optional arguments for schedule CSV files, HPWH operating mode, water heater tank model, storm windows, heat pump lockout temperature, battery usable capacity, and emissions scenarios.
  • Adds support for ambient foundations for single-family attached and apartment units.
  • Adds support for unconditioned attics for apartment units.
  • Adds an optional argument to store additional custom properties in the HPXML file.
  • Adds an optional argument for whether the HPXML file is written with default values applied; defaults to false.
  • Adds an optional argument for whether the HPXML file is validated; defaults to false.
• ReportSimulationOutput measure:
  • Breaking change: New "End Use: <Fuel>: Heating Heat Pump Backup" output, disaggregated from "End Use: <Fuel>: Heating".
  • Adds "Energy Use: Total" and "Energy Use: Net" columns to the annual results output file; allows timeseries outputs.
  • Adds a "Fuel Use: Electricity: Net" timeseries output column for homes with electricity generation.
  • Adds optional argument for requesting timeseries EnergyPlus output variables.
  • Adds ability to include TimeDST and/or TimeUTC timestamp column(s) in results_timeseries.csv.
  • Timestamps in results_timeseries.csv are output in ISO 8601 standard format.
  • Allows user-specified annual/timeseries output file names.
• ReportHPXMLOutput measure:
  • Adds "Enclosure: Floor Area Foundation" output row in results_hpxml.csv.
• Adds support for shared hot water recirculation systems controlled by temperature.
• Relaxes requirement for ConditionedFloorAreaServed for air distribution systems; now only needed if duct surface areas not provided.
• Allows MessagePack annual/timeseries output files to be generated instead of CSV/JSON.

Bugfixes

• Adds more stringent limits for AirflowDefectRatio and ChargeDefectRatio (now allows values from 1/10th to 10x the design value).
• Catches case where leap year is specified but weather file does not contain 8784 hours.
• Fixes possible HVAC sizing error if design temperature difference (TD) is negative.
• Fixes an error if there is a pool or hot tub, but the pump Type is set to "none".
• Adds more decimal places in output files as needed for simulations with shorter timesteps and/or abbreviated run periods.
• Timeseries output fixes: some outputs off by 1 hour; possible negative combi boiler values.
• Fixes range hood ventilation interaction with infiltration to take into account the location of the cooking range.
• Fixes possible EMS error for ventilation systems with low (but non-zero) flow rates.
• Fixes documentation for Overhangs/Depth inputs; units should be ft and not inches.
• The WaterFixturesUsageMultiplier input now also applies to general water use internal gains and recirculation pump energy (for some control types).
• BuildResidentialHPXML measure:
  • Fixes units for "Cooling System: Cooling Capacity" argument (Btu/hr, not tons).
  • Fixes incorrect outside boundary condition for shared gable walls of cathedral ceilings, now set to adiabatic.

OpenStudio-HPXML v1.3.0

OpenStudio-HPXML version 1.3.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.

Two packages are available, a minimal zip with a handful of weather files and full zip with all US TMY3 weather files. OpenStudio-HPXML v1.3.0 uses OpenStudio v3.3.0, EnergyPlus v9.6.0, and a proposed HPXML v4.0. Please visit the OpenStudio-HPXML v1.3.0 documentation for instructions on how to get started, how to generate an appropriate HPXML file, etc.

New Features

• Updates to OpenStudio 3.3.0/EnergyPlus 9.6.0.
• Breaking change: Replaces "Unmet Load" outputs with "Unmet Hours".
• Breaking change: Renames "Load: Heating" and "Peak Load: Heating" (and Cooling) outputs to include "Delivered".
• Breaking change: Any heat pump backup heating requires HeatPump/BackupType ("integrated" or "separate") to be specified.
• Breaking change: For homes with multiple PV arrays, all inverter efficiencies must have the same value.
• Breaking change: HPXML schema version must now be '4.0' (proposed).
  • Moves ClothesDryer/extension/IsVented to ClothesDryer/Vented.
  • Moves ClothesDryer/extension/VentedFlowRate to ClothesDryer/VentedFlowRate.
  • Moves FoundationWall/Insulation/Layer/extension/DistanceToTopOfInsulation to FoundationWall/Insulation/Layer/DistanceToTopOfInsulation.
  • Moves FoundationWall/Insulation/Layer/extension/DistanceToBottomOfInsulation to FoundationWall/Insulation/Layer/DistanceToBottomOfInsulation.
  • Moves Slab/PerimeterInsulationDepth to Slab/PerimeterInsulation/Layer/InsulationDepth.
  • Moves Slab/UnderSlabInsulationWidth to Slab/UnderSlabInsulation/Layer/InsulationWidth.
  • Moves Slab/UnderSlabInsulationSpansEntireSlab to Slab/UnderSlabInsulation/Layer/InsulationSpansEntireSlab.
• Initial release of BuildResidentialHPXML measure, which generates an HPXML file from a set of building description inputs.
• Expanded capabilities for scheduling:
  • Allows modeling detailed occupancy via a schedule CSV file.
  • Introduces a measure for automatically generating detailed smooth/stochastic schedule CSV files.
  • Expands simplified weekday/weekend/monthly schedule inputs to additional building features.
  • Allows HeatingSeason & CoolingSeason to be specified for defining heating and cooling equipment availability.
• Adds a new results_hpxml.csv output file to summarize HPXML values (e.g., surface areas, HVAC capacities).
• Allows modeling lithium ion batteries.
• Allows use of HeatPump/BackupSystem for modeling a standalone (i.e., not integrated) backup heating system.
• Allows conditioned crawlspaces to be specified; modeled as crawlspaces that are actively maintained at setpoint.
• Allows non-zero refrigerant charge defect ratios for ground source heat pumps.
• Expands choices allowed for Siding (Wall/RimJoist) and RoofType (Roof) elements.
• Allows "none" for wall/rim joist siding.
• Allows interior finish inputs (e.g., 0.5" drywall) for walls, ceilings, and roofs.
• Allows specifying the foundation wall type (e.g., solid concrete, concrete block, wood, etc.).
• Allows additional fuel types for generators.
• Switches to the EnergyPlus Fan:SystemModel object for all HVAC systems.
• Introduces a small amount of infiltration for unvented spaces.
• Updates the assumption of flue losses vs tank losses for higher efficiency non-electric storage water heaters.
• Revises shared mechanical ventilation preconditioning control logic to operate less often.
• Adds alternative inputs:
  • Window/skylight physical properties (GlassLayers, FrameType, etc.) instead of UFactor & SHGC.
  • Ducts/FractionDuctArea instead of Ducts/DuctSurfaceArea.
  • Length instead of Area for foundation walls.
  • Orientation instead of Azimuth for all applicable surfaces, PV systems, and solar thermal systems.
  • CEER (Combined Energy Efficiency Ratio) instead of EER for room ACs.
  • UsageBin instead of FirstHourRating (for water heaters w/ UEF metric).
  • CFM50 instead of CFM25 or Percent for duct leakage.
• Allows more defaulting (optional inputs):
  • Mechanical ventilation airflow rate per ASHRAE 62.2-2019.
  • HVAC/DHW system efficiency (by age).
  • Mechanical ventilation fan power (by type).
  • Color (solar absorptance) for walls, roofs, and rim joists.
  • Foundation wall distance to top/bottom of insulation.
  • Door azimuth.
  • Radiant barrier grade.
  • Whole house fan airflow rate and fan power.
• Adds more warnings of inputs based on ANSI/BPI 2400 Standard.
• Removes error-check for number of bedrooms based on conditioned floor area, per RESNET guidance.
• Updates the reporting measure to register all outputs from the annual CSV with the OS runner (for use in, e.g., PAT).
• Removes timeseries CSV output columns that are all zeroes to reduce file size and processing time.
• Improves consistency of installation quality calculations for two/variable-speed air source heat pumps and ground source heat pumps.
• Relaxes requirement for heating (or cooling) setpoints so that they are only needed if heating (or cooling) equipment is present.
• Adds an --ep-input-format argument to run_simulation.rb to choose epJSON as the EnergyPlus input file format instead of IDF.
• Eliminates EnergyPlus warnings related to unused objects or invalid output meters/variables.
• Allows modeling PTAC and PTHP HVAC systems.
• Allows user inputs for partition wall mass and furniture mass.

Bugfixes

• Improves ground reflectance when there is shading of windows/skylights.
• Improves HVAC fan power for central forced air systems.
• Fixes mechanical ventilation compartmentalization area calculation for SFA/MF homes with surfaces with InteriorAdjacentTo==ExteriorAdjacentTo.
• Negative DistanceToTopOfInsulation values are now disallowed.
• Fixes workflow errors if a VentilationFan has zero airflow rate or zero hours of operation.
• Fixes duct design load calculations for HPXML files with multiple ducted HVAC systems.
• Fixes ground source heat pump rated airflow.
• Relaxes Overhangs DistanceToBottomOfWindow vs DistanceToBottomOfWindow validation when Depth is zero.
• Fixes possibility of double-counting HVAC distribution losses if an HVACDistribution element has both AirDistribution properties and DSE values
• Fixes possibility of incorrect "Peak Electricity: Winter Total (W)" and "Peak Electricity: Summer Total (W)" outputs for homes with duct losses.
• Fixes heating/cooling seasons (used for e.g. summer vs winter window shading) for the southern hemisphere.
• Fixes possibility of EnergyPlus simulation failure for homes with ground-source heat pumps and airflow and/or charge defects.
• Fixes peak load/electricity outputs for homes with ground-source heat pumps and airflow and/or charge defects.

OpenStudio-HPXML v1.2.0

OpenStudio-HPXML version 1.2.0 has been released. Two packages are available, a minimal zip with a handful of weather files and full zip with all US TMY3 weather files.

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.2.0 uses OpenStudio v3.1.0, EnergyPlus v9.4.0, and a proposed HPXML v3.1.

Please visit the OpenStudio-HPXML v1.2.0 documentation for instructions on how to get started, how to generate an appropriate HPXML file, etc.

New Features

• Breaking change: Heating/cooling component loads no longer calculated by default for faster performance; use --add-component-loads argument if desired.
• Breaking change: Replaces Site/extension/ShelterCoefficient with Site/ShieldingofHome.
• Allows DuctLeakageMeasurement & ConditionedFloorAreaServed to not be specified for ductless fan coil systems; Breaking change: AirDistributionType is now required for all air distribution systems.
• Allows Slab/ExposedPerimeter to be zero.
• Removes ClothesDryer/ControlType from being a required input, it is not used.
• Switches room air conditioner model to use Cutler performance curves.
• Relaxes tolerance for duct leakage to outside warning when ducts solely in conditioned space.
• Removes limitation that a shared water heater serving a shared laundry room can't also serve dwelling unit fixtures (i.e., FractionDHWLoadServed is no longer required to be zero).
• Adds IDs to schematron validation errors/warnings when possible.
• Moves additional error-checking from the ruby measure to the schematron validator.

Bugfixes

• Fixes room air conditioner performance curve.
• Fixes ruby error if elements (e.g., SystemIdentifier) exist without the proper 'id'/'idref' attribute.
• Fixes error if boiler/GSHP pump power is zero
• Fixes possible "Electricity category end uses do not sum to total" error due to boiler pump energy.
• Fixes possible "Construction R-value ... does not match Assembly R-value" error for highly insulated enclosure elements.
• Adds error-checking for negative SEEReq results for shared cooling systems.
• Adds more detail to error messages regarding the wrong data type in the HPXML file.
• Prevents a solar hot water system w/ SolarFraction=1.

OpenStudio-HPXML v1.1.0

OpenStudio-HPXML version 1.1.0 has been released. Two packages are available, a minimal zip with a handful of weather files and full zip with all US TMY3 weather files.

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.1.0 uses OpenStudio v3.1.0, EnergyPlus v9.4.0, and a proposed HPXML v3.1.

Please visit the OpenStudio-HPXML v1.1.0 documentation for instructions on how to get started, how to generate an appropriate HPXML file, etc.

New Features

• Breaking change: Type is now a required input for dehumidifiers; can be "portable" or "whole-home".
• Breaking change: Location is now a required input for dehumidifiers; must be "living space" as dehumidifiers are currently modeled as located in living space.
• Breaking change: Type is now a required input for Pool, PoolPump, HotTub, and HotTubPump.
• Breaking change: Both supply and return duct leakage to outside are now required inputs for AirDistribution systems.
• Breaking change: Simplifies inputs for fan coils and water loop heat pumps by A) removing HydronicAndAirDistribution element and B) moving WLHP inputs from extension elements to HeatPump element.
• Allows modeling airflow/charge defects for air conditioners, heat pumps, and furnaces (RESNET Standard 310).
• Allows modeling multiple dehumidifiers (previously only one allowed).
• Allows modeling generators (generic on-site power production).
• Allows detailed heating/cooling setpoints to be specified: 24-hour weekday & weekend values.
• Allows modeling window/skylight exterior shading via summer/winter shading coefficients.
• Allows JSON annual/timeseries output files to be generated instead of CSV. Breaking change: For CSV outputs, the first two sections in the results_annual.csv file are now prefixed with "Fuel Use:" and "End Use:", respectively.
• Allows more defaulting (optional inputs) for a variety of HPXML elements.
• Allows requesting timeseries unmet heating/cooling loads.
• Allows skipping schema/schematron validation (for speed); should only be used if the HPXML was already validated upstream.
• Allows HPXML files w/ multiple Building elements; requires providing the ID of the single building to be simulated.
• Includes hot water loads (in addition to heating/cooling loads) when timeseries total loads are requested.
• The in.xml HPXML file is now always produced for inspection of default values (e.g., autosized HVAC capacities). Breaking change: The output_dir HPXMLtoOpenStudio measure argument is now required.
• Overhauls documentation to be more comprehensive and standardized.
• run_simulation.rb now returns exit code 1 if not successful (i.e., either invalid inputs or simulation fails).

Bugfixes

• Improved modeling of window/skylight interior shading -- better reflects shading coefficient inputs.
• Adds error-checking on the HPXML schemaVersion.
• Adds various error-checking to the schematron validator.
• Adds error-checking for empty IDs in the HPXML file.
• Fixes heat pump water heater fan energy not included in SimulationOutputReport outputs.
• Fixes possibility of incorrect "A neighbor building has an azimuth (XXX) not equal to the azimuth of any wall" error.
• Fixes possibility of errors encountered before schematron validation has occurred.
• Small bugfixes related to basement interior surface solar absorptances.
• Allows NumberofConditionedFloors/NumberofConditionedFloorsAboveGrade to be non-integer values per the HPXML schema.
• HVAC sizing design load improvements for floors above crawlspaces/basements, walls, ducts, and heat pumps.
• Now recognizes Type="none" to prevent modeling of pools and hot tubs (pumps and heaters).
• Fixes error for overhangs with zero depth.
• Fixes possible error where the normalized flue height for the AIM-2 infiltration model is negative.
• Slight adjustment of default water heater recovery efficiency equation to prevent errors from values being too high.
• Fixes schematron file not being valid per ISO Schematron standard.

OpenStudio-HPXML v1.0.0

OpenStudio-HPXML version 1.0.0 has been released. Two packages are available, a minimal zip with a handful of weather files and full zip with all US TMY3 weather files.

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.0.0 uses OpenStudio v3.1.0, EnergyPlus v9.4.0, and a proposed HPXML v3.1.

Please visit the OpenStudio-HPXML v1.0.0 documentation for instructions on how to get started, how to generate an appropriate HPXML file, etc.

New Features

• Updates to OpenStudio 3.1.0/EnergyPlus 9.4.0.
• Breaking change: Deprecates WeatherStation/WMO HPXML input, use WeatherStation/extension/EPWFilePath instead; also removes weather_dir argument from HPXMLtoOpenStudio measure.
• Implements water heater Uniform Energy Factor (UEF) model; replaces RESNET UEF->EF regression. Breaking change: FirstHourRating is now a required input for storage water heaters when UEF is provided.
• Adds optional HPXML fan power inputs for most HVAC system types. Breaking change: Removes ElectricAuxiliaryEnergy input for non-boiler heating systems.
• Uses air-source heat pump cooling performance curves for central air conditioners.
• Updates rated fan power assumption for mini-split heat pump models.
• Allows coal fuel type for non-boiler heating systems.
• Accommodates common walls adjacent to unconditioned space by using HPXML surfaces where InteriorAdjacentTo == ExteriorAdjacentTo.
• Adds optional HPXML inputs to define whether a clothes dryer is vented and its ventilation rate.
• Adds optional HPXML input for SimulationControl/CalendarYear for TMY weather files.
• Schematron validation improvements.
• Adds some HPXML XSD schema validation and additional error-checking.
• Various small updates to ASHRAE 140 test files.
• Reduces number of EnergyPlus output files produced by using new OutputControlFiles object.
• Release packages now include ASHRAE 140 test files/results.

Bugfixes

• EnergyPlus 9.4.0 fix for negative window solar absorptances at certain hours.
• Fixes airflow timeseries outputs to be averaged instead of summed.
• Updates HVAC sizing methodology for slab-on-grade foundation types.
• Fixes an error that could prevent schematron validation errors from being produced.
• Skips weather caching if filesystem is read only.

OpenStudio-HPXML v0.11.0 Beta

OpenStudio-HPXML version 0.11.0 Beta has been released. Two packages are available, a minimal zip with a handful of weather files and full zip with all US TMY3 weather files.

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 v0.11.0 Beta uses OpenStudio v3.0.0, EnergyPlus v9.3.0, and a proposed HPXML v3.1.

Please visit the OpenStudio-HPXML v0.11.0 Beta documentation for instructions on how to get started, how to generate an appropriate HPXML file, etc.

New Features

• New Schematron validation (EPvalidator.xml) replaces custom ruby validation (EPvalidator.rb)
• [Breaking Change] BuildingConstruction/ResidentialFacilityType ("single-family detached", "single-family attached", "apartment unit", or "manufactured home") is a required input
• Ability to model shared systems for Attached/Multifamily dwelling units
  • Shared HVAC systems (cooling towers, chillers, central boilers, water loop heat pumps, fan coils, ground source heat pumps on shared hydronic circulation loops)
  • Shared water heaters serving either A) multiple dwelling units' service hot water or B) a shared laundry/equipment room, as well as hot water recirculation systems
  • Shared appliances (e.g., clothes dryer in a shared laundry room)
  • Shared hot water recirculation systems
  • Shared ventilation systems (optionally with preconditioning equipment and recirculation)
  • Shared PV systems
  • [Breaking Change] Appliances located in MF spaces (i.e., "other") must now be specified in more detail (i.e., "other heated space", "other non-freezing space", "other multifamily buffer space", or "other housing unit")
• Enclosure
  • New optional inputs: Roof/RoofType, Wall/Siding, and RimJoist/Siding
  • New optional inputs: Skylight/InteriorShading/SummerShadingCoefficient and Skylight/InteriorShading/SummerShadingCoefficient
  • New optional inputs: Roof/RoofColor, Wall/Color, and RimJoist/Color can be provided instead of SolarAbsorptance
  • New optional input to specify presence of flue/chimney, which results in increased infiltration
  • Allows adobe wall type
  • Allows AirInfiltrationMeasurement/HousePressure to be any value (previously required to be 50 Pa)
  • [Breaking Change] Roof/RadiantBarrierGrade input now required when there is a radiant barrier
• HVAC
  • Adds optional high-level HVAC autosizing controls
    • AllowIncreasedFixedCapacities: Describes how HVAC equipment with fixed capacities are handled. If true, the maximum of the user-specified fixed capacity and the heating/cooling design load will be used to reduce potential for unmet loads. Defaults to false.
    • UseMaxLoadForHeatPumps: Describes how autosized heat pumps are handled. If true, heat pumps are sized based on the maximum of heating and cooling design loads. If false, heat pumps are sized per ACCA Manual J/S based on cooling design loads with some oversizing allowances for heating design loads. Defaults to true.
  • Additional HVAC types: mini-split air conditioners and fixed (non-portable) space heaters
  • Adds optional inputs for ground-to-air heat pumps: extension/PumpPowerWattsPerTon and extension/FanPowerWattsPerCFM
• Ventilation
  • Allows multiple whole-home ventilation, spot ventilation, and/or whole house fans
• Appliances & Plug Loads
  • Allows multiple Refrigerator and Freezer
  • Allows Pool, HotTub, PlugLoad of type "electric vehicle charging" and "well pump", and FuelLoad of type "grill", "lighting", and "fireplace"
  • [Breaking Change] "other" and "TV other" plug loads now required
• Lighting
  • Allows lighting schedules and holiday lighting
• [Breaking Change] For hydronic distributions, HydronicDistributionType is now required
• [Breaking Change] For DSE distributions, AnnualHeatingDistributionSystemEfficiency and AnnualCoolingDistributionSystemEfficiency are both always required
• Allows more HPXML fuel types to be used for HVAC, water heating, appliances, etc.
• New inputs to define Daylight Saving period; defaults to enabled
• Adds more reporting of warnings/errors to run.log

Bugfixes

• Fixes pump energy for boilers and ground source heat pumps
• Fixes incorrect gallons of hot water use reported when there are multiple water heaters
• No longer report unmet load for buildings where the HVAC system only meets part of the load (e.g., room AC serving 33% of the load)
• Schedule bugfix for leap years

OpenStudio-HPXML v0.10.0 Beta

OpenStudio-HPXML version 0.10.0 Beta has been released. Two packages are available, a minimal zip with a handful of weather files and full zip with all US TMY3 weather files.

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 v0.10.0 Beta uses OpenStudio v3.0.0, EnergyPlus v9.3.0, and a proposed HPXML v3.1.

Please visit the OpenStudio-HPXML v0.10.0 Beta documentation for instructions on how to get started, how to generate an appropriate HPXML file, etc.

New Features

• Dwelling units of single-family attached/multifamily buildings:
  • Adds new generic space types "other heated space", "other multifamily buffer space", and "other non-freezing space" for surface ExteriorAdjacentTo elements. "other housing unit", i.e. adiabatic surfaces, was already supported.
  • [Breaking Change] For FrameFloors, replaces "other housing unit above" and "other housing unit below" enumerations with "other housing unit". All four "other ..." spaces must have an extension/OtherSpaceAboveOrBelow property set to either "above" or "below".
  • Allows ducts and water heaters to be located in all "other ..." spaces.
  • Allows all appliances to be located in "other", in which internal gains are neglected.
• Allows Fireplace and FloorFurnace for heating system types.
• Allows "exterior wall", "under slab", and "roof deck" for DuctLocation.
• Allows "wood" and "wood pellets" as fuel types for additional HVAC systems, water heaters, and appliances.
• Allows Location to be provided for Dishwasher and CookingRange.
• Allows BuildingSummary/Site/SiteType ("urban", "suburban", or "rural") to be provided.
• Allows user-specified Refrigerator and CookingRange schedules to be provided.
• HVAC capacity elements are no longer required; if not provided, ACCA Manual J autosizing calculations will be used (-1 can continue to be used for capacity elements but is discouraged).
• Duct locations/areas can be defaulted by specifying supply/return Duct elements without DuctSurfaceArea and DuctLocation. HVACDistribution/DistributionSystemType/AirDistribution/NumberofReturnRegisters can be optionally provided to inform the default duct area calculations.
• [Breaking Change] Lighting inputs now use LightingType[LightEmittingDiode | CompactFluorescent | FluorescentTube] instead of ThirdPartyCertification="ERI Tier I" or ThirdPartyCertification="ERI Tier II".
• [Breaking Change] HVACDistribution/ConditionedFloorAreaServed is now required for air distribution systems.
• [Breaking Change] Infiltration and attic ventilation specified using natural air changes per hour now uses ACHnatural instead of extension/ConstantACHnatural.
• [Breaking Change] The optional PerformanceAdjustment input for instantaneous water heaters is now treated as a performance multiplier (e.g., 0.92) instead of derate (e.g., 0.08).
• Adds ASHRAE 140 Class II test files.
• SimulationOutputReport reporting measure:
  • New optional timeseries outputs: airflows (e.g., infiltration, mechanical ventilation, natural ventilation, whole house fan) and weather (e.g., temperatures, wind speed, solar).
  • Timeseries frequency can now be set to 'none' as an alternative to setting all include_timeseries_foo variables to false.
  • [Breaking Change] Renames "Wood" to "Wood Cord" to better distinguish from "Wood Pellets".
• Modeling improvements:
  • Improved calculation for infiltration height
  • Infiltration & mechanical ventilation now combined using ASHRAE 62.2 Normative Appendix C.
• Runtime improvements:
  • Optimized ruby require calls.
  • Skip ViewFactor calculations when not needed (i.e., no conditioned basement).
• Error-checking:
  • Adds more space type-specific error checking of adjacent surfaces.
  • Adds additional HPXML datatype checks.
  • Adds a warning if a HVACDistribution system has ducts entirely within conditioned space and non-zero leakage to the outside.
  • Adds warnings if appliance inputs may be inappropriate and result in negative energy or hot water use.

Bugfixes

• Fixes error if there's a FoundationWall whose height is less than 0.5 ft.
• Fixes HVAC defrost control in EnergyPlus model to use "Timed" instead of "OnDemand".
• Fixes exterior air film and wind exposure for a FrameFloor over ambient conditions.
• Fixes air films for a FrameFloor ceiling.
• Fixes error if there are additional LightingGroup elements beyond the ones required.
• Fixes vented attic ventilation rate.
• Reported unmet heating/cooling load now correctly excludes latent energy.
• Ground-source heat pump backup fuel is now correctly honored instead of always using electricity.

OpenStudio-HPXML v0.9.0 Beta

OpenStudio-HPXML version 0.9.0 Beta has been released. Two packages are available, a minimal zip with a handful of weather files and full zip with all US TMY3 weather files.

The OpenStudio-HPXML measure translates a HPXML building description file into a residential building model for the Department of Energy's OpenStudio/EnergyPlus building simulation platform.

OpenStudio-HPXML v0.9.0 Beta uses OpenStudio v3.0.0, EnergyPlus v9.3.0, and a proposed HPXML v3.1.

Please visit the OpenStudio-HPXML v0.9.0 Beta documentation for instructions on how to get started, how to generate an appropriate HPXML file, etc.

New Features

• [Breaking Change] Updates to OpenStudio v3.0.0 and EnergyPlus 9.3
• Numerous HPXML inputs are now optional with built-in defaulting, particularly for water heating, appliances, and PV. Set the debug argument to true to output a in.xml HPXML file with defaults applied for inspection. See the documentation for defaulting equations/assumptions/references.
• [Breaking Change] If clothes washer efficiency inputs are provided, LabelUsage is now required.
• [Breaking Change] If dishwasher efficiency inputs are provided, LabelElectricRate, LabelGasRate, LabelAnnualGasCost, and LabelUsage are now required.
• Adds optional specification of simulation controls including timestep and begin/end dates.
• Adds optional extension/UsageMultiplier inputs for appliances, plug loads, lighting, and water fixtures. Can be used to, e.g., reflect high/low usage occupants.
• Adds ability to model a dehumidifier.
• Adds ability to model kitchen/bath fans (spot ventilation).
• Improved desuperheater model; desuperheater can now be connected to heat pump water heaters.
• Updated clothes washer/dryer and dishwasher models per ANSI/RESNET/ICC 301-2019 Addendum A.
• Solar thermal systems modeled with SolarFraction can now be connected to combi water heating systems.
• [Breaking Change] Replaces optional epw_output_path and osm_output_path arguments with a single optional output_dir argument; adds an optional debug argument.
• [Breaking Change] Replaces optional BuildingConstruction/extension/FractionofOperableWindowArea with optional Window/FractionOperable.
• [Breaking Change] Replaces optional extension/EPWFileName with optional extension/EPWFilePath to allow absolute paths to be provided as an alternative to just the file name.
• Replaces REXML xml library with Oga for better runtime performance.
• Additional error-checking.
• SimulationOutputReport reporting measure:
  • Now reports wood and wood pellets
  • Can report monthly timeseries values if requested
  • Adds hot water outputs (gallons) for clothes washer, dishwasher, fixtures, and distribution waste.
  • Small improvement to calculation of component loads

Bugfixes

• Fixes possible simulation error for buildings with complex HVAC/duct systems.
• Fixes handling of infiltration induced by duct leakage imbalance (i.e., supply leakage != return leakage). Only affects ducts located in a vented crawlspace or vented attic.
• Fixes an unsuccessful simulation for buildings where the sum of multiple HVAC systems' fraction load served was slightly above 1 due to rounding.
• Small fix for interior partition wall thermal mass model.
• Skip building surfaces with areas that are extremely small.