Skip to content

Releases: NREL/OpenStudio

OpenStudio v3.2.1

25 Jun 14:06
@tijcolem tijcolem
v3.2.1
bdbdbc9
Compare
Choose a tag to compare
OpenStudio v3.2.1

OpenStudio Version 3.2.1

Changes since 3.2.0

  • #4307 - Standardize Curve IDD references like E+ does (Uni/Bi...variateFunctions) and remove hard check in model code
  • 4337 - Fix Encode searchTerm in BCL (including spaces, not only "+" signs)
  • #4344 - Update openstudio-gems for new versions of measure-tester-gem (v0.3.1), openstudio-extension-gem (v0.4.3), openstudio-workflow-gem (v2.2.1) and openstudio-standards (v0.2.14).
  • #4332 - Fix StringHelpers openstudio::replace
  • #4326 - Fix Wrap E+ WaterHeater:Sizing object
  • #4324 - FIx Do not Warn if Sql doesn't have a Year field
  • #4319 - Fix Wrap E+ FuelFactors object
  • #4302 - Fix Deprecation Warning of last argument as keyword parameters

OpenStudio Standards v0.2.14

  • Added comstock 2016 and 2019 templates
  • Fixed a coil reference for radiant systems
  • Fixed a method name compatibility issue for VAV terminals for OS v3.0.0 and earlier
  • Adjusted radiant fractions for lighting to better reflected lighting fractions in newer lighting technology
Assets 11
Loading

OpenStudio v3.2.0

04 May 17:11
@tijcolem tijcolem
v3.2.0
e11f0a0
Compare
Choose a tag to compare
OpenStudio v3.2.0

OpenStudio Version 3.2.0

Release Notes - 05/04/2021

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

  • Overview
  • Where to Find OpenStudio Documentation
  • Installation Notes
  • OpenStudio SDK: Changelog

Overview

As of April 2020, development and distribution of the OpenStudioApplication and the SketchUp plugin have transitioned to the OpenStudio Coalition, who is independently managing and distributing the software through its own openstudiocoalition/OpenStudioApplication repository. The OpenStudio SDK is continuing to be actively developed and distributed by NREL and is released two times per year, through a spring and a fall release.

Below is the list of components that is included in this SDK installer:

OpenStudio SDK 3.2.0

  • EnergyPlus
  • Command Line Interface (CLI)
  • Radiance
  • Ruby API
  • C++ SDK

Note that PAT is not included in either the SDK or the OpenStudio Coalition's Application installers. You will need to install PAT separately which is distributed on the OpenStudio-PAT GitHub page.

Where to Find OpenStudio SDK Documentation

Installation Notes

OpenStudio SDK 3.2.0 is supported on 64-bit Windows 7 – 10, OS X 10.14 – 10.15, and Ubuntu 18.04, 20.04

OpenStudio SDK 3.2.0 supports EnergyPlus Release 9.5, 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 SDK 3.2.0.

OpenStudio SDK 3.2.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 SDK 3.2.0.

OpenStudio SDK 3.2.0 now uses Ruby 2.7.2 as the supported version (2.5.5 previously in the 3.x series, and 2.2.4 for 2.x series).

As usual, you can refer to the OpenStudio SDK Compatibility Matrix for more information.

Installation Steps

  • Download and install OpenStudio SDK and/or openstudiocoalition/OpenStudioApplication depending on your needs. Select components for installation. Note that OpenStudio Application is a standalone app and does not require you to install OpenStudio SDK.
  • 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.
  • The OpenStudio Application SketchUp Plug-in requires SketchUp 2019 (not available for Linux). The OpenStudio Application SketchUp Plug-in does not support older versions of SketchUp. SketchUp must be installed before OpenStudio Application to automatically activate the plugin. If you install SketchUp after OpenStudio Application, simply rerun the OpenStudio Application installer.

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

OpenStudio SDK: Changelog

The 3.2.0 is a major release. This update includes several new features, performance improvements, and bug fixes.
You can find the list of Pull Requests that got into this release here.

Update to Ruby 2.7.2

OpenStudio SDK now comes with Ruby 2.7.2 (#4207) which provides many improvements over the previous version, v2.5.5, such as pattern matching, REPL improvement, compaction GC, separation of positional and keyword arguments, and security related improvements.

To see the full list of Ruby updates and improvements, please refer to the official ruby release notes.

Python Bindings

New for OpenStudio SDK is support for Python bindings ( #4122). OpenStudio users can now use the popular Python Programming language across supported platforms to interface with OpenStudio SDK. Users can install the bindings using the Python package tool called pip. To install, users will need to have Python3 installed along with pip and simply run the following command in a terminal window.

pip install openstudio==3.2.0

Please see openstudio on PyPi for further instructions on how to install. Users can also visit the test channel at https://test.pypi.org/project/openstudio/ to install development bindings.

New Features, Major Fixes and API-breaking changes

A number of new features and API-breaking changes have been implemented in OpenStudio SDK 3.2.0:

  • #4271 - Update to EnergyPlus v9.5.0

    • Most of the actual changes were done in #4212 - Update to V9.5.0-IOFreeze

  • New objects:

    • #4155 - Wrap Humidifier:Stream:Gas in OS SDK
    • #4157 - Wrap ZoneHVAC:CoolingPanel:RadiantConvective:Water in OS SDK
    • #4159 - Wrap Refrigeration:ComporessorRack in OS SDK
    • #4186 - Wrap Chiller:Electric:ReformulatedEIR in OS SDK
    • #4192 - Wrap Generator:WindTurbine in OS SDK
    • #4193 - Wrap Fan:ComponentModel in OS SDK
    • #4194 - Wrap PhotovoltaicPerformance:Sandia in OS SDK
      • The recommended instantiation is via the factory methods GeneratorPhotovoltaic::sandia(const Model&) or GeneratorPhotovoltaic::fromSandiaDatabase(const Model&, const std::string& sandiaModulePerformanceName) where sandiaModulePerformanceName is one of keys in the now-embedded Sandia database. Please use the PhotovoltaicPerformanceSandia::sandiaModulePerformanceNames() static method to lookup the valid names.
    • #4225 - Wrap ElectricLoadCenter:Storage:LiIonNMCBattery in OS SDK
    • #4236 - Wrap CoilSystem:IntegratedHeatPump:AirSource and Coil:WaterHeating:AirToWaterHeatPump:VariableSpeed in OS SDK
    • #4258 - Wrap ZoneInfiltration:FlowCoefficient in OS SDK.
      • This object is wrapped as SpaceInfiltrationFlowCoefficient and is a SpaceLoad

  • #4199 - Add support for translating a Workspace/IdfFile to epJSON

  • #4253 - Allow ZoneHVAC:TerminalUnit:VariableRefrigerantFlow to connect to AirLoopHVAC

  • #4180 - Fixes #4175, issues with ft for ElectricLoadCenter:Distribution

    • ElectricLoadCenterDistribution objects are now possible with no generators / transformers
    • A default ElectricLoadCenterDistribution is no longer instantiated in the constructor of children objects: GeneratorFuelCell, GeneratorMicroTurbine, GeneratorPhotovoltaic, GeneratorPVWatts

  • #4153 - Fix #3532 #4152 - Make heating/cooling coils optional for ZoneHVACLowTempVariableFlow and add missing fields to coils

    • This is an API breaking change, the coils are now optional so the getters have been modified to account for this.
    - HVACComponent heatingCoil() const;
+ boost::optional<HVACComponent> heatingCoil() const;
- HVACComponent coolingCoil() const;
+ boost::optional<HVACComponent> coolingCoil() const;

  • #4221 - Geometry improvements including fixing intersection issues

Minor changes:

  • #4136 - Fix #4125, Fix #4135 - GbXML ForwardTranslator: clear map&set, and add a modelToGbXMLString method
  • #4137 - Addresses #4076, radiant system enhancements
  • #4149 - Addresses #3706, add drain water heat exchanger methods to WaterUseConnections
  • #4188 - Fix #...
Read more
Assets 11
Loading

OpenStudio v3.1.0

16 Oct 23:19
@tijcolem tijcolem
v3.1.0
e165090
Compare
Choose a tag to compare
OpenStudio v3.1.0

OpenStudio Version 3.1.0

Release Notes - 10/16/2020

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

  • Overview
  • Where to Find OpenStudio Documentation
  • Installation Notes
  • OpenStudio SDK: Changelog

Overview

As of April 2020, development and distribution of the OpenStudioApplication and the SketchUp plugin have transitioned to the OpenStudio Coalition, who is independently managing and distributing the software through its own openstudiocoalition/OpenStudioApplication repository. The OpenStudio SDK is continuing to be actively developed and distributed by NREL and is released two times per year, through a spring and a fall release.

Below is the list of components that is included in this SDK installer:

OpenStudio SDK 3.1.0

  • EnergyPlus
  • Command Line Interface (CLI)
  • Radiance
  • Ruby API
  • C++ SDK

Note that PAT is not included in either the SDK or the OpenStudio Coalition's Application installers. You will need to install PAT separately which is distributed on the OpenStudio-PAT GitHub page.

Where to Find OpenStudio SDK Documentation

Installation Notes

OpenStudio SDK 3.1.0 is supported on 64-bit Windows 7 – 10, OS X 10.14 – 10.15, and Ubuntu 18.04.

OpenStudio SDK 3.1.0 supports EnergyPlus Release 9.4, 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 SDK 3.1.0.

OpenStudio SDK 3.1.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 SDK 3.1.0.

OpenStudio SDK 3.x now uses Ruby 2.5.5 as the supported version (2.2.4 previously).

As usual, you can refer to the OpenStudio SDK Compatibility Matrix for more information.

Installation Steps

  • Download and install OpenStudio SDK and/or openstudiocoalition/OpenStudioApplication depending on your needs. Select components for installation. Note that OpenStudio Application is a standalone app and does not require you to install OpenStudio SDK.
  • 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.
  • The OpenStudio Application SketchUp Plug-in requires SketchUp 2019 (not available for Linux). The OpenStudio Application SketchUp Plug-in does not support older versions of SketchUp. SketchUp must be installed before OpenStudio Application to automatically activate the plugin. If you install SketchUp after OpenStudio Application, simply rerun the OpenStudio Application installer.

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

OpenStudio SDK: Changelog

The 3.1.0 is a major release. This update includes several new features, performance improvements, and bug fixes.
You can find the list of Pull Requests that got into this release here.

New Features, Major Fixes and API-breaking changes

A number of API-breaking changes have been implemented in OpenStudio SDK 3.1.0:

  • #3960 - Added support for building the C# bindings via dotnet CLI, including on Unix platforms
  • #3966 - Closes #3945 - Support the EnergyPlus object SurfaceControl:MovableInsulation which can be used to add insulation surface(s) on top of opaque surfaces, such as a transparent coating that affects the radiative gains to a roof surface
  • #3959 - Also included some improvements in the generated C# bindings by reducing build warnings and properly exposing some types via SWIG
    • ScheduleTypeKey (which is normally only use by OpenStudio internals in ScheduleTypeRegistry checks) previously mapped to a std::pair<std::string, std::string> which was SWIGed in ruby as an Array of strings of size two, but improperly exposed in C#. It now uses a dedicated helper class with two methods ScheduleTypeKey::className() and ScheduleTypeKey::scheduleDisplayName()
  • #3987 - Closes #3907 - Support new Coil:Cooling:DX, Coil:Cooling:DX:CurveFit:Performance, Coil:Cooling:DX:CurveFit:OperatingMode, Coil:Cooling:DX:CurveFit:Speed objects
  • #4009 - Closes #4006 - Add SwimmingPool:Indoor to SDK
  • #4050 - Fixes #3921 - Some children of RefrigerationSystem can be added several times and produce a fatal when System is removed
    • RefrigerationSystem will now be enforcing unicity for all children. This was already the case for a few of the child objects such as Case and WalkIns, it is now the case for all objects (RefrigerationCondenserCascade, RefrigerationSubcoolerMechanical and RefrigerationSubcoolerLiquidSuction, etc.). What this means is that setter methods (or add methods in case of a list) will remove the child for any current RefrigerationSystem it is on first.
  • #4066 - Multiple shading controls referenced by a single subsurface
    • SubSurface was historically the one referencing the ShadingControl object. Now it's a many-to-many relationship where ShadingControl has an extensible 'Sub Surface Name' field, and multiple ShadingControl objects can reference the same SubSurface. This is trickling down from a change introduced in EnergyPlus version 9.4, and specifically in PR NREL/EnergyPlus#8196
    • Methods in SubSurface have been deprecated but are kept for backward compatibility. They will be removed in a future version of OpenStudio:
      • shadingControl(): prefer shadingControls()
      • setShadingControl(ShadingControl&): use addShadingControl(SubSurface&), addShadingControls(std::vector<SubSurface>&) or setShadingControls(std::vector<SubSurface>&)
      • resetShadingControl(): use removeAllShadingControls() instead
    • All Shading Control Type values should now be supported. Refer to issue #4074 for more information
    • Fields 'Glare Control Is Active', 'Type of Slat Angle Control for Blinds', 'Slat Angle Schedule Name', 'Setpoint2', and 'Multiple Surface Control Type' are now implemented as well
  • #4026 - Fix OpenStudio Windows crashed during save attempt
  • #4028 - Fixes #3835 - Decrease overall load time of CLI and lazy load OpenStudio ruby bindings when possible
  • #4059 - Add new OutputControl:Files object to SDK, which allows conditionally turning on/off output from EnergyPlus
  • #4101 - Update EnergyPlus v940 official

Minor changes:

  • #3961 - Update cmake to use included FindPython method and fix zlib's crypt.h
  • #3970 - Update conan dependency fmt/6.2.0 and use option to define FMT_HEADER_ONLY
  • #3979, #4004, #4071 - Update openstudio-gems to include openstudio-extension v0.3.0, openstudio-workflow v2.1.0, openstudio-standards v0.2.12, openstudio_measure_tester v0.2.3
  • #4015, #4047- Updates the conan dependencies to try and pin version using hash
  • #4027 - Include 64/32 bit universal nuget package in cmake build process.
  • #4029 - Closes [#3832](https://github.com/...
Read more
Assets 8
Loading

OpenStudio v3.0.1

26 Jun 18:22
@tijcolem tijcolem
v3.0.1
09b7c8a
Compare
Choose a tag to compare
OpenStudio v3.0.1 
tag and release 3.0.1
Assets 8
Loading

OpenStudio v3.0.0

27 Apr 14:49
@tijcolem tijcolem
v3.0.0
1c9617f
Compare
Choose a tag to compare
OpenStudio v3.0.0

OpenStudio Version 3.0.0

Release Notes - 4/24/2020

These release notes describe version 3.0.0 of the OpenStudio SDK 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:

  • Overview
  • Where to Find OpenStudio Documentation
  • Installation Notes
  • OpenStudio SDK: Changelog

Overview

Following an important announcement related to future development of the OpenStudio Application released in September 2019 (A Shift in BTO’s BEM Strategy: A New Future for the OpenStudio Application), this release marks the first installment of the separated OpenStudio SDK from the Application.
Going forward, the SDK will continue to be distributed and released two times per year, in April and October. Development of the OpenStudioApplication has been moved to its own NREL/OpenStudioApplication GitHub.

Below is the list of components that is included in this SDK installer:

OpenStudio SDK 3.0.0

  • EnergyPlus
  • Command Line Interface (CLI)
  • Radiance
  • Ruby API
  • C++ SDK

Note that PAT and DView are not included in either the SDK or Application installers. You will need to install PAT separately which is distributed on the OpenStudio-PAT GitHub page and DView at the Dview home page.

Long-Term Support of 2.x version: 2.9.X-LTS

This new major release is bringing a lot of changes not the least of which is the separation of the OpenStudioApplication as well as some API breaking changes.
Only critical bug-fixes will be implemented in the LTS branch and no new features will be developed. The supported EnergyPlus version will remain 9.2.0 in the LTS branch. We encourage users to transition to the 3.x version of OpenStudio.

Where to Find OpenStudio Documentation

Installation Notes

OpenStudio 3.0.0 is supported on 64-bit Windows 7 – 10, OS X 10.12 – 10.15, and Ubuntu 18.04.

OpenStudio 3.0.0 supports EnergyPlus Release 9.3, 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 3.0.0.

OpenStudio 3.0.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 3.0.0.

OpenStudio 3.x now uses Ruby 2.5.5 as the supported version (2.2.4 previously).

As usual, you can refer to the OpenStudio Compatibility Matrix for more information.

Installation Steps

  • Download and install OpenStudio SDK and/or [OpenStudioApplication]( depending on your needs. Select components for installation. Note that OpenStudio Application is a standalone app and does not require you to install OpenStudio SDK.
  • 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.
  • The OpenStudio Application SketchUp Plug-in requires SketchUp 2019 (not available for Linux). The OpenStudio Application SketchUp Plug-in does not support older versions of SketchUp. SketchUp must be installed before OpenStudio Application to automatically activate the plugin. If you install SketchUp after OpenStudio Application, simply rerun the OpenStudio Application installer.

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

OpenStudio SDK: Changelog

The 3.0.0 is a major release
The 3.0.0 release updates OpenStudio to use EnergyPlus 9.3. This update includes several new features, performance improvements, and bug fixes.
You can find the list of Pull Requests that got into this release here.

New Features, Major Fixes and API-breaking changes

A number of API-breaking changes have been implemented in OpenStudio 3.0:

  • Updated EnergyPlus from v9.2.0 to v9.3.0

  • (#3044) Added support for FanSystemModel to the Model API

  • ThermalZone::addEquipment is no longer exposed to the bindings to avoid confusion and problems, as you should always use ZoneHVACComponent::addToThermalZone instead (#2920, #3758)

  • #3814 - Add ability to create Holiday Schedules in ScheduleRuleset

  • #3882 - Add methods to edit Output:Table:SummaryReports in OpenStudio SDK

  • #3875 - Add OutputDiagnostics, OutputDebuggingData and OutputJSON to model SDK

  • #3853 - Fixes bug where MasslessOpaqueMaterial incorrectly had methods for setting and getting conductivity, density, and specific heat

  • #3744 - New native extension gems have been added into the CLI:

    • pycall v1.2.1 - Allows for calling Python functions from the Ruby language
    • sqlite3 v1.3.13 - Ruby bindings for the SQLite3 embedded database
    • Oga v3.2 - Oga is an XML/HTML parser written in Ruby
    • jara_winker v.1.5.4 - implementation of Jaro-Winkler distance algorithm needed for newer versions of rubocop >= v0.80.0

  • #23 - Updated extension gems have been added into the CLI:

    • bundler v2.1.0
    • openstudio-extension v0.2.1
    • openstudio-workflow v2.0.0
    • openstudio-standards v0.2.11
    • openstudio_measure_tester v0.2.2

  • #3796 - Reporting Measure: you can now pass model to the arguments() method of a reporting measure, for easier setup of output variables

  • #3847 - Chiller:Electric:EIR node API refactor, ChillerAbsorption/ChillerAbsorption tertiary node refactor

    • ChillerElectricEIR::designHeatRecoveryWaterFlowRate() now returns an OptionalDouble instead of a double since it can be now be autosized
    • ChillerElectricEIR no longer has getter/setters that set/return std::string for Node Names. It also wraps two new E+ fields: "Condenser Heat Recovery Relative Capacity Fraction", "Heat Recovery Inlet High Temperature Limit Schedule Name" and "Heat Recovery Leaving Temperature Setpoint Node Name"
    • Added missing Tertiary nodes for ChillerAbsorption
    • For ChillerAbsoprtion, ChillerAbsoprtionIndirect, ChillerElectricEIR:
      • addToTertiaryNode overriden to only allow supply side connection.
      • addToNode overriden to connect to tertiary loop if primary loop is already connected, and Node to connect to is on the supply side of a different plant loop than the current primary loop

  • #3913 - E+ 9.3.0: Update ShadowCalculation to match object refactor in EnergyPlus

    • ShadowCalculation::calculationMethod was renamed to ShadowCalculation::shadingCalculationUpdateFrequencyMethod (same for setter, defaulted, and reset methods)
    • ShadowCalculation::calculationFrequency was renamed to ShadowCalculation::shadingCalculationUpdateFrequency (same for setter, defaulted, and reset methods)
    • ShadowCalculation::polygonClippingAlgorithm() and ShadowCalculation::skyDiffuseModelingAlgorithm(): return type changed from OptionalString (which was always initialized) to std::string
    • All new fields in E+ 9.3.0 were also added

Minor changes:

  • #3846 - SiteWaterMainsTemperature now defaults to the CorrelationFromWeatherFile Calculation Method just like in EnergyPlus.
  • #3846 - BoilerHotWater "Design Water Outlet Temperature" field to match E+
  • #3868 - Fix an error when querying surfaces() of ZoneHVACLowTemperature objects and surfaces have no construction
  • #3844 - Fix crash in FT for HeatPumpWaterToWaterEquationFitCooling/Heating when they reference each other as companion coils
  • #3871 - Remove deprecated Active Year/Institution fields in OS:ClimateZones
  • #3878 - Reporting Frequencies (eg: for OutputVariable) now differentiates between `RunP...
Read more
Assets 8
Loading

OpenStudio v2.9.1

06 Dec 23:36
@tijcolem tijcolem
v2.9.1
3472e8b
Compare
Choose a tag to compare
OpenStudio v2.9.1 
v2.9.1
Assets 5
Loading

OpenStudio SDK v3.0.0-pre1 and OpenStudio Application v1.0.0-pre1

20 Nov 20:23
@tijcolem tijcolem
v3.0.0-pre1
5cfb363
Compare
Choose a tag to compare
OpenStudio SDK v3.0.0-pre1 and OpenStudio Application v1.0.0-pre1 Pre-release
Pre-release

Release Notes - 11/20/2019

This is a pre-release of both OpenStudio SDK v3.0.0-pre1 and OpenStudio Application (GUI) v1.0.0-pre1 developed by the National Renewable Energy Laboratory (NREL), Buildings and Thermal Systems, Commercial Buildings Research Group, Tools Development Section, and associated collaborators.

This pre-release marks the first installment of the separated OpenStudio SDK from the Application. Going forward, once OpenStudio SDK v3.0.0 is officially released (mid-April 2020), the SDK and Application will be distributed as separate applications and will be released on different schedules.

Below is a list of components that will be included in each respective installer:

OpenStudio SDK 3.0.0-pre1

  • EnergyPlus
  • Command Line Interface (CLI)
  • Radiance
  • Ruby API

OpenStudio Application 1.0.0-pre1

  • OpenStudio Application (GUI)
  • RubyAPI
  • Application Resources
  • EnergyPlus
  • Radiance
  • Command Line Interface (CLI)

Note that PAT will no longer be included in either the SDK or Application installers. You will need to install PAT separately which will be posted on the PAT GitHub page (coming soon).

OpenStudio SDK 3.0.0-pre1 and OpenStudio Application v1.0.0-pre1 are supported on 64-bit Windows 7 – 10, OS X 10.12 – 10.14, and Ubuntu 18.04.

Both the SDK 3.0.0-pre1 and Application v1.0.0-pre1 support EnergyPlus Release 9.2, which is bundled with the installers. It is no longer necessary to download and install EnergyPlus separately. Other builds of EnergyPlus are not supported.

Both support Radiance 5.0.a.12, which is bundled with the installers; 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.

Installation Steps

  • Download and install OpenStudio SDK and/or Application depending on your needs. Select components for installation. Note that OpenStudio Application is a standalone app and does not require you to install OpenStudio SDK.
  • 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.
  • The OpenStudio Application SketchUp Plug-in requires SketchUp 2019 (not available for Linux). The OpenStudio Application SketchUp Plug-in does not support older versions of SketchUp. SketchUp must be installed before OpenStudio Application to automatically activate the plugin. If you install SketchUp after OpenStudio Application, simply rerun the OpenStudio Application installer.

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

Overview

You can follow announcements related to future development of the OpenStudio Application, which is available at: https://www.openstudio.net/new-future-for-openstudio-application. Please send any questions, comments, or concerns to [email protected] and we will try our best to address them.

Note that this pre-release includes all of the same features included in the 2.9.0 release. Please review the 2.9.0 release notes for information on new features, performance improvements, and bug fixes. It does not contain any new features and/or bug fixes. The official release scheduled for April 2020 will contain new features, improvements and bug fixes.

Assets 8
Loading

OpenStudio v2.9.0

11 Oct 19:52
@tijcolem tijcolem
v2.9.0
801faa4
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
OpenStudio v2.9.0

OpenStudio Version 2.9.0

Release Notes - 10/11/2019

These release notes describe version 2.9.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 2.9.0 is supported on 64-bit Windows 7 – 10, OS X 10.11 – 10.14, and Ubuntu 16.04.

OpenStudio 2.9.0 supports EnergyPlus Release 9.2, 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.9.0.

OpenStudio 2.9.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.9.0.

Installation Steps

  • The OpenStudio SketchUp Plug-in requires SketchUp 2017 or 2018 (not available for Linux). OpenStudio 2.9.0 is not compatible with SketchUp 2019. The OpenStudio 3.0 prerelease in October 2019 will be the first version of OpenStudio compatible with SketchUp 2019. The OpenStudio SketchUp Plug-in does not support older versions of SketchUp. SketchUp must be installed before OpenStudio to automatically activate the plugin. If you install SketchUp after OpenStudio, simply rerun the OpenStudio installer.
  • 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

An important announcement related to future development of the OpenStudio Application is available at: https://www.openstudio.net/new-future-for-openstudio-application. Please read this announcement carefully to understand changes coming for the OpenStudio Application over future releases. Please send any questions, comments, or concerns to [email protected] and we will try our best to address them.

OpenStudio SDK:

The 2.9.0 release updates OpenStudio to use EnergyPlus 9.2. This update includes several new features, performance improvements, and bug fixes.

Updates, Improvement and Fixes:

  • Added missing methods to model API, FT, RT and VT for HeaderedPumpsConstantSpeed and HeaderedPumpsVariableSpeed (#3553). These fields are related to the Design Sizing Method and allow you to enter electric power per flow rate, or per flow rate and head.
  • Updated spider gbXML viewer (#3668)
  • Added new Fields in AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass (#3639). Added a new ‘Priority Control Mode’ choice LoadPriority, added the ‘Minimum Runtime Before Operating Mode Change’ field, and the ‘Plenum or Mixer Inlet Node Name’. For the latter, you can use AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass::setPlenumorMixer(const Mixer& returnPathComponent) to connect it to a AirLoopHVAC:Mixer or a AirLoopHVAC:ReturnPlenum object.
  • Added ‘Temperature Difference Between Cutout And Setpoint’ for ZoneControl:Thermostat (#3584). This field is added to the ThermostatSetpointDualSetpoint class and handled during ForwardTranslation
  • Translate AirWalls to Construction:AirBoundary (#3635)
  • Added ThermalStorage:Ice:Detailed Charging and Discharging Curve Variable Specifications (#3654)
  • Updated EnergyPlus from v9.1 to v9.2
  • Display plantLoop supply equipment in OpenStudioApplication in the same order as the resulting PlantEquipmentList after ForwardTranslaton (#3600)
  • Updated idf translator for E+ change Table:MultiVariableLookup (#3651) In Energyplus version 9.2.0, the table objects such as Table:MultiVariableLookup object were replaced with a new Table:Lookup object. The corresponding OpenStudio API remains the same using TableMultiVariableLookup, and the appropriate adjustments have been made to OpenStudio's EnergyPlus translator to create valid Table:Lookup objects. For more information please review the New Feature Proposal for EnergyPlus https://github.com/NREL/EnergyPlus/blob/v9.2.0/design/FY2018/NFP-Table-Refactor.md.
  • Display non-zero north angle (#3594)
  • Adds ‘Calculation Method’ field to ShadowCalculation (#3571)
  • Allow AirConditioner:VariableRefrigerant condenser Type=WaterCooled (and EvaporativelyCooled (#3604). VRFs can now be connected to the demand side of a PlantLoop, including in the OpenStudioApplication directly, be sure to update the performance curves if you do so.
  • Fixed Import ScheduleFile from IDF (#3347)
  • Added gbXMLId and improving CADObjectId import (#3555, #3554)
  • Fixes crash in CLI if json native gem is installed (#3590)
  • ForwardTranslate End Use by Subcategory for Fan:VariableVolume and Fan:ConstantVolume (#3591)
  • Fix FloorspaceJS json north axis not being imported into OS model (#3585)
  • Added exportToBCVTB field to EnergyManagementSystemGlobalVariable (#3420)
  • Fix crash when leaving tabs with combobox2 (#2792)
  • Use Custom Blocks in Foundation Kiva which implements use of custom blocks in the Foundation:Kiva object. Custom blocks can be used to represent solid materials in the two-dimensional context that are not otherwise covered by the other Foundation:Kiva fields (#3567)
  • Add more heating source object type and tank object type enumerations for Coil:WaterHeating:Desuperheater object (#3565, #3647)
  • Wrap ZoneProperty:UserViewFactors:bySurfaceName object which allows users to specify the thermal radiation exchange view factors between surfaces in a zone (#3664, #3671)
  • Wrap PerformancePrecisionTradeoffs object which enables users to choose certain options that speed up EnergyPlus simulations (#3631)
  • Change the Sequential Load Fractions on ZoneHVAC:EquipmentList into schedules (#3583)
  • ScheduleFixedInterval now with option to translate schedule to ScheduleFile using new CSVFile class (#50, #3610)

OpenStudio Server:

  • Resolved gem dependencies issues for faraday and nio4r

OpenStudio Standards:

  • Split standards data spreadsheet into multiple spreadsheets for each class of standards (e.g. DEER, 90.1)
  • Split standards space types data spreadsheet into multiple spreadsheets to allow notes on individual fields
  • Split out standards data into individual files per standard
  • Added ComStock DEER templates to represent actual building performance in California
  • Added laboratory prototype model
  • Enabled DOE Prototype regression tests
  • Multiple changes to better align openstudio-standards with the PNNL DOE Prototype .idf models
  • Add data and methods for water source heat pump efficiency
  • Added typical refrigeration methods to populate grocery store refrigeration
  • Added additional properties to lighting objects specifying the LPD fraction that is linear, highbay, specialty, or exit lighting
  • Parameterize schedules to allow adjustments depending on hours of operation
  • Added radiant slab system option to model_add_hvac_system with control sequences developed by CBE at UC Berkeley

Issue Statistics Since Previous Release

  • 75 ne...
Read more
Assets 5
Loading

OpenStudio v2.8.1

18 Jun 20:38
@tijcolem tijcolem
v2.8.1
6914d4f
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
OpenStudio v2.8.1 
Version 2.8.1
Assets 5
Loading

OpenStudio v2.8.0

11 Apr 13:15
@tijcolem tijcolem
v2.8.0
5566563
Compare
Choose a tag to compare
OpenStudio v2.8.0

OpenStudio Version 2.8.0

Release Notes – 4/12/2019

These release notes describe version 2.8.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 2.8.0 is supported on 64-bit Windows 7 – 10, OS X 10.11 – 10.14, and Ubuntu 16.04.

OpenStudio 2.8.0 supports EnergyPlus Release 9.1, 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.8.0.

OpenStudio 2.8.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.8.0.

Installation Steps

  • The OpenStudio SketchUp Plug-in requires SketchUp 2017 or 2018 (not available for Linux). OpenStudio 2.8.0 is not compatible with SketchUp 2019. The OpenStudio 3.0 prerelease in October 2019 will be the first version of OpenStudio compatible with SketchUp 2019. The OpenStudio SketchUp Plug-in does not support older versions of SketchUp. SketchUp must be installed before OpenStudio to automatically activate the plugin. If you install SketchUp after OpenStudio, simply rerun the OpenStudio installer.
  • 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

An important announcement related to future development of the OpenStudio Application is available at: https://www.openstudio.net/new-future-for-openstudio-application. Please read this announcement carefully to understand changes coming for the OpenStudio Application over future releases. Please send any questions, comments, or concerns to [email protected] and we will try our best to address them.

OpenStudio SDK:

The 2.8.0 release updates OpenStudio to use EnergyPlus 9.1. This update includes several new features, performance improvements, and bug fixes. LBNL contributed new OpenStudio ModelObjects ElectricEquipmentITEAirCooledDefinition and ElectricEquipmentITEAirCooled which can be used to model air-cooled electric information technology equipment (ITE) with variable power consumption as a function of loading and temperature. Users can now set sequential load heating/cooling fractions for equipment on the ZoneHVACEquipmentList object. The DefaultConstructionSet now has an Adiabatic Surface Construction. End-Use Subcategory fields were added for pumps.

Other changes:

  • Remove 'file://' prefix for file paths listed in OSM files. External files are now referenced by filename only with search path specified in OSW. Affects WeatherFile and ScheduleFile.
  • Sql methods now make use of the Year field that was added in E+ 8.9.0 to avoid problems with leap years (#3453).
  • Force unique names to match new E+ convention following re-factor of E+’s Input Processor. For example, LifeCycleCost objects can no longer bear the same name (#3458).
  • Show Measure Directory Name in OpenStudio Application (#3465). This should make it easier to understand which measure is used even after the user has changed the editable name.
  • Remove non-implemented UtilityCost_* objects from API documentation (#3462)
  • Fix an error in AirTerminalSingleDuctConstantVolumeFourPipeBeam::remove() method that was making the OpenStudio Application crash (#3440)
  • Fixes to API for CoilSystemCoolingDXHeatExchangerAssisted and CoilSystemCoolingWaterHeatExchangerAssisted (#3449)
  • Fix forward translator issues in CoilHeatingDesuperheater and CoilWaterHeatingDesuperheater (#3452)
  • AirLoop::clone was modified to reconnect any supply side coils to the same plant loops as the original coils. This method will clone an AirLoopHVAC with the following rationale:
    • Handle all non-branch components from both the supply and the demand side
    • On the demand side branches, place one terminal of each IddObjectType that is present on the original AirLoopHVAC
    • Clone any SetpointManagers and add them to the correct location
    • If the supply component that is cloned is connected to a PlantLoop, we try to the connect the clone to the same PlantLoop by adding a demand branch
  • PlantLoop::clone was added and follows the same logic. This method will clone a Plant Loop with the following rationale:
    • Handle all non-branch components from both the supply and the demand side
    • Handle branch components on the supply side (between supply splitter and mixer)
    • Clone any SetpointManagers and add them to the correct location
    • If the component that is cloned is connected to another PlantLoop, we try to connect the clone to the same other PlantLoop (if comp is on the supply side, we add a demand branch to the other Plantloop)

OpenStudio Server:

  • Upgraded to Ubuntu 16.04 and R version 3.5.2
  • Added plots for Sobol method
  • Added argument to do out of bounds check for Morris method. If selected true, analysis won't run if created data points do not respect max/min of variables.
  • Correct Morris results json format
  • Correctly kill OpenStudio process after timeout.
  • Timeouts increased from 2hrs to 4hrs for each data point.
  • Adjusted processor allocation for remote deployments.
  • Fixed "Cancel" functionality.
  • Set analysis status to "post-processing" while analysis finalization script is running.
  • Better support for publishing custom AMIs and Docker images.

OpenStudio Standards:

  • Adds a model for heat pump water heaters (HPWH) which uses the WaterHeaterMixed object with an electric fuel and a higher-than-1 efficiency to mimic HPWHs without incurring the significant penalty of the stratified tank. The nuances of some HPWH behavior are lost, so we don’t recommend using this unless you investigate and accept the accuracy tradeoffs for your application.
  • Adds typical refrigeration methods. This method adds detailed refrigeration systems to grocery stores and adds single-walkin systems to other building types with kitchens. For grocery stores, the typical characteristics are based on a combination of expert knowledge and the ASHRAE grocery store Advanced Energy Design Guide. Case and walkin lineups for the grocery store are scaled based on the store size. Walkins for kitchens are not scaled.
  • Adds a new standards worksheet and methods to determine the number of elevators based on building type. Elevator schedules are now based on adjustments to the occupancy schedule rather than set explicitly. changed code to pull elevator logic from this new sheet.
  • Elevator end uses are now tagged with end use category 'Elevators'.
  • Adds in both ASHRAE 169-2006 and ASHRAE 169-2013 climate zone definitions to the spreadsheet and the code base. ASHRAE 169-2013 updates city locations and ground temperatures for each climate zone.
  • Adds the ability to model air to water heat pumps on hot water loops in place of boilers. The equipment is modeled with a PlantComponentUserDefined object. A full air to water heat pump object will be available in the next EnergyPlus/OpenStudio release.
  • Change the default condenser loop to follow OATwb with 7F approach instead of a fixed setpoint temperature.
  • Default to mandate off-hour controls for air loops per 90.1 section 6.4.3.3, based on zone occupancy schedules on an air loop.
  • Use a default infiltration rate matched to the PNNL modeling guideline value of 1.8 cfm/ft2 exterior surface area at 75 Pa instead of zero.
  • Exterior equipment now uses the ExteriorFuelEquipment object instead of the ExteriorLights object.
  • Exterior lighting calculations now estimate the number of doors based on ground floor area, not total area.
  • Refactors exterior area and length calculations for exterior lighting to use standards building type, not standards space type. Before, the method was looping over standards space types and adding a minimum of one building entry per space type, resulting in very high main entryway lighting.

DOE prototype model changes:

  • Uses ASHRAE 169-2013 for...
Read more
Assets 5
Loading