-
Notifications
You must be signed in to change notification settings - Fork 394
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9088 from NREL/PrepFor96
Final Prep for 9.6 Release
- Loading branch information
Showing
10 changed files
with
359 additions
and
150 deletions.
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
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
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
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
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
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,184 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> | ||
| <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" | ||
| integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous"> | ||
| <link rel="canonical" href="https://getbootstrap.com/docs/4.0/examples/jumbotron/"> | ||
| <link href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" | ||
| integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous"> | ||
| <title>EnergyPlus Deprecation Status</title> | ||
| <style> | ||
| h2 { | ||
| margin-top: 6px; | ||
| } | ||
|
|
||
| .margin-bottom-6 { | ||
| margin-bottom: 6px; | ||
| } | ||
|
|
||
| .list-group { | ||
| padding-bottom: 6px; | ||
| } | ||
|
|
||
| .transition-object-name { | ||
| padding-top: 8px; | ||
| padding-bottom: 8px; | ||
| } | ||
| </style> | ||
| </head> | ||
| <body id="preview"> | ||
|
|
||
| <div class="jumbotron" style="padding-bottom: 32px; padding-top: 32px;"> | ||
| <div class="container"> | ||
| <div class="row"> | ||
| <div class="col-md-2"></div> | ||
| <div class="col-md-8 text-center"> | ||
| <h1><img src="favicon.png" alt="EnergyPlus Logo" width="98" height="98"> EnergyPlus</h1> | ||
| <p> | ||
| Version 9.6.0<br> | ||
| 30 September 2021<br> | ||
| <em>EnergyPlus is a trademark of the US Department of Energy.</em> | ||
| </p> | ||
| </div> | ||
| <div class="col-md-2"></div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="container"> | ||
| <div class="row"> | ||
| <div class="col-md-12" style="text-align:center;"> | ||
| <a class="btn btn-primary margin-bottom-6" href="https://energyplus.net" role="button"> | ||
| <span class="fa fa-external-link"></span> Go to the EnergyPlus Website | ||
| </a> | ||
| </div> | ||
| </div> | ||
| <div class="row"> | ||
| <div class="col-md-12" style="text-align:center;"> | ||
| <a class="btn btn-primary margin-bottom-6" href="https://energyplus.net/quickstart" role="button"> | ||
| <span class="fa fa-external-link"></span> Go to the EnergyPlus Quick-Start Guide | ||
| </a> | ||
| </div> | ||
| </div> | ||
|
|
||
| <h2>Background</h2> | ||
| <p> | ||
| As EnergyPlus evolves, features and capabilities are added to ensure the tool keeps up with demand. | ||
| However, some features and capabilities may grow outdated and potentially be removed from the tool. | ||
| For most changes to EnergyPlus between versions, an automated conversion is possible. | ||
| When an automatic conversion is not possible, the relevant input objects are marked as deprecated, | ||
| a warning message is emitted from the simulation engine, and eventually the user must manually | ||
| convert the file once the feature is fully removed. | ||
| </p> | ||
| <p> | ||
| The justification for removing capabilities is to reduce the maintenance burden of the program, allowing more | ||
| effort to be placed in adding newer, more vital, capabilities, and also to streamline the internal structure of | ||
| the program to improve the runtime burden of the program. | ||
| </p> | ||
| <p> | ||
| This document discusses those aspects which are on the roadmap for deprecation from the engine. | ||
| The full deprecation process consists of several steps to ensure that users are not suddenly impacted | ||
| by the change. This document will be included in each installer and also sent to major stakeholders and users. | ||
| </p> | ||
|
|
||
| <h2>Deprecation Process</h2> | ||
| <p> | ||
| The deprecation process consists of a number of steps. The deprecation process will gnerally follow each of | ||
| these steps one release at a time. However, the development reserves the right to alter the deprecation | ||
| timeline of features as needed. | ||
| </p> | ||
| <dl class="dl-horizontal"> | ||
| <dt>Level 1 - Gathering Feedback</dt> | ||
| <dd> | ||
| In this first phase of the process we will list items in this deprecation document, with the hopes of | ||
| hearing back from users about the potential deprecation. EnergyPlus does not have a way to feed back | ||
| information to the development team about how frequently objects are being used, so this step is all about | ||
| gathering feedback. Objects are not yet marked as deprecated at this stage. | ||
| </dd> | ||
| <dt>Level 2 - Deprecation</dt> | ||
| <dd> | ||
| If a release cycle is completed, and a capability is still planned for deprecation, then the relevant input | ||
| objects will be marked with a deprecation tag, and the object will be marked as Level 2 in this document. | ||
| </dd> | ||
| <dt>Level 3 - Removal</dt> | ||
| <dd> | ||
| If an additional release cycle completes and the object is still marked for deprecation, the capability will | ||
| then be removed from EnergyPlus, and any input objects will be removed from the input schema. Warning | ||
| messages will be emitted into the version translator to alert the user that the capability was removed. | ||
| Deprecated objects will be placed into the level 3 section of this document. | ||
| </dd> | ||
| </dl> | ||
|
|
||
| <h2>Level 1 Deprecation Status</h2> | ||
|
|
||
| <h3>Future Version Numbers</h3> | ||
| <p> | ||
| This is not exactly an input object or capability deprecation, but it is a major change in the version numbers. | ||
| EnergyPlus has historically used version numbers that varied the major number and sometimes the minor | ||
| number. For the last several years we have just incremented the minor number. Since | ||
| EnergyPlus input files have some breaking changes in each release, the minor number change does not hold a | ||
| lot of meaning. We have decided to move forward with a more modern version numbering scheme starting next year. | ||
| The EnergyPlus version will be based on the year and the release number. The March 2022 release is expected to | ||
| be EnergyPlus 2022.1 and the Fall release will be EnergyPlus 2022.2. If additional major releases are created | ||
| for some reason, they would increment the release number further. Rare intermediate releases may be numbered | ||
| with a patch number such as 2022.1.1. | ||
| </p> | ||
|
|
||
| <h3>DElight</h3> | ||
| <p> | ||
| DElight daylighting capabilities provides an alternative to the split-flux method. The DElight library has not | ||
| been updated in several years, and there is little user activity (support questions, etc.) related to this | ||
| feature. This library is considered for potential deprecation. | ||
| </p> | ||
|
|
||
| <h3>Component Costs</h3> | ||
| <p> | ||
| EnergyPlus, as a physics calculation engine, does include some extra "non-physics" calculations. Component cost | ||
| is one calculation that can be performed fully outside EnergyPlus, unrelated to the direct physics of the | ||
| simulation. The ComponentCost objects are considered for potential deprecation. | ||
| </p> | ||
|
|
||
| <h3>Geometry Transformation</h3> | ||
| <p> | ||
| Geometry transformation allows for users to enter inputs that transform the building inside the simulation | ||
| itself. It has been suggested that this capability should live outside of EnergyPlus, so objects related to | ||
| this capability are now considered potentially deprecated. | ||
| </p> | ||
|
|
||
| <h2>Level 2 Deprecation Status</h2> | ||
| <p> | ||
| At this time, no objects have advanced to level 2 deprecation status. | ||
| </p> | ||
|
|
||
| <h2>Level 3 Deprecation Status</h2> | ||
| <p> | ||
| At this time, no objects have advanced to level 3 (full removal) yet. | ||
| </p> | ||
|
|
||
| <hr> | ||
|
|
||
| <footer> | ||
| <p>Copyright © 1996-2021 The Board of Trustees of the University of Illinois, The Regents of the University of | ||
| California through Ernest Orlando Lawrence Berkeley National Laboratory, Oak Ridge National Laboratory, | ||
| managed | ||
| by | ||
| UT-Battelle, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.</p> | ||
| <p>Other Notices and Acknowledgments are found in the <a | ||
| href="Documentation/Acknowledgments.pdf">Acknowledgments</a> | ||
| document.</p> | ||
| </footer> | ||
|
|
||
| <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" | ||
| integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" | ||
| crossorigin="anonymous"></script> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" | ||
| integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" | ||
| crossorigin="anonymous"></script> | ||
| <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" | ||
| integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" | ||
| crossorigin="anonymous"></script> | ||
| </div> | ||
| </body> | ||
| </html> |
Oops, something went wrong.
f420c06There 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.
develop (Myoldmopar) - x86_64-Linux-Ubuntu-18.04-gcc-7.5: OK (2465 of 2465 tests passed, 0 test warnings)
f420c06There 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.
develop (Myoldmopar) - x86_64-MacOS-10.15-clang-11.0.0: OK (2444 of 2444 tests passed, 0 test warnings)
f420c06There 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.
develop (Myoldmopar) - Win64-Windows-10-VisualStudio-16: OK (2423 of 2423 tests passed, 0 test warnings)
f420c06There 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.
develop (Myoldmopar) - x86_64-Linux-Ubuntu-18.04-gcc-7.5-UnitTestsCoverage-Debug: OK (1710 of 1710 tests passed, 0 test warnings)
f420c06There 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.
develop (Myoldmopar) - x86_64-Linux-Ubuntu-18.04-gcc-7.5-IntegrationCoverage-Debug: OK (737 of 737 tests passed, 0 test warnings)