OpenStudio-HPXML v1.7.0

OpenStudio-HPXML version 1.7.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.7.0 uses OpenStudio v3.7.0, EnergyPlus v23.2.0, and HPXML v4.0-rc2. Please visit the OpenStudio-HPXML v1.7.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.7.0/EnergyPlus 23.2.
• Breaking change: Updates to HPXML v4.0-rc2:
  • HPXML namespace changed from http://hpxmlonline.com/2019/10 to http://hpxmlonline.com/2023/09.
  • Replaces "living space" with "conditioned space", which better represents what is modeled.
  • Replaces HotTubs/HotTub with Spas/PermanentSpa.
  • Replaces PortableHeater and FixedHeater with SpaceHeater.
• Allows simulating whole multifamily (MF) buildings in a single combined simulation:
  • Breaking change: Multiple elements move from SoftwareInfo/extension to BuildingDetails/BuildingSummary/extension to allow variation across units:
    • HVACSizingControl
    • ShadingControl
    • SchedulesFilePath
    • NaturalVentilationAvailabilityDaysperWeek
  • Allows NumberofUnits to be used as a multiplier on dwelling unit simulation results to reduce simulation runtime.
  • See the OpenStudio-HPXML documentation for more detail.
• HVAC modeling updates:
  • Updated assumptions for variable-speed air conditioners, heat pumps, and mini-splits based on NEEP data. Expect results to change, potentially significantly so depending on the scenario.
  • Allows detailed heating and cooling performance data (min/max COPs and capacities at different outdoor temperatures) for variable-speed systems.
  • Updates deep ground temperatures (used for modeling ground-source heat pumps) using L. Xing's simplified design model (2014).
  • Replaces inverse calculations, used to calculate COPs from rated efficiencies, with regressions for single/two-speed central ACs and ASHPs.
• Output updates:
  • Breaking change: "Hot Tub" outputs renamed to "Permanent Spa".
  • Adds "Peak Electricity: Annual Total (W)" output.
  • Adds battery resilience hours output; allows requesting timeseries output.
  • ReportUtilityBills measure: Allows reporting monthly utility bills in addition to (or instead of) annual bills.
• BuildResidentialHPXML measure:
  • Allow duct area fractions (as an alternative to duct areas in ft^2).
  • Allow duct locations to be provided while defaulting duct areas (i.e., without providing duct area/fraction inputs).
  • Add generic "attic" and "crawlspace" location choices for supply/return ducts, water heater, and battery.
  • Always validate the HPXML file before applying defaults and only optionally validate the final HPXML file.
• Adds manufactured home belly as a foundation type and allows modeling ducts in a manufactured home belly.
• Battery losses now split between charging and discharging.
• Interior/exterior window shading multipliers are now modeled using the EnergyPlus incident solar multiplier.
• Allows WaterFixture/FlowRate as an alternative to LowFlow; hot water credit is now calculated based on fraction of low flow fixtures.
• Allows above-grade basements/crawlspaces defined solely with Wall (not FoundationWall) elements.
• Updates to 2022 EIA energy costs.
• Added README.md documentation for all OpenStudio measures.

Bugfixes

• Fixes battery resilience output to properly incorporate battery losses.
• Fixes lighting multipliers not being applied when kWh/yr inputs are used.
• Fixes running detailed schedules with mixed timesteps (e.g., hourly heating/cooling setpoints and 15-minutely miscellaneous plug load schedules).
• Fixes calculation of utility bill fixed costs for simulations with abbreviated run periods.
• Fixes error if heat pump CompressorLockoutTemperature == BackupHeatingLockoutTemperature.
• Fixes possible "Electricity category end uses do not sum to total" error for a heat pump w/o backup.
• Fixes ground source heat pump fan/pump adjustment to rated efficiency.
• Fixes error if conditioned basement has InsulationSpansEntireSlab=true.
• Fixes ReportSimulationOutput outputs for the Parametric Analysis Tool (PAT).
• Fixes missing radiation exchange between window and sky when an interior/exterior window shading multiplier less than 1 exists.
• Fixes monthly shallow ground temperatures (used primarily in HVAC autosizing) for the southern hemisphere.
• Various HVAC sizing bugfixes and improvements.
• Fixes low-speed heating COPs for some two-speed ASHPs and cooling COPs for some single-speed ACs/HPs.
• BuildResidentialHPXML measure: Fixes air distribution CFA served when there is not a central system that meets 100% of the load.

OpenStudio-HPXML v1.6.0

OpenStudio-HPXML version 1.6.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.6.0 uses OpenStudio v3.6.1, EnergyPlus v23.1.0, and a proposed HPXML v4.0. Please visit the OpenStudio-HPXML v1.6.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.6.1/EnergyPlus 23.1.
• Updates to newer proposed HPXML v4.0:
  • Breaking change: Replaces VentilationFan/Quantity and CeilingFan/Quantity with Count.
  • Breaking change: Replaces PVSystem/InverterEfficiency with PVSystem/AttachedToInverter and Inverter/InverterEfficiency.
  • Breaking change: Replaces WaterHeatingSystem/extension/OperatingMode with WaterHeatingSystem/HPWHOperatingMode for heat pump water heaters.
• Output updates:
  • Breaking change: Adds End Use: Heating Heat Pump Backup Fans/Pumps (disaggregated from End Use: Heating Fans/Pumps).
  • Breaking change: Replaces Component Load: Windows with Component Load: Windows Conduction and Component Load: Windows Solar.
  • Breaking change: Replaces Component Load: Skylights with Component Load: Skylights Conduction and Component Load: Skylights Solar.
  • Breaking change: Adds Component Load: Lighting (disaggregated from Component Load: Internal Gains).
  • Breaking change: Adds "net" values for emissions; "total" values now exclude generation (e.g., PV).
  • Adds Load: Heating: Heat Pump Backup (heating load delivered by heat pump backup systems).
  • Adds System Use outputs (end use outputs for each heating, cooling, and water heating system); allows requesting timeseries output.
  • All annual load outputs are now provided as timeseries outputs; previously only "Delivered" loads were available.
  • Peak summer/winter electricity outputs are now based on Jun/July/Aug and Dec/Jan/Feb months, not HVAC heating/cooling operation.
  • Allows specifying the number of decimal places for timeseries output.
  • Msgpack outputs are no longer rounded (since there is no file size penalty to storing full precision).
  • Annual emissions and utility bills now include all fuel/end uses, even if zero.
  • ReportSimulationOutput measure: Allows disabling individual annual output sections.
• Breaking change: Deprecates OccupancyCalculationType ("asset" or "operational").
  • If NumberofResidents not provided, an asset calculation is performed assuming standard occupancy per ANSI/RESNET/ICC 301.
  • If NumberofResidents is provided, an operational calculation is performed using a relationship between #Bedrooms and #Occupants from RECS 2015.
• Heat pump enhancements:
  • Allows HeatingCapacityRetention[Fraction | Temperature] inputs to define cold-climate performance; like HeatingCapacity17F but can apply to autosized systems and can use a user-specified temperature.
  • Default mini-split heating capacity retention updated from 0.4 to 0.5 (at 5 deg-F).
  • Allows CompressorLockoutTemperature as an optional input to control the minimum temperature the compressor can operate at.
  • Defaults for CompressorLockoutTemperature: 25F for dual-fuel, -20F for mini-split, 0F for all other heat pumps.
  • Defaults for BackupHeatingLockoutTemperature: 50F for dual-fuel, 40F for all other heat pumps.
  • Provides a warning if BackupHeatingSwitchoverTemperature or BackupHeatingLockoutTemperature are low and may cause unmet hours.
  • Autosizing is no longer all-or-none; backup heating can be autosized (defaulted) while specifying the heat pump capacities, or vice versa.
  • Allows extension/CrankcaseHeaterPowerWatts as an optional input; defaults to 50 W for central HPs/ACs and mini-splits.
  • Increased consistency between variable-speed central HP and mini-split HP models for degradation coefficients, gross SHR calculations, etc.
• Infiltration changes:
  • Breaking change: Infiltration for SFA/MF dwelling units must include TypeOfInfiltrationLeakage ("unit total" or "unit exterior only").
  • Breaking change: Replaces BuildingConstruction/extension/HasFlueOrChimney with AirInfiltration/extension/HasFlueOrChimneyInConditionedSpace; defaults now incorporate HVAC/water heater location.
  • Allows infiltration to be specified using CFMnatural or EffectiveLeakageArea.
• Lighting changes:
  • LightingGroups can now be specified using kWh/year annual consumption values as an alternative to fractions of different lighting types.
  • LightingGroups for interior, exterior, and garage are no longer required; if not provided, these lighting uses will not be modeled.
• HVAC sizing enhancements:
  • Allows optional inputs under HVACSizingControl/ManualJInputs to override Manual J defaults for HVAC autosizing calculations.
  • Updates to better align various default values and algorithms with Manual J.
  • Updates design load calculations to handle conditioned basements with insulated slabs.
• Duct enhancements:
  • Allows modeling ducts buried in attic loose-fill insulation using Ducts/DuctBuriedInsulationLevel.
  • Allows specifying Ducts/DuctEffectiveRValue, the value that will be used in the model, though its use is not recommended.
• Allows modeling a pilot light for non-electric heating systems (furnaces, stoves, boilers, and fireplaces).
• Allows summer vs winter shading seasons to be specified for windows and skylights.
• Allows defining one or more UnavailablePeriods (e.g., occupant vacancies or power outage periods).
• Stochastic schedules for garage lighting and TV plug loads now use interior lighting and miscellaneous plug load schedules, respectively.
• Performance improvement for HPXML files w/ large numbers of Building elements.
• Weather cache files (*foo-cache.csv) are no longer used/needed.

Bugfixes

• Fixes BackupHeatingSwitchoverTemperature for a heat pump w/ separate backup system; now correctly ceases backup operation above this temperature.
• Fixes error if calculating utility bills for an all-electric home with a detailed JSON utility rate.
• Stochastic schedules now excludes columns for end uses that are not stochastically generated.
• Fixes operational calculation when the number of residents is set to zero.
• Fixes possible utility bill calculation error for a home with PV using a detailed electric utility rate.
• Fixes defaulted mechanical ventilation flow rate for SFA/MF buildings, with respect to infiltration credit.
• HPXML files w/ multiple Building elements now only show warnings for the single Building being simulated.
• Adds a warning for SFA/MF dwelling units without at least one attached wall/ceiling/floor surface.
• Various fixes for window/skylight/duct design loads for Manual J HVAC autosizing calculations.
• Ensure that ductless HVAC systems do not have a non-zero airflow defect ratio specified.
• Fixes possible "A neighbor building has an azimuth (XX) not equal to the azimuth of any wall" for SFA/MF units with neighboring buildings for shade.
• Fixes reported loads when no/partial HVAC system (e.g., room air conditioner that meets 30% of the cooling load).

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