Releases: NREL/OpenStudio-ERI
OpenStudio-ERI v1.6.0
OpenStudio-ERI version 1.6.0 has been released. The OpenStudio-ERI workflow calculates an Energy Rating Index (ERI) using the Department of Energy's OpenStudio/EnergyPlus building simulation platform. The open-source workflow is intended to be used by residential software tools that provide a HPXML building description file.
OpenStudio-ERI v1.6.0 uses OpenStudio v3.6.1, EnergyPlus v23.1.0, and a proposed HPXML v4.0. Please visit the OpenStudio-ERI v1.6.0 documentation for instructions on how to get started, how to connect software tools to the workflow, 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.
- Breaking change: CO2e Index results must now be requested through a new optional
SoftwareInfo/extension/CO2IndexCalculation/Version
input. - Updates to newer proposed HPXML v4.0:
- Breaking change: Replaces
CeilingFan/Quantity
,ClothesWasher/NumberofUnits
, andClothesDryer/NumberofUnits
withCount
. - Breaking change: Replaces
PVSystem/InverterEfficiency
withPVSystem/AttachedToInverter
andInverter/InverterEfficiency
.
- Breaking change: Replaces
- Output updates:
- Breaking change: Adds
End Use: Heating Heat Pump Backup Fans/Pumps
(disaggregated fromEnd Use: Heating Fans/Pumps
). - Breaking change: Replaces
Component Load: Windows
withComponent Load: Windows Conduction
andComponent Load: Windows Solar
. - Breaking change: Replaces
Component Load: Skylights
withComponent Load: Skylights Conduction
andComponent Load: Skylights Solar
. - Breaking change: Adds
Component Load: Lighting
(disaggregated fromComponent 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.
- Breaking change: Adds
- Heat pump enhancements:
- Allows
HeatingCapacityRetention[Fraction | Temperature]
optional inputs as a more flexible alternative toHeatingCapacity17F
. - Allows
CompressorLockoutTemperature
andBackupHeatingLockoutTemperature
as optional inputs; alternatives toBackupHeatingSwitchoverTemperature
. - 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. - Increased consistency between variable-speed central HP and mini-split HP models for degradation coefficients, gross SHR calculations, etc.
- Allows
- Duct enhancements:
- Allows modeling ducts buried in attic loose-fill insulation using
Ducts/DuctBuriedInsulationLevel
. - The duct effective R-value can now be found in the ERI___Home.xml files; it accounts for exterior air film, duct shape, and buried insulation level.
- Allows modeling ducts buried in attic loose-fill insulation using
- Allows additional building air leakage inputs (ACH or CFM at user-specified house pressure, Natural CFM, Effective Leakage Area).
- LightingGroup for garage is no longer required if the home doesn't have a garage.
- Weather cache files (*foo-cache.csv) are no longer used/needed.
Bugfixes
- Adds error-checking to ensure that SFA/MF dwelling units have at least one attached wall/ceiling/floor surface.
- Various Manual J HVAC autosizing calculation bugfixes and improvements.
- Ensure that ductless HVAC systems do not have a non-zero airflow defect ratio specified.
OpenStudio-ERI v1.5.2
OpenStudio-ERI version 1.5.2 has been released. The OpenStudio-ERI workflow calculates an Energy Rating Index (ERI) using the Department of Energy's OpenStudio/EnergyPlus building simulation platform. The open-source workflow is intended to be used by residential software tools that provide a HPXML building description file.
OpenStudio-ERI v1.5.2 uses OpenStudio v3.5.0, EnergyPlus v22.2.0, and a proposed HPXML v4.0. Please visit the OpenStudio-ERI v1.5.2 documentation for instructions on how to get started, how to connect software tools to the workflow, etc. The full set of US TMY3 weather files can be obtained from here.
New Features
- Adds support for ZERH Single Family v2.
- Updates to ENERGY STAR SFNH Rev 12 and MFNC Rev 03.
WaterHeatingSystem/RecoveryEfficiency
is now an optional input.- Weather cache file (*-cache.csv) is now optional; if not provided, it will be generated on the fly. Provide the cache file for fastest runtime.
- Provide two decimal places in ENERGY STARS/ZERH CSV output files to better prevent user confusion.
Bugfixes
- Bugfixes for ENERGY STAR and ZERH programs.
OpenStudio-ERI v1.5.1
OpenStudio-ERI version 1.5.1 has been released. The OpenStudio-ERI workflow calculates an Energy Rating Index (ERI) using the Department of Energy's OpenStudio/EnergyPlus building simulation platform. The open-source workflow is intended to be used by residential software tools that provide a HPXML building description file.
OpenStudio-ERI v1.5.1 uses OpenStudio v3.5.0, EnergyPlus v22.2.0, and a proposed HPXML v4.0. Please visit the OpenStudio-ERI v1.5.1 documentation for instructions on how to get started, how to connect software tools to the workflow, etc. The full set of US TMY3 weather files can be obtained from here.
Bugfixes
- Fixes incorrect warning about zip code not found in eGRID/Cambium lookup table.
- Fixes error when a non-electric water heater has jacket insulation and the UEF metric is used.
OpenStudio-ERI v1.5.0
OpenStudio-ERI version 1.5.0 has been released. The OpenStudio-ERI workflow calculates an Energy Rating Index (ERI) using the Department of Energy's OpenStudio/EnergyPlus building simulation platform. The open-source workflow is intended to be used by residential software tools that provide a HPXML building description file.
OpenStudio-ERI v1.5.0 uses OpenStudio v3.5.0, EnergyPlus v22.2.0, and a proposed HPXML v4.0. Please visit the OpenStudio-ERI v1.5.0 documentation for instructions on how to get started, how to connect software tools to the workflow, 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
withFloors/Floor
. - Breaking change:
Floor/FloorType
(WoodFrame, StructuralInsulatedPanel, SteelFrame, or SolidConcrete) is a required input. - Breaking change: All
Ducts
must now have aSystemIdentifier
. - Breaking change: Replaces
WallType/StructurallyInsulatedPanel
withWallType/StructuralInsulatedPanel
. - Breaking change: Replaces
StandbyLoss
withStandbyLoss[Units="F/hr"]/Value
for an indirect water heater. - Breaking change: Replaces
BranchPipingLoopLength
withBranchPipingLength
for a hot water recirculation system. - Breaking change: Replaces
Floor/extension/OtherSpaceAboveOrBelow
withFloor/FloorOrCeiling
. - Breaking change: For PTAC with heating, replaces
HeatingSystem
of type PackagedTerminalAirConditionerHeating withCoolingSystem/IntegratedHeating*
elements.
- Breaking change: Replaces
- Breaking change: Now performs full HPXML XSD schema validation (previously just limited checks); yields runtime speed improvements.
- Adds ENERGY STAR ERI calculation for SF National v3.2 and MF National v1.2.
- Adds IECC ERI pathway calculation (2015, 2018, 2021).
- Adds Zero Energy Ready Homes calculation for v1.
- Allows SEER2/HSPF2 efficiency types for central air conditioners and heat pumps.
- Allows calculating all programs (e.g., ERI, ENERGY STAR, IECC, etc.) simultaneously while avoiding duplicate EnergyPlus simulations.
- Breaking change: Deprecates energy_star.rb script; energy_rating_index.rb will now run all programs specified in the HPXML.
- Breaking change: The organization of ENERGY STAR output files have changed.
- Allows modeling CFIS ventilation systems with a supplemental fan.
- Breaking change: New
CFISControls/AdditionalRuntimeOperatingMode
input required for CFIS ventilation systems.
- Breaking change: New
- Breaking change: The
ClimateZoneIECC/Year
is now more strict:- All runs must include a 2006 IECC climate zone.
- IECC ERI pathway runs must include an IECC climate zone of the same year.
- ENERGY STAR ERI runs for SF National v3.2 and MF National v1.2 must include a 2021 IECC climate zone.
- Zero Energy Ready Homes v1 runs must include a 2015 IECC climate zone.
- Allows modeling room air conditioners with heating or reverse cycle.
- Allows shared dishwasher/clothes washer to be attached to a hot water distribution system instead of a single water heater.
- Adds HVAC capacities, design loads, and design temperatures to csv output files.
- Annual/timeseries outputs:
- 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.
- Adds heating/cooling setpoints to timeseries outputs when requesting zone temperatures.
- Improves Kiva foundation model heat transfer by providing better initial temperature assumptions based on foundation type and insulation levels.
Bugfixes
- Fixes units for Peak Loads (kBtu/hr, not kBtu) in ERI____Home.csv output files.
- Bugfix for increasing HVAC capacities due to installation grading.
- Fixes possible output error for ground source heat pumps with a shared hydronic circulation loop.
- Fixes zero energy use for a ventilation fan w/ non-zero fan power and zero airflow rate.
OpenStudio-ERI v1.4.4
OpenStudio-ERI version 1.4.4 has been released. The OpenStudio-ERI workflow calculates an Energy Rating Index (ERI) using the Department of Energy's OpenStudio/EnergyPlus building simulation platform. The open-source workflow is intended to be used by residential software tools that provide a HPXML building description file.
Two packages are available, a minimal zip with a handful of weather files and a full zip with all US TMY3 weather files. OpenStudio-ERI v1.4.4 uses OpenStudio v3.4.0, EnergyPlus v22.1.0, and a proposed HPXML v4.0. Please visit the OpenStudio-ERI v1.4.4 documentation for instructions on how to get started, how to connect software tools to the workflow, etc.
Bugfixes
- Fixes possible simulation error if a slab has an ExposedPerimeter near zero.
OpenStudio-ERI v1.4.3
OpenStudio-ERI version 1.4.3 has been released. The OpenStudio-ERI workflow calculates an Energy Rating Index (ERI) using the Department of Energy's OpenStudio/EnergyPlus building simulation platform. The open-source workflow is intended to be used by residential software tools that provide a HPXML building description file.
Two packages are available, a minimal zip with a handful of weather files and a full zip with all US TMY3 weather files. OpenStudio-ERI v1.4.3 uses OpenStudio v3.4.0, EnergyPlus v22.1.0, and a proposed HPXML v4.0. Please visit the OpenStudio-ERI v1.4.3 documentation for instructions on how to get started, how to connect software tools to the workflow, etc.
Bugfixes
- Fixes excessive heat transfer when foundation wall interior insulation does not start from the top of the wall.
OpenStudio-ERI v1.4.2
OpenStudio-ERI version 1.4.2 has been released. The OpenStudio-ERI workflow calculates an Energy Rating Index (ERI) using the Department of Energy's OpenStudio/EnergyPlus building simulation platform. The open-source workflow is intended to be used by residential software tools that provide a HPXML building description file.
Two packages are available, a minimal zip with a handful of weather files and a full zip with all US TMY3 weather files. OpenStudio-ERI v1.4.2 uses OpenStudio v3.4.0, EnergyPlus v22.1.0, and a proposed HPXML v4.0. Please visit the OpenStudio-ERI v1.4.2 documentation for instructions on how to get started, how to connect software tools to the workflow, etc.
Bugfixes
- Fixes incorrect ERI calculation when the Rated Home has multiple water heaters.
OpenStudio-ERI v1.4.1
OpenStudio-ERI version 1.4.1 has been released. The OpenStudio-ERI workflow calculates an Energy Rating Index (ERI) using the Department of Energy's OpenStudio/EnergyPlus building simulation platform. The open-source workflow is intended to be used by residential software tools that provide a HPXML building description file.
Two packages are available, a minimal zip with a handful of weather files and full zip with all US TMY3 weather files. OpenStudio-ERI v1.4.1 uses OpenStudio v3.4.0, EnergyPlus v22.1.0, and a proposed HPXML v4.0. Please visit the OpenStudio-ERI v1.4.1 documentation for instructions on how to get started, how to connect software tools to the workflow, etc.
Bugfixes
- Fixes possible error when running HERS Auto-Generation tests.
OpenStudio-ERI v1.4.0
OpenStudio-ERI version 1.4.0 has been released. The OpenStudio-ERI workflow calculates an Energy Rating Index (ERI) using the Department of Energy's OpenStudio/EnergyPlus building simulation platform. The open-source workflow is intended to be used by residential software tools that provide a HPXML building description file.
Two packages are available, a minimal zip with a handful of weather files and full zip with all US TMY3 weather files. OpenStudio-ERI v1.4.0 uses OpenStudio v3.4.0, EnergyPlus v22.1.0, and a proposed HPXML v4.0. Please visit the OpenStudio-ERI v1.4.0 documentation for instructions on how to get started, how to connect software tools to the workflow, etc.
New Features
- Updates to OpenStudio 3.4.0/EnergyPlus 22.1.
- Updates to OpenStudio-HPXML 1.4.0.
- Implements ANSI/RESNET/ICC Standard 301-2019 Addenda C & D.
ERICalculation/Version
can now be "2019ABC" or "2019ABCD" in the HPXML files.- Adds calculation of CO2e Rating Index and CO2e/NOx/SO2 emissions (annual and hourly).
- Adds support for shared hot water recirculation systems controlled by temperature.
- Breaking change:
/HPXML/Building/Site
is now required withAddress/StateCode
andAddress/ZipCode
child elements.
- Output changes:
- Adds "Energy Use: Total" and "Energy Use: Net" columns to the ERI____Home.csv output files; allows hourly outputs.
- Breaking change: New "End Use: <Fuel>: Heating Heat Pump Backup" output, disaggregated from "End Use: <Fuel>: Heating".
- Breaking change: Deprecates duct leakage to outside exemptions; software tools must provide duct leakage to outside or DSE.
SoftwareInfo/extension/ERICalculation/Version
enumerations "2014ADEGL", "2014ADEG", "2014ADE" are replaced by "2014AEG" and "2014AE". - Breaking change: For CFIS systems, an
extension/VentilationOnlyModeAirflowFraction
input is now required to address duct losses during ventilation only mode. - Allows
AirInfiltrationMeasurement/InfiltrationHeight
as an optional input; if not provided, it is inferred from other inputs as before. - Allows duct leakage to be entered in units of CFM50 as an alternative to CFM25.
- Adds a
--skip-simulation
flag that can be used to just generate the ERI Rated/Reference Home HPXMLs and then stop. - Adds a
--rated-home-only
flag to run only the ERI Rated Home simulation (ERI will not be calculated). - Simplifies ERI Reference Home configuration with respect to HVAC types and number of DSE distribution systems.
Bugfixes
- Fixes opaque door R-value in the Reference Home in IECC climate zone 1.
- Fixes possible NaN result for ERI if, in a very cold climate, the Reference Home has no cooling load.
OpenStudio-ERI v1.3.0
OpenStudio-ERI version 1.3.0 has been released. The OpenStudio-ERI workflow calculates an Energy Rating Index (ERI) using the Department of Energy's OpenStudio/EnergyPlus building simulation platform. The open-source workflow is intended to be used by residential software tools that provide a HPXML building description file.
Two packages are available, a minimal zip with a handful of weather files and full zip with all US TMY3 weather files. OpenStudio-ERI v1.3.0 uses OpenStudio v3.3.0, EnergyPlus v9.6.0, and a proposed HPXML v4.0. Please visit the OpenStudio-ERI v1.3.0 documentation for instructions on how to get started, how to connect software tools to the workflow, etc.
New Features
- Updates to OpenStudio 3.3.0/EnergyPlus 9.6.0.
- Breaking change: HVAC grading inputs
FanPowerNotTested
,AirflowNotTested
, andChargeNotTested
are no longer accepted. - 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"
to be specified. - Breaking change: HPXML schema version must now be '4.0' (proposed).
- Moves
FoundationWall/Insulation/Layer/extension/DistanceToTopOfInsulation
toFoundationWall/Insulation/Layer/DistanceToTopOfInsulation
. - Moves
FoundationWall/Insulation/Layer/extension/DistanceToBottomOfInsulation
toFoundationWall/Insulation/Layer/DistanceToBottomOfInsulation
. - Moves
Slab/PerimeterInsulationDepth
toSlab/PerimeterInsulation/Layer/InsulationDepth
. - Moves
Slab/UnderSlabInsulationWidth
toSlab/UnderSlabInsulation/Layer/InsulationWidth
. - Moves
Slab/UnderSlabInsulationSpansEntireSlab
toSlab/UnderSlabInsulation/Layer/InsulationSpansEntireSlab
.
- Moves
- Allows modeling PTAC and PTHP HVAC systems.
- Allows additional fuel types for generators.
- Allows non-zero refrigerant charge defect ratios for ground source heat pumps.
- Allows CEER (Combined Energy Efficiency Ratio) efficiency unit for room AC.
- Allows specifying the foundation wall type (e.g., solid concrete, concrete block, wood, etc.).
- Removes error-check for number of bedrooms based on conditioned floor area, per RESNET guidance.
- Introduces a small amount of infiltration for unvented spaces.
ConditionedBuildingVolume
input is no longer needed (and removes error-check forInfiltrationVolume
relative to it).- Improves consistency of installation quality calculations for two/variable-speed air source heat pumps and ground source heat pumps.
Bugfixes
- Improves ground reflectance for window interior shading.
- 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 heating/cooling seasons (used for e.g. summer vs winter window shading) for the southern hemisphere.
- Relaxes
Overhangs
DistanceToBottomOfWindow vs DistanceToBottomOfWindow validation when Depth is zero. - Fixes possibility of "Construction R-value ... does not match Assembly R-value" error.