@evanweaver evanweaver released this Mar 30, 2018 · 937 commits to master since this release

Assets 5

OpenStudio Version 2.5.0

Release Notes – 3/30/2018

These release notes describe version 2.5.0 of the OpenStudio software suite developed by the National Renewable Energy Laboratory (NREL), Buildings and Thermal Systems, Commercial Buildings Research Group, Tools Development Section, and associated collaborators. The notes are organized into the following sections:

  • Where to Find OpenStudio Documentation
  • Installation Notes
  • Overview

Where to Find OpenStudio Documentation

Installation Notes

OpenStudio is supported on Windows 7 – Windows 10, OS X 10.10 – 10.11, and 64-bit Ubuntu 14.04.

OpenStudio 2.5.0 supports EnergyPlus Release 8.9.0, which is bundled with the OpenStudio installer. It is no longer necessary to download and install EnergyPlus separately. Other builds of EnergyPlus are not supported by OpenStudio 2.5.0.

OpenStudio 2.5.0 supports Radiance 5.0.a.12, which is bundled with the OpenStudio installer; users no longer have to install Radiance separately, and OpenStudio will use the included Radiance version regardless of any other versions that may be installed on the system. Other builds of Radiance are not supported by OpenStudio 2.5.0.

Installation Steps

For help with common installation problems please visit, http://nrel.github.io/OpenStudio-user-documentation/help/troubleshooting/.


OpenStudio SDK

OpenStudio now includes the generic AdditionalProperties object that can be used to apply user-defined properties to objects in the OSM. These properties do not directly change the model in any way nor are they forward-translated to EnergyPlus. Rather they can be used by measures to apply logic.

OpenStudio also now includes the Kiva foundation heat transfer calculation tool, a two-dimensional finite difference approach for determining convective heat gains and temperatures for foundation surfaces.

All Energy Management System (EMS) actuators and sensors are now available in the OpenStudio SDK through the methods emsActuatorNames() and emsInternalVariables().

ExteriorFuelEquipment, ExteriorWaterEquipment, and their associated definition objects (ExteriorFuelEquipmentDefinition, ExteriorWaterEquipmentDefinition) have been added to OpenStudio. All exterior equipment, including the existing ExteriorLights (and ExteriorLightsDefinition) now have the same parent classes: ExteriorLoadInstance and ExteriorLoadDefinition.

Preliminary support for the EnergyPlus AirflowNetwork feature is now provided in OpenStudio. Envelope leakage and core elements of distribution networks are supported. Changes are expected to support ongoing enhancements of the AirflowNetwork model (e.g. multiple air loops).

OpenStudio Server

OpenStudio Server has been updated addressing several issues with simulations not completing or running indefinitely.

OpenStudio Standards

Added initial support for the CA DEER Prototype buildings. Refactored codebase to make the addition of new standards easier and more isolated from other code. Added support for additional HVAC systems that can be used for model articulation.


Openstudio now incorporates EnergyPlus Release 8.9, which provides new capabilities, and numerous bug fixes.

Known Issues

  • Radiance Daylighting Measure - The Radiance Daylighting Measure is incompatible with EnergyPlus 8.9 (writing results will cause a segfault); we are working on a fix.

  • EnergyPlus no longer allows non-unique names, and while OpenStudio provides unique names for most objects, it does not for objects that do not belong to a reference group. Future OpenStudio SDK changes will ensure that all objects belong to a reference group.

Issue Statistics Since Previous Release

  • 120 new issues were filed since the 2.4.0 release of OpenStudio (not including opened pull requests).
  • 205 issues were closed since the 2.4.0 release of OpenStudio (not including closed pull requests).