Addresses #5227, updates to Controller:OutdoorAir #5237
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| # OpenStudio Version 3.9.0 | ||
|
|
||
| _Release Notes_ - _TDB_ | ||
|
|
||
| These release notes describe version 3.9.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](https://github.com/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.9.0**__ | ||
| - EnergyPlus | ||
| - Command Line Interface (CLI) | ||
| - Radiance | ||
| - Ruby API | ||
| - Python API | ||
| - C++ SDK | ||
|
|
||
| **Note** that [PAT](https://github.com/NREL/OpenStudio-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](https://github.com/NREL/OpenStudio-PAT) GitHub page. | ||
|
|
||
| # Where to Find OpenStudio SDK Documentation | ||
|
|
||
| - OpenStudio SDK release documentation, including these release notes, tutorials, and other user documentation, is available at [https://www.openstudio.net/](https://www.openstudio.net/.) | ||
| - C++ API documentation is available at [OpenStudio SDK Documentation](https://openstudio-sdk-documentation.s3.amazonaws.com/index.html) | ||
| - Measure development documentation is available at [OpenStudio Measure Writer's Reference Guide](http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/ ) | ||
| - A roadmap for planned features is available at [Roadmap](http://nrel.github.io/OpenStudio-user-documentation/getting_started/roadmap/) | ||
|
|
||
| # Installation Notes | ||
|
|
||
| OpenStudio SDK 3.9.0 is supported on: | ||
|
|
||
| * 64-bit Windows 7 – 11 | ||
| * macOS: 11.6+ x86_64, 12.1+ arm64 | ||
| * Ubuntu: 20.04 x86_64, 22.04 x86_64, 22.04 arm64 | ||
| * Centos7 | ||
|
|
||
| OpenStudio SDK 3.9.0 supports [EnergyPlus Release 24.2.0a](https://github.com/NREL/EnergyPlus/releases/tag/24.2.0a), 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.9.0. | ||
|
|
||
| OpenStudio SDK 3.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 SDK 3.9.0. | ||
|
|
||
| As usual, you can refer to the **[OpenStudio SDK Compatibility Matrix](https://github.com/NREL/OpenStudio/wiki/OpenStudio-SDK-Version-Compatibility-Matrix)** for more information. | ||
|
|
||
|
|
||
| ## Installation Steps | ||
|
|
||
| - Download and install [OpenStudio SDK](https://github.com/NREL/openstudio) and/or any third party tool that embeds the OpenStudio SDK into their software such as [openstudiocoalition/OpenStudioApplication](https://github.com/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. | ||
| - A BCL AUth Key is no longer needed to access content on [Building Component Library (BCL)](https://bcl.nrel.gov) BCL is typically accessed through third party OpenStudio applications to provide modelers access to building components and OpenStudio measures; however you an also browse it and download content using the BCL link above. | ||
|
|
||
| For help with common installation problems please visit [Getting Started](http://nrel.github.io/OpenStudio-user-documentation/getting_started/getting_started/). | ||
|
|
||
| # OpenStudio SDK: Changelog | ||
|
|
||
| The 3.9.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. | ||
|
|
||
| ## 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.9.0` | ||
|
|
||
| Please see [openstudio on PyPi](https://pypi.org/project/openstudio/) for further instructions on how to install. Users can also visit the test channel at [openstudio on TestPyPi](https://test.pypi.org/project/openstudio/) to install development bindings. | ||
|
|
||
| You can also refer to the [OpenStudio SDK Python Binding Version Compatibility Matrix](https://github.com/NREL/OpenStudio/wiki/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 | ||
|
|
||
| * [#5242](https://github.com/NREL/OpenStudio/pull/5242) - Update to EnergyPlus v24.2.0a | ||
| * To see the full list of additions and changes, refer to the issue [#5240](https://github.com/NREL/OpenStudio/issues/5240) | ||
|
|
||
| * [#5237](https://github.com/NREL/OpenStudio/pull/5237) - Updates to Controller:OutdoorAir | ||
| * This PR implements the fields `Humidistat Control Zone Name` and `Electronic Enthalpy Limit Curve` | ||
| * `ControllerOutdoorAir` has two API-breaking changes for `High Humidity Outdoor Air Flow Ratio` and `Control High Indoor Humidity Based on Outdoor Humidity Ratio`. These fields are now-required, so the getters no longer return an optional | ||
| * `getHighHumidityOutdoorAirFlowRatio` (`boost::optional<double>` to `double`) | ||
| * `getControlHighIndoorHumidityBasedOnOutdoorHumidityRatio` (`boost::optional<bool>` to `bool`) | ||
|
Comment on lines
+78
to
+85
There was a problem hiding this comment.
|
||
|
|
||
| ## Minor changes and bug fixes | ||
|
|
||
| Refer to the changelog on the release page at [v3.9.0](https://github.com/NREL/OpenStudio/releases/v3.9.0) | ||
|
|
||
| **Full Changelog**: https://github.com/NREL/OpenStudio/compare/v3.9.0...v3.9.0 | ||
|
|
||
| **New Contributors**: | ||
|
|
||
| ### OpenStudio Standards v@STANDARDS_VERSION@ | ||
|
|
||
| Update the openstudio-standards gem to version [@STANDARDS_VERSION@](https://github.com/NREL/openstudio-standards/releases/tag/v@STANDARDS_VERSION@) | ||
| In addition to some refactoring, this release also included conversion of 90.1 data to formal database. | ||
|
|
||
|
|
||
| ### OpenStudio Server vXXX | ||
|
|
||
|
|
||
|
|
||
|
|
||
| --- | ||
| # This YAML header controls the pandoc (via TeX) to PDF settings | ||
| # To convert the markdown to pdf, do `pandoc release_notes.md -o release_notes.pdf` | ||
| title: 'OpenStudio Release Notes - 3.9.0' | ||
| author: | ||
| - National Renewable Energy Laboratory | ||
| colorlinks: true | ||
| linkcolor: blue | ||
| urlcolor: Mahogany | ||
| toccolor: gray | ||
| geometry: | ||
| - margin=1in | ||
| --- | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,27 +20,28 @@ __**OpenStudio SDK @VERSION@**__ | |
| - Command Line Interface (CLI) | ||
| - Radiance | ||
| - Ruby API | ||
| - Python API | ||
| - C++ SDK | ||
|
|
||
| **Note** that [PAT](https://github.com/NREL/OpenStudio-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](https://github.com/NREL/OpenStudio-PAT) GitHub page. | ||
|
|
||
| # Where to Find OpenStudio SDK Documentation | ||
|
|
||
| - OpenStudio SDK release documentation, including these release notes, tutorials, and other user documentation, is available at [https://www.openstudio.net/](https://www.openstudio.net/.) | ||
| - C++ API documentation is available at [OpenStudio SDK Documentation](https://openstudio-sdk-documentation.s3.amazonaws.com/index.html) | ||
| - Measure development documentation is available at [OpenStudio Measure Writer's Reference Guide](http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/ ) | ||
| - A roadmap for planned features is available at [Roadmap](http://nrel.github.io/OpenStudio-user-documentation/getting_started/roadmap/) | ||
|
|
||
| # Installation Notes | ||
|
|
||
| OpenStudio SDK @VERSION@ is supported on: | ||
|
|
||
| * 64-bit Windows 7 – 11 | ||
| * macOS: 11.6+ x86_64, 12.1+ arm64 | ||
| * Ubuntu: 20.04 x86_64, 22.04 x86_64, 22.04 arm64 | ||
| * Centos7 | ||
|
|
||
| OpenStudio SDK @VERSION@ supports [EnergyPlus Release @EP_VERSION@](https://github.com/NREL/EnergyPlus/releases/tag/v@EP_VERSION@), 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 @VERSION@. | ||
|
|
||
| OpenStudio SDK @VERSION@ 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 @VERSION@. | ||
|
|
||
|
|
@@ -49,17 +50,18 @@ As usual, you can refer to the **[OpenStudio SDK Compatibility Matrix](https://g | |
|
|
||
| ## Installation Steps | ||
|
|
||
| - Download and install [OpenStudio SDK](https://github.com/NREL/openstudio) and/or any third party tool that embeds the OpenStudio SDK into their software such as [openstudiocoalition/OpenStudioApplication](https://github.com/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. | ||
| - A BCL AUth Key is no longer needed to access content on [Building Component Library (BCL)](https://bcl.nrel.gov) BCL is typically accessed through third party OpenStudio applications to provide modelers access to building components and OpenStudio measures; however you an also browse it and download content using the BCL link above. | ||
|
|
||
| For help with common installation problems please visit [Getting Started](http://nrel.github.io/OpenStudio-user-documentation/getting_started/getting_started/). | ||
|
|
||
| # OpenStudio SDK: Changelog | ||
|
|
||
| The @VERSION@ is a **<minor/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. | ||
|
|
||
| ## Python Bindings | ||
|
|
||
|
|
@@ -78,16 +80,33 @@ You can also refer to the [OpenStudio SDK Python Binding Version Compatibility M | |
|
|
||
| ## Minor changes and bug fixes | ||
|
|
||
| Refer to the changelog on the release page at [v@VERSION@](https://github.com/NREL/OpenStudio/releases/v@VERSION@) | ||
|
|
||
| **Full Changelog**: https://github.com/NREL/OpenStudio/compare/v@[email protected]@VERSION@ | ||
|
|
||
| **New Contributors**: | ||
|
|
||
| ### OpenStudio Standards v@STANDARDS_VERSION@ | ||
|
|
||
| Update the openstudio-standards gem to version [@STANDARDS_VERSION@](https://github.com/NREL/openstudio-standards/releases/tag/v@STANDARDS_VERSION@) | ||
| In addition to some refactoring, this release also included conversion of 90.1 data to formal database. | ||
|
|
||
|
|
||
| ### OpenStudio Server vXXX | ||
|
|
||
|
|
||
|
|
||
|
|
||
| --- | ||
| # This YAML header controls the pandoc (via TeX) to PDF settings | ||
| # To convert the markdown to pdf, do `pandoc release_notes.md -o release_notes.pdf` | ||
| title: 'OpenStudio Release Notes - @VERSION@' | ||
| author: | ||
| - National Renewable Energy Laboratory | ||
| colorlinks: true | ||
| linkcolor: blue | ||
| urlcolor: Mahogany | ||
| toccolor: gray | ||
| geometry: | ||
| - margin=1in | ||
| --- | ||
|
Comment on lines
+100
to
+112
There was a problem hiding this comment. I also adjusted the Release_Notes template.md to conform to latest format, and added some quick |
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I adjusted the 3.8.0 release notes .md and generated the PDF.
@DavidGoldwasser @wenyikuang We've been historically doing this for every release. The format is much better than what's displayed on the 3.8.0 release https://github.com/NREL/OpenStudio/releases/v3.8.0 which in this specific case is purely the automated github changelog, not even sorted by importance or removing the Developer issues.
Can you please advise whether we keep doing this going forward?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jmarrec I like the more advanced release notes that are https://github.com/NREL/OpenStudio/blob/develop/developer/doc/ReleaseNotes/
It's probably my fault that the release notes here https://github.com/NREL/OpenStudio/releases/tag/v3.8.0 don't look like they did for 3.7 https://github.com/NREL/OpenStudio/releases/tag/v3.7.0
I would like to automate builds more for 3.10 and later but we'll always have some hand written narratives. I can try to write those throughout the 6 month cycle and not wait to drop in at the end. But when we can pull in auto-generated change log that seems nice.