Assets 5

OpenStudio Version 2.4.0

Release Notes – 12/20/2017

These release notes describe version 2.4.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.4.0 supports EnergyPlus Release 8.8.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.4.0.

OpenStudio 2.4.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.4.0.

Installation Steps

  • The OpenStudio SketchUp Plug-in requires SketchUp 2017 (not available for Linux). The OpenStudio SketchUp Plug-in does not support older versions of SketchUp.
    • If the OpenStudio Plug-in does not automatically load in SketchUp, open the Window->Preferences->Extensions window in SketchUp and enable the OpenStudio plug-in if it is listed.
  • Download and install OpenStudio. Select components for installation.
  • Setup a Building Component Library (BCL) account to access online building components and measures. View instructions on how to setup your account and configure the key in OpenStudio.

For help with common installation problems please visit,


OpenStudio SDK:

OpenStudio HVAC capability was extended with the following additions:

  • New Model API AirLoopHVACUnitarySystem::setControlType
  • Allow AirLoopHVACUnitarySystem object as Zone HVAC Equipment
  • Added support for more E+ fields in pump objects
  • Added new Model object, AirTerminalDualDuctVAVOutdoorAir
  • Added support for more E+ fields in cooling tower objects
  • Added support for more E+ fields in the AvailabilityManagerNightCycle object.
  • Allow ZoneHVACTerminalUnitVariableRefrigerantFlow to be configured without a heating coil

Many new external interface objects have been wrapped and are available in the API:

  • OS:ExternalInterface
  • OS:ExternalInterface:Schedule
  • OS:ExternalInterface:Variable
  • OS:ExternalInterface:Actuator
  • OS:ExternalInterface:FunctionalMockupUnitImport
  • OS:ExternalInterface:FunctionalMockupUnitImport:From:Variable
  • OS:ExternalInterface:FunctionalMockupUnitImport:To:Schedule
  • OS:ExternalInterface:FunctionalMockupUnitImport:To:Actuator
  • OS:ExternalInterface:FunctionalMockupUnitImport:To:Variable
  • OS:ExternalInterface:FunctionalMockupUnitExport:From:Variable
  • OS:ExternalInterface:FunctionalMockupUnitExport:To:Schedule
  • OS:ExternalInterface:FunctionalMockupUnitExport:To:Actuator
  • OS:ExternalInterface:FunctionalMockupUnitExport:To:Variable

The Energy Management System (EMS) Actuator actuatedComponent method was changed to return an Optional to handle cases where the modelObject is deleted during Forward Translation without the knowledge of the actuator.

EMS Actuators can now be constructed with SpaceLoads. To use, pass a SpaceLoad object to the constructor and the Actuator will be attached to the “ThermalZone SpaceLoad” object as required by the Actuator naming convention.

The EMS Sensor constructor was changed to use the OutputVariable keyValue if it is not defaulted (since * is not a valid value for EMS)

OS:Output:Variable, OS:EnergyManagementSystem:OutputVariable, OS:ExternalInterface:Schedule, OS:ExternalInterface:Variable, OS:ExternalInterface:Actuator have received the new IDD field “Export To BCVTB” which defaults to “True”. If set to true, it will add the variable or external interface object to the variable.cfg file that is now auto-generated on E+ translation. Note: the order of the variables in the file is not guaranteed to remain the same between different translations, however it can be easily hand-edited.

The OpenStudio SDK now includes the EMPD (Effective Moisture Penetration Depth) model, a simplified approach to simulate surface moisture adsorption and desorption.

OpenStudio Server

Several new algorithms have been added to the OpenStudio Server and are available through PAT:

Existing OpenStudio Server algorithms received the following improvements:

  • Morris R2 parameter is available for using the Campolongo space filling improvement.
  • Sobol now has the following methods available for computing Sobol indices:
    • Sobol
    • Sobol2002
    • Sobol2007
    • Jansen
    • Mara
    • Martinez
  • 'random_seed' is now an algorithm level parameter and can be set for reproducibility across analyses. The default value is nil which makes repeated runs non-deterministic.
  • R is now using version 3.4.2.
  • Rserve is now using version 1.8-4.

Known Issues

DView is not currently available in Ubuntu packages. We hope to address this in the near future.

Issue Statistics Since Previous Release

  • 51 new issues were filed since the 2.3.0 release of OpenStudio (not including opened pull requests).
  • 156 issues were closed since the 2.3.0 release of OpenStudio (not including closed pull requests).