Releases: NREL/OpenStudio
OpenStudio v2.6.0
OpenStudio Version 2.6.0
Release Notes – 6/30/2018
These release notes describe version 2.6.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
- OpenStudio release documentation, including these release notes, tutorials, and other user documentation, is available at https://www.openstudio.net/.
- C++ API documentation is available at https://openstudio-sdk-documentation.s3.amazonaws.com/index.html.
- Measure development documentation is available at http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/.
Installation Notes
OpenStudio is supported on Windows 7 – Windows 10, OS X 10.10 – 10.11, and 64-bit Ubuntu 14.04.
OpenStudio 2.6.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.6.0.
OpenStudio 2.6.0 supports Radiance 5.0.a.12, which is bundled with the OpenStudio installer; users no longer must 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.6.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, http://nrel.github.io/OpenStudio-user-documentation/help/troubleshooting/.
Overview
OpenStudio SDK:
The 2.6.0 release of OpenStudio includes new features to help write better measures! The new measure templates have been updated to create a license and README.mb.erb for each new measure. When a measure is updated, the README.mb.erb is configured with information from the measure to create a README.md file which is the perfect place to document your measure. You can reference images or other content your measure’s docs/ folder from the README.md file to make your documentation really stand out. Additionally, a new option has been added to the OpenStudio CLI which runs the tests for all measures in a directory and saves a dashboard with results: openstudio measure -r /dir/to/measures/. This dashboard quickly shows all passing/failing tests as well as provide input on Ruby style using Rubocop. Code coverage will be added to the measure testing dashboard in a future release.
The following new model objects have been added to the OpenStudio SDK:
- GeneratorPVWatts
- ElectricLoadCenterInverterPVWatts
- PlantComponentUserDefined
- AirTerminalSingleDuctConstantVolumeFourPipeBeam
- CoilCoolingFourPipeBeam
- CoilHeatingFourPipeBeam
EMS Sensor and Actuator have been expanded to include SpaceLoads arguments. This will allow for correct EMS actuators on SpaceLoads that end up in ZoneLists in E+. The next release will expand on this capability.
OpenStudio Server:
OpenStudio Server has been updated to address several important issues:
- Fix cursor deleted with accessing /analyses//analysis_data
- Set version of mongo and redis for docker deploys
- Backend for Docker deployment now used Resque with Redis instead of delayed jobs.
- Large Uploads to Server (i.e. lots of weather files) seem to Timeout
OpenStudio Standards:
OpenStudio Standards has the following updates:
- Added additional DEER prototypes, including multifamily
- Added service hot water to DEER prototypes
- General bug fixes for DEER prototypes
Issue Statistics Since Previous Release
- 48 new issues were filed since the 2.5.0 release of OpenStudio (not including opened pull requests).
- 15 issues were closed since the 2.5.0 release of OpenStudio (not including closed pull requests).
OpenStudio v2.5.2
Get test results to show up when running from CLI
OpenStudio v2.5.1
Merge pull request #3112 from NREL/ems-enhancements resolve EMS Sensor issue 3102
OpenStudio v2.5.0
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
- OpenStudio release documentation, including these release notes, tutorials, and other user documentation, is available at https://www.openstudio.net/.
- C++ API documentation is available at https://openstudio-sdk-documentation.s3.amazonaws.com/index.html.
- Measure development documentation is available at http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/.
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
- The OpenStudio SketchUp Plug-in requires SketchUp 2017 (not available for Linux). The OpenStudio SketchUp Plug-in does not support older versions of SketchUp.
- 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, http://nrel.github.io/OpenStudio-user-documentation/help/troubleshooting/.
Overview
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.
EnergyPlus
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).
OpenStudio v2.4.3
Changing forward translation option back to Average for backwards com… …patibility
v2.4.2
Update PAT SHA
OpenStudio v2.4.1
Bump PAT SHA.
OpenStudio v2.4.0
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
- OpenStudio release documentation, including these release notes, tutorials, and other user documentation, is available at https://www.openstudio.net/.
- C++ API documentation is available at https://openstudio-sdk-documentation.s3.amazonaws.com/index.html.
- Measure development documentation is available at http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/.
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, http://nrel.github.io/OpenStudio-user-documentation/help/troubleshooting/.
Overview
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:
- GA (https://cran.r-project.org/web/packages/GA/GA.pdf) is a single objective Genetic Algorithm with hybrid gradient search that will added in a future release.
- GAIsl (https://cran.r-project.org/web/packages/GA/GA.pdf) is an Islands Genetic Algorithm where parallel independent GAs are executed in each island and only occasionally sparse exchanges of individuals are performed among the islands.
- fast99 (https://cran.r-project.org/web/packages/sensitivity/sensitivity.pdf) is the Extended Fourier Amplitude Sensitivity Test. fast99 implements the so-called "extended-FAST" method (Saltelli et al. 1999). This method allows the estimation of first order and total Sobol’ indices for all the factors.
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).
OpenStudio v2.3.1
Update version to 2.3.1
OpenStudio v2.3.0
OpenStudio Version 2.3.0
Release Notes – 9/30/2017
These release notes describe version 2.3.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
- OpenStudio release documentation, including these release notes, tutorials, and other user documentation, is available at https://www.openstudio.net/.
- C++ API documentation is available at https://openstudio-sdk-documentation.s3.amazonaws.com/index.html.
- Measure development documentation is available at http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/.
Installation Notes
OpenStudio is supported on Windows 7 – Windows 10, OS X 10.10 – 10.11, and 64-bit Ubuntu 14.04.
OpenStudio 2.3.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.3.0.
OpenStudio 2.3.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.3.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, http://nrel.github.io/OpenStudio-user-documentation/help/troubleshooting/.
Overview
The biggest new feature in OpenStudio 2.3.0 is the integration of the OpenStudio Geometry Editor in the OpenStudio Application. The OpenStudio Geometry Editor is a new, open source software module that developers can leverage to produce building energy modeling UIs that include geometry creation. The OpenStudio Geometry Editor is meant to cover simple building geometry use cases only. More complex building geometry is best developed in a full featured CAD tool and exported to gbXML for building energy modeling. The OpenStudio Geometry Editor is implemented in JavaScript with minimal dependencies, allowing it to be integrated into a wide range of applications. The OpenStudio Geometry Editor reads and writes a custom floorplan.json JSON file format. New methods have been added to the OpenStudio SDK, which can translate this file format to OSM. Additionally, new methods have been added to the SDK, which allows two OpenStudio Models to be merged. These new methods are demonstrated by integrating the Geometry Editor directly within the OpenStudio Application. The OpenStudio Geometry Editor and integration within the OpenStudio Application are experimental, and are not recommended for production workflows. However, we invite users to try these software components out and provide feedback to help us make them better for use by third party developers. Instructions for use are at: http://nrel.github.io/OpenStudio-user-documentation/reference/geometry_editor/
EnergyPlus
Openstudio now incorporates EnergyPlus Release 8.8, which provides additional speed improvements, as well as bug fixes.
OpenStudio
Through workspace code optimization, large HVAC model creation time has been reduced by roughly 75%. An example test model which originally took 416 seconds to create, took only 101 seconds after this code improvement.
DView
For many years, OpenStudio has included ResultsViewer to visualize timeseries data. In this release, ResultsViewer is now replaced by a visualization tool called DView which was originally developed for viewing residential building and solar energy simulation data. DView brings additional capabilities that ResultsViewer does not have, including IP unit conversion, CSV data import/export, image export, EPW weather file visualization, two synchronized views, stacked timeseries, average profiles, overview statistics, histograms, cumulative density plots, duration curves, and scatter plots.
Known Issues
DView is not currently available in Ubuntu packages. We hope to address this in the near future.
PAT's algorithmic method 'RGenoud' is unstable. A software patch will be provided once a fix is in place. Please use 'PSO' until it's fixed.
Issue Statistics Since Previous Release
- 81 new issues were filed since the 2.2.0 release of OpenStudio (not including opened pull requests).
- 42 issues were closed since the 2.2.0 release of OpenStudio (not including closed pull requests).