From 38e90cbb2a3757bc0103ddd18047628138d8f4a5 Mon Sep 17 00:00:00 2001 From: Edwin Lee Date: Tue, 30 Mar 2021 13:24:24 -0500 Subject: [PATCH 1/5] Fix version in li-ion example file --- testfiles/ShopWithPVandLiIonBattery.idf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/testfiles/ShopWithPVandLiIonBattery.idf b/testfiles/ShopWithPVandLiIonBattery.idf index 60f7adaa483..82ecb6e300b 100644 --- a/testfiles/ShopWithPVandLiIonBattery.idf +++ b/testfiles/ShopWithPVandLiIonBattery.idf @@ -54,7 +54,7 @@ ! Environmental Emissions: Yes ! Utility Tariffs: Yes, circa 2004, Reliant , TX - Version,9.4; + Version,9.5; Timestep,6; From 78041b687396cc291bca2a8a831dc8e995a1e85c Mon Sep 17 00:00:00 2001 From: Edwin Lee Date: Tue, 30 Mar 2021 14:18:42 -0500 Subject: [PATCH 2/5] Increment past version sha and tweak changelog script and update readme --- cmake/Version.cmake | 2 +- doc/tools/create_changelog.py | 7 ++++- release/readme.html | 59 ++++++++++++++--------------------- 3 files changed, 31 insertions(+), 37 deletions(-) diff --git a/cmake/Version.cmake b/cmake/Version.cmake index 99cdf84e58c..3a32a8d7b3b 100644 --- a/cmake/Version.cmake +++ b/cmake/Version.cmake @@ -2,7 +2,7 @@ set(CMAKE_VERSION_MAJOR 9) set(CMAKE_VERSION_MINOR 5) set(CMAKE_VERSION_PATCH 0) -set(PREV_RELEASE_SHA "baff089") +set(PREV_RELEASE_SHA "998c4b7") set(ENERGYPLUS_VERSION "${CMAKE_VERSION_MAJOR}.${CMAKE_VERSION_MINOR}.${CMAKE_VERSION_PATCH}") diff --git a/doc/tools/create_changelog.py b/doc/tools/create_changelog.py index 3f83fbb6ee2..faf04deffe3 100755 --- a/doc/tools/create_changelog.py +++ b/doc/tools/create_changelog.py @@ -116,7 +116,7 @@ def usage(): log_full = '' pass # add error handling log_full_split = log_full.split('\n') -log_merge_prs = [x for x in log_full_split if 'Merge pull request' in x and not x.strip().startswith('Revert')] +log_merge_prs = [x for x in log_full_split if x.strip().startswith('Merge pull request') and not x.strip().startswith('Revert')] pr_tokens = [x.split(' ')[7] for x in log_merge_prs] pr_numbers = sorted([x[1:] for x in pr_tokens]) @@ -133,6 +133,11 @@ def usage(): # - a user wants to contribute a change to E+, so they create a fork/branch # - their operations result in a pull request into their own repo, so the counting starts at #1... # we're at like 5000+, so if we just skip anything less than 1000, we'll be good. + try: + i = int(pr_num) + except ValueError: + print(f"WARNING: Something wrong with PR number: \"{pr_num}\"") + continue if int(pr_num) < 1000: continue diff --git a/release/readme.html b/release/readme.html index f62d3c9498a..1d108d01288 100644 --- a/release/readme.html +++ b/release/readme.html @@ -37,8 +37,8 @@

EnergyPlus Logo EnergyPlus

- Version 9.4.0
- 30 September 2020
+ Version 9.5.0
+ 31 March 2021
EnergyPlus is a trademark of the US Department of Energy.

@@ -88,13 +88,13 @@

Using EnergyPlus

set – see below).

-

What’s going on in V9.4?

+

What’s going on in V9.5?

@@ -110,9 +110,7 @@
Yes... and no.
"plugins" in lieu of writing user-defined Erl code. In the library mode, a client can make function calls to setup and execute a simulation, as well as interact with simulation results during a simulation. 👍 👍 👍
- With version 9.4 the library APIs heavily changed, so scripts will need to be updated. (Don't - worry we won't make a habit of that!). Details of these major changes along with other - significant features for this version are listed below in this readme. Also, see the full + See the full ChangeLog for a complete list of new features added in this and previous versions.

@@ -126,13 +124,13 @@
Yes... and no.
No, they are different
-

There are a few key changes in the V9.4 IDD. For best results, use the transition program to - transfer from the earlier V9.3 files. Use the IDFVersionUpdater program for best results.

+

There are a few key changes in the V9.5 IDD. For best results, use the transition program to + transfer from the earlier V9.4 files. Use the IDFVersionUpdater program for best results.

@@ -143,7 +141,7 @@
No, they are different
@@ -151,17 +149,19 @@
Some objects require transition
There have been changes in the following objects which require conversion. Either read and follow the Rules document or use the IDFVersionUpdater utility. The “Rules” document contains information on exact object changes that you can do by hand. The updater program is described more fully in the Auxiliary - Programs document. For the v9.4 release, the following objects require conversion (from V9.3): + Programs document. For the v9.5 release, the following objects require conversion (from V9.4):
    +
  • Construction:AirBoundary
    • +
  • Coil:Cooling:WaterToAirHeatPump:EquationFit
    • +
  • Coil:Heating:WaterToAirHeatPump:EquationFit
  • Construction:InternalSource
    • -
  • ZoneHVAC:HybridUnitaryHVAC
    • -
  • Output:DebuggingData
    • -
  • Output:Diagnostics
    • +
  • HeatPump:WaterToWater:EquationFit:Cooling
    • +
  • HeatPump:WaterToWater:EquationFit:Heating
    • +
  • ZoneAirMassFlowConservation
  • ZoneHVAC:LowTemperatureRadiant:VariableFlow
    • -
  • ZoneHVAC:LowTemperatureRadiant:VariableFlow
    • -
  • ZoneHVAC:LowTemperatureRadiant:Electric
  • ZoneHVAC:LowTemperatureRadiant:ConstantFlow
    • -
  • Multiple Objects Affected with Fuel type Synonym Unification
    • +
  • ZoneHVAC:Baseboard:RadiantConvective:Water
    • +
  • ZoneHVAC:Baseboard:RadiantConvective:Steam
@@ -228,18 +228,7 @@

Weather Data

about the included (or other) files. Weather data for more than 2100 locations in more than 100 countries can be downloaded on the EnergyPlus Weather Page.

-

An Important Note About the API

-

- Under normal circumstances, we intend on providing a very stable API for clients to access EnergyPlus. - However, as somewhat expected (see 9.3 README), the first release of the API was always likely to expose - some cases that would require a change in the API. Indeed it did. The change is pretty widespread through the - API, but quite an easy change to make. In summary - a new argument is needed in most functions, including - Python Plugin method overrides and user-defined runtime API callback functions. The client merely needs to - accept this argument in functions and pass it back in to the API methods. More information can be found in the - input-output reference document. -

- -

Highlights of this release (V9.4.0)

+

Highlights of this release (V9.5.0)

New Features

@@ -332,13 +321,13 @@

Targeted Refactoring Efforts

Platforms

- Packages changed slightly with 9.4. We are now building our packages on a new system which adds better support - for some platforms. During the change, we are stepping away from some older OS versions. For example, we are + Packages changed slightly with the previous release (9.4). + We began building our packages on a new system which adds better support + for newer platforms. During the change, we stepped away from some older OS versions. For example, we are not testing on Windows 7 or 8, only 10. However, both our 32-bit and 64-bit packages now include the new Python plugin system, rather than just the 64-bit as previously. We have also added packaging and testing with Ubuntu 20.04 in addition to Ubuntu 18.04. On Mac, we are officially releasing an installer for - OSX 10.15, although we will make an effort to offer a package for an older version. (Though 10.15 has been - out for a while now...) + OSX 10.15.

  • Windows 10
    • @@ -422,7 +411,7 @@

    Additional steps you may want to consider:

    -

    Copyright © 1996-2020 The Board of Trustees of the University of Illinois, The Regents of the University of +

    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 From 3013fdda7d8afb4143583ac598712ae5e9edb5d0 Mon Sep 17 00:00:00 2001 From: Edwin Lee Date: Tue, 30 Mar 2021 14:24:28 -0500 Subject: [PATCH 3/5] Add new features to readme --- release/readme.html | 82 +++++++++++++++++++++++++++------------------ 1 file changed, 49 insertions(+), 33 deletions(-) diff --git a/release/readme.html b/release/readme.html index 1d108d01288..946ada1f6e2 100644 --- a/release/readme.html +++ b/release/readme.html @@ -236,74 +236,90 @@

    New Features

- - + + - - + + - - + + - - + + - - + + - - + + -
Description
8100Resilience Metrics Reporting8327Expand access for ancillary power inputs and total electricity rate/energy to all coil types in UnitarySystem
8113Implementation of On-Off Control Capabilities for the Variable Flow and Electric Low Temperature Radiant Systems8405Improve PMV Calculations to consider cooling credit for elevated air velocity
8170Enhancement of Low Temperature Radiant Models to Allow Multi-Zone Systems8413Additional fuel types for Generator:*Turbine objects
8183Implement Changeover Delay for Hydronic Low Temperature Radiant Systems8417CondFD Surface Actuators
8269Allow Multiple Scheduled Shades to Reference a Single Window8460NFP-Zone Air Mass Flow Balance Improvement
7821Add Report of SEER calculated using the user specified PLF curve and default AHRI curve and C_D8464Change EquationFit coils to reference curves
-

Runtime Performance Enhancing Developments

- - - + + - - + + - - + + - - + + - - + + + + + +
PR #Description8474Dual units option for tabular output report
7904Native E+ CSV output and conditional output file selection8477Add EMS Actuator for View Factor to Ground
7963Skip interzone diffuse solar exchange factors calculations when no interzone window exists8499ElectricLoadCenter:Storage:LiIonNMCBattery
8141SurfaceWindow struct refactoring8518ASTM C1340 Convection Coefficient Algorithm for Radiant Barriers
8182Bypass interior solar distribution calculation at night8529New Outdoor Air Details report
8549Allow HPWH and Zonal ERVs to be modeled with AFNs
-

Targeted Refactoring Efforts

+

Runtime Performance Enhancing Developments

- - + + + + + + + + + + + + + + - - + + +
PR # Description
8157WeatherManager clean up8257Surface Window data struct & heat balance routines refactoring
8347Heat balance surface data structure refactoring
8370Construction:AirBoundary - remove solar and radiant method fields
8540TDD surface reordering and bug fixing
8173Fix State confusion around API8591Refactoring of interpolation functions for blinds Prof and Slat Angle
+

Targeted Refactoring Efforts

+ - - + + - +
8211Global Pointer-to-Implementation RedesignPR #Description
(MANY)Many refactoring efforts to clean up global variable usage in EnergyPlusCompleted removing global and static variables from EnergyPlus
From a40fa131a0c1d605241734d329cfcdb548166c75 Mon Sep 17 00:00:00 2001 From: Edwin Lee Date: Tue, 30 Mar 2021 14:27:13 -0500 Subject: [PATCH 4/5] Minor tweak to readme --- release/readme.html | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/release/readme.html b/release/readme.html index 946ada1f6e2..4df993df1e9 100644 --- a/release/readme.html +++ b/release/readme.html @@ -94,7 +94,7 @@

What’s going on in V9.5?

@@ -110,6 +110,10 @@
Yes... and no.
"plugins" in lieu of writing user-defined Erl code. In the library mode, a client can make function calls to setup and execute a simulation, as well as interact with simulation results during a simulation. 👍 👍 👍
+ A key effort completed with 9.5 was making EnergyPlus "thread-safe" by removing all global and + static data from the program. Now each running thread of EnergyPlus has a complete simulation + state, and no data is shared, so multiple runs can happen within a single process, opening the + door for interesting new workflows and applications.
See the full ChangeLog for a complete list of new features added in this and previous versions. From 6296d2a29b851fdacaaadb39050d8fe1f2dc797b Mon Sep 17 00:00:00 2001 From: Edwin Lee Date: Tue, 30 Mar 2021 15:03:17 -0500 Subject: [PATCH 5/5] Add 94-95 rules to install package --- src/Transition/CMakeLists.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Transition/CMakeLists.txt b/src/Transition/CMakeLists.txt index 1fdd2aa318c..db3045f67b6 100644 --- a/src/Transition/CMakeLists.txt +++ b/src/Transition/CMakeLists.txt @@ -161,6 +161,7 @@ install(FILES "InputRulesFiles/Rules9-0-0-to-9-1-0.md" DESTINATION "PreProcess/I install(FILES "InputRulesFiles/Rules9-1-0-to-9-2-0.md" DESTINATION "PreProcess/IDFVersionUpdater") install(FILES "InputRulesFiles/Rules9-2-0-to-9-3-0.md" DESTINATION "PreProcess/IDFVersionUpdater") install(FILES "InputRulesFiles/Rules9-3-0-to-9-4-0.md" DESTINATION "PreProcess/IDFVersionUpdater") +install(FILES "InputRulesFiles/Rules9-4-0-to-9-5-0.md" DESTINATION "PreProcess/IDFVersionUpdater") # output changes file first introduced with v8.5.0, so no older ones exist install(FILES "OutputRulesFiles/OutputChanges8-4-0-to-8-5-0.md" DESTINATION "PreProcess/IDFVersionUpdater")