Skip to content

Releases: NREL/OpenStudio

v3.7.0

19 Nov 02:31
@wenyikuang wenyikuang
v3.7.0
ca6043e
Compare
Choose a tag to compare
v3.7.0 Latest
Latest

OpenStudio SDK:

The 3.7.0 is a major release. This update includes several new features, performance improvements, and bug fixes.

C++ Workflow code

As of OpenStudio SDK 3.7.0 a re-written workflow written in C++ is used by default in place of the Ruby based Workflow Gem that had been used in the past. This enhancement is in support of Python measures being used in an OpenStudio workflow, including mixed language workflows that include both Ruby Measures and Python Measures. If you need to use the older Workflow Gem implementation, you can do that by using the classic subcommand after openstudio. classic will be deprecated in a future version of OpenStudio.

Known Issues / Limitations

  • In some cases you may need to install an extra dependency needed by EnergyPlus on Linux and Mac. See this EnergyPlus issue for details NREL/EnergyPlus#10284
  • While we udpated the gbXML schema to v7.03, the forward and reverse translation between gbXML and OSM does not support any new gbXML fields that may have been added.

New Features, Major Fixes and API-breaking changes

Minor changes and bug fixes

Read more

Contributors

kbenne, macumber, and 4 other contributors
Assets 16

v3.7.0-rc3

16 Nov 20:38
@wenyikuang wenyikuang
v3.7.0-rc3
37087fd
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
v3.7.0-rc3 Pre-release
Pre-release

What's Changed

  • Fix #5018 - C++ CLI: Calling a non existing method in a measure ends up with a crash and stack trace by @jmarrec in #5023
  • Fixing run workflow with outdated measures by @jmarrec in #5015
  • C++ CLI: Create results.json and handle analysis.json (create objectives.json) by @jmarrec in #5028
  • Don't delete the osw when it is in the run dir by @kbenne in #5041
  • Fix #5030 - C++ CLI: run.log is huge and missing the runner.registerWarning messages by @jmarrec in #5035
  • Fix #5037 - Adjust log formatters for workflow (stdout + run.log) by @jmarrec in #5042
  • Bump to rc3. by @wenyikuang in #5043
  • Add missing add_result_measure_info so that out.osw step result have the same info as before by @jmarrec in #5044

Full Changelog: v3.7.0-rc2...v3.7.0-rc3

Contributors

kbenne, jmarrec, and wenyikuang
Assets 16

v3.7.0-rc2

07 Nov 23:18
@wenyikuang wenyikuang
v3.7.0-rc2
c0cbe73
This commit was signed with the committer’s verified signature. The key has expired.
jmarrec Julien Marrec
GPG key ID: 52FBA80BA25F6B35
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v3.7.0-rc2 Pre-release
Pre-release

What's Changed

Full Changelog: v3.7.0-rc1...v3.7.0-rc2

Contributors

kbenne, macumber, and 3 other contributors
Assets 16

OpenStudio v3.7.0-rc1

18 Oct 19:15
@wenyikuang wenyikuang
v3.7.0-rc1
211bb63
This commit was signed with the committer’s verified signature. The key has expired.
jmarrec Julien Marrec
GPG key ID: 52FBA80BA25F6B35
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
OpenStudio v3.7.0-rc1 Pre-release
Pre-release

What's Changed

New Contributors

Full Changelog: v3.6.1...v3.7.0-rc1

Contributors

kbenne, macumber, and 4 other contributors
Assets 16

OpenStudio v3.6.1

22 May 20:46
@tijcolem tijcolem
v3.6.1
bb94815
Compare
Choose a tag to compare
OpenStudio v3.6.1

What's Changed

  • Master master + Bump to 3.6.1-alpha and add default VT by @jmarrec in #4880
  • Adjust CMakeLists for Ubuntu 22.04 arm64 by @jmarrec in #4881
  • Fix #4882 - Avoid a crash in createFluidProperties during FT that's due to Undefined Behavior by @jmarrec in #4884
  • #4748 #4817 - Validate BCLXML with schema when loading + make sorting of files in measure.xml consistent when saving by @jmarrec in #4827
  • Fix #4887 - CSharp workflow - macos-10.15 was removed by @jmarrec in #4888

Full Changelog: v3.6.0...v3.6.1

Contributors

jmarrec
Assets 16

OpenStudio v3.6.1-rc1

18 May 18:56
@tijcolem tijcolem
v3.6.1-rc1
b5007dd
Compare
Choose a tag to compare
OpenStudio v3.6.1-rc1 Pre-release
Pre-release

What's Changed

  • Master master + Bump to 3.6.1-alpha and add default VT by @jmarrec in #4880
  • Adjust CMakeLists for Ubuntu 22.04 arm64 by @jmarrec in #4881
  • Fix #4882 - Avoid a crash in createFluidProperties during FT that's due to Undefined Behavior by @jmarrec in #4884
  • #4748 #4817 - Validate BCLXML with schema when loading + make sorting of files in measure.xml consistent when saving by @jmarrec in #4827
  • Fix #4887 - CSharp workflow - macos-10.15 was removed by @jmarrec in #4888

Full Changelog: v3.6.0...v3.6.1-rc1

Contributors

jmarrec
Assets 12

OpenStudio v3.6.0

09 May 16:10
@tijcolem tijcolem
v3.6.0
860f5de
Compare
Choose a tag to compare
OpenStudio v3.6.0

OpenStudio Version 3.6.0

Release Notes - 05/09/2023

These release notes describe version 3.6.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.6.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.6.0 is supported on:

  • 64-bit Windows 7 – 11
  • macOS: 10.15+ x86_64, 12.1+ arm64
  • Ubuntu: 20.04 x86_64, 22.04 x86_64, 22.04 arm64
  • Centos7

OpenStudio SDK 3.6.0 supports EnergyPlus Release 23.1.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 SDK 3.6.0.

OpenStudio SDK 3.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 SDK 3.6.0.

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 2021-2022 (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 re-run 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.6.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.

Python Bindings

As of OpenStudio SDK 3.2.0, Python bindings are officially supported and distributed through Python Package Index (PyPI). 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.6.0

Please see openstudio on PyPi for further instructions on how to install. Users can also visit the test channel at openstudio on TestPyPi to install development bindings.

You can also refer to the OpenStudio SDK Python Binding Version Compatibility Matrix to see the list of supported platforms and python versions.

New Features, Major Fixes and API-breaking changes

  • #4719,#4721 - Phase 2 support to run Python based measures. This functionality is still experimental and can only be accessed from the CLI using the experimental labs subcommand. Phase 2 now allows users to run both a Python and Ruby measure in the same workflow. To explore the various new options this new feature has to offer, you can access the help menu openstudio labs --help Also, to help jump start python measure development, included in the installation are example .osw workflow files that contain Python, Ruby and Python+Ruby based workflows that can be ran using the labs subcommand. For instance, the following will run a Ruby + Python based workflow: openstudio labs run -w ./Examples/compact_osw/compact_ruby_and_python.osw

  • #4778 - Wrap AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl and AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR

    • ZoneHVAC:TerminalUnit:VariableRefrigerantFlow has API-breaking changes related to setters and getters for its heating and cooling coils. They now use HVACComponent instead of the more restrictive CoilHeatingDXVariableRefrigerantFlow and CoilCoolingDXVariableRefrigerantFlow.
    • AirConditionerVariableRefrigerantFlow::clone was changed to stop cloning the child Curve objects (20 of them)

  • #4740 - Fix issues around ScheduleFixedInterval

    • A minor API breaking change: intervalLength/setIntervalLength now return/accept an int rather than a double to conform to the IDD type \integer
    • Translated daily schedules start on correct day
    • Leap day is no longer ignored on translation
    • Interval no longer restricted to one day or less

  • #4813 - Wrap SolarCollectorPerformance:PhotovoltaicThermal:BIPVT

    • SolarCollectorFlatPlatePhotovoltaicThermal has API-breaking changes in the solarCollectorPerformance getter due to the addition of this new object: it used to return a SolarCollectorPerformancePhotovoltaicThermalSimple (the only performance object at the time), now it's a ModelObject.

  • #4717 Update GroundHeatExchangerHorizontalTrench: wrap Site:GroundTemperature:Undisturbed:XXX objects

    • Wrap Site:GroundTemperature:Undisturbed:KusudaAchenbach and Site:GroundTemperature:Undisturbed:Xing objects
    • Update GroundHeatExchanger:HorizontalTrench to actually use the Ground Temeprature Model field

  • #4532 Performance improvements

  • #4800,#4844 Update to v23.1.0 EnergyPlus

  • #4808 Wrap OutputControl:Timestamp

  • #4825 add Coil:UserDefined

  • #4806 Wrap Gas-Fired Absorption Heat Pump (GAHP)

    • Wrap HeatPump:AirToWater:FuelFired:Heating and HeatPump:AirToWater:FuelFired:Cooling objects
    • The objects define an equation-fit fuel-fired absorption heat pump, based on manufacture-provided performance curves and testing/modeling methods
    • The GAHP is a combined space heating and domestic hot water solution, especially for cold climates. It can serve as heat sources for plant loops of space heating coils, hydronic radiators, DHW water heaters, and low-temperature space heating floors or TABS systems. Driven by gas heat or other types of fuel heat, the equipment can consume very little electricity and can have a much higher overall COP than conventional fuel-combustion type boilers or water heaters.

  • #4799 Add Fuel-related Methods from OpenStudio-Standard

  • #4857 Schedule:File ctor with path

    • Introduce new ScheduleFile constructor with path instead of ExternalFile argument

  • Support Ubuntu 22.04 and remove 18.04

Minor changes and bug fixes

  • #4828 - Fix Space load-based actuator for spaces are named ba...
Read more

Contributors

wenyikuang
Assets 19

OpenStudio v3.5.1

29 Dec 21:37
@tijcolem tijcolem
v3.5.1
22e1db7
Compare
Choose a tag to compare
OpenStudio v3.5.1

What's Changed

  • Windows arg parsing in #4779
  • Fix #4767 - Preserve order of Component objects during VersionTranslation in #4768
  • Bump to 3.5.1 and add default VT in #4752
  • Fix #4741 - Python binding version on mac with GitHub Actions in #4742
  • Fix #4758 - Download component from BCL is broken in 3.5.0in #4759
  • Fix #4754 - Cloning an object that uses a TableLookup into another model doesn't bring the ModelObjectList and IndependentVariables in #4755
  • Fix #4756 - Update OS:ComponentData during VersionTranslation in #4757
  • Support "No Load Supply Air Flow Rate Ratio" on UnitarySystemPerformance:Multispeed in #4749
  • Ruby gem addressable needs unicode.data. by in #4751
  • Fix #4761 - Cleanup temporary directory when doing Schematron XMLValidation by #4762
Assets 14

OpenStudio v3.5.0

10 Nov 16:30
@tijcolem tijcolem
v3.5.0
7b14ce1
Compare
Choose a tag to compare
OpenStudio v3.5.0

OpenStudio Version 3.5.0

Release Notes - 11/10/2022

These release notes describe version 3.5.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.5.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.5.0 is supported on 64-bit Windows 7 – 11, OS X 10.15, Ubuntu 18.04, 20.04 and Centos7

OpenStudio SDK 3.5.0 supports EnergyPlus Release 22.1.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 SDK 3.5.0.

OpenStudio SDK 3.5.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.5.0.

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 2021-2022 (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 re-run 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.5.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.

Python Bindings

As of OpenStudio SDK 3.2.0, Python bindings are officially supported and distributed through Python Package Index (PyPI). 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.5.0

Please see openstudio on PyPi for further instructions on how to install. Users can also visit the test channel at openstudio on TestPyPi to install development bindings.

You can also refer to the OpenStudio SDK Python Binding Version Compatibility Matrix to see the list of supported platforms and python versions.

New Features, Major Fixes and API-breaking changes

  • #4689,#4702,#4694,#4674,#4641,#4688,#4653 - Phase 1 support to run Python based measures.
    • Currently, this functionality is experimental and can only be accessed from the CLI using the experimental labs subcommand. This also includes a redesigned help menu (openstudio labs --help) to explore the various new options this new feature has to offer.
    • Included in the installation are example .osw workflow files that contain Python based measures that can be ran using the labs subcommand. For instance, the following will run a python based workflow: openstudio run -w ./Examples/compact_osw/compact_python_only.osw
    • For this release, only Python or Ruby can be ran in a single workflow file. Running both Python and Ruby support is planned for the next phase 2 installment in v3.6.0
  • #4600 - Phase 1 support to run Python EMS plugin using OpenStudio.
  • #4623 - FloorspaceJS to OpenStudio direct reverse translator vs the 3-way process of converting FloorspaceJS to ThreeJS to OSM.
  • #4571 - Metadata mapped to GLTF data object at export. Allows users to view metadata in a glTF capable browser.
  • #4587 - Error handling and gbXML schema validation when running gbXML based workflows.
  • #4616 - Addresses #4611, allow non-Quadratic curves for the EIR-f-PLR for the Chiller:Electric:EIR object
    • Chiller:Electric:EIR has a few API-breaking changes related to its Curves. The types for the constructor, getters and setters used to be explicit (eg: CurveBiquadratic): it is now the base class, more generic, Curve type for added flexibility.
  • #4642 - Addresses #4575, API change for EvaporativeCoolerFluid:SingleSpeed
    • EvaporativeCoolerFluid:SingleSpeed has an API-breaking change related to its performanceInputMethod getter. It is now a required field that returns std::string instead of boost::optional<std::string>.
  • #4644 - Addresses #4575, API change for Coil:Cooling:DX:SingleSpeed and Coil:Cooling:DX:TwoSpeed
    • Coil:Cooling:DX:SingleSpeed and Coil:Cooling:DX:TwoSpeed have API-breaking changes related to many of their getters. They are now required fields that return double instead of boost::optional<double>. Also removes many deprecated methods.
  • #4632 - Remove deprecated methods for AirWallMaterial, Node, SizingSystem, ZoneAirMassFlowConservation
    • Removes the deprecated AirWallMaterial class completely, in favor of ConstructionAirBoundary
    • Removes functions in Node that have been deprecated for 9+ years
    • Removes deprecated methods in the SizingSystem, ZoneAirMassFlowConservation, PlantLoop & AirLoopHVAC, AvailablilityManagerNightCycle, ZoneVentilationDesignFlowRate classes
    • Refer to the CSV file at developer/ruby/deprecated_methods.csv for more information
  • #4665 - Deprecate methods on Coil DX objects
    • Coil:Cooling:DX:SingleSpeed, Coil:Cooling:DX:MultiSpeed:StageData, and Coil:Cooling:DX:CurveFit:Speed: ratedEvaporatorFanPowerPerVolumeFlowRate and setRatedEvaporatorFanPowerPerVolumeFlowRate in favor of ratedEvaporatorFanPowerPerVolumeFlowRate2017 and setRatedEvaporatorFanPowerPerVolumeFlowRate2017
    • Coil:Heating:DX:SingleSpeed and Coil:Heating:DX:MultiSpeed:StageData: ratedSupplyFanPowerPerVolumeFlowRate and setRatedSupplyFanPowerPerVolumeFlowRate in favor of ratedSupplyFanPowerPerVolumeFlowRate2017 and setRatedSupplyFanPowerPerVolumeFlowRate2017
  • #4666 - Changes related to availability schedule methods
    • Coil:Heating:Gas:MultiStage has an API-bre...
Read more
Assets 15

OpenStudio v3.4.0 vcomp fix (Windows Installer Only)

07 May 14:42
@tijcolem tijcolem
v3.4.0-vcomp
9e989db
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 v3.4.0 vcomp fix (Windows Installer Only) Pre-release
Pre-release

This is an update to the v3.4.0 Windows installer that includes vcomp140.dll for EnergyPlus. This dll is a pretty common library that gets installed alongside with various software so many systems likely already have this (i.e. Windows 2019 server edition), but some bare bones Windows versions may not and will hit the error mentioned on #4581

Contributors

jmarrec
Assets 4