From 1b74173a63ee858a3994f00f27e3c568509a860f Mon Sep 17 00:00:00 2001 From: Edwin Lee Date: Mon, 23 Sep 2024 09:45:59 -0500 Subject: [PATCH] Update readme --- release/readme.in.html | 130 ++++++++++++++++++++++++----------------- 1 file changed, 78 insertions(+), 52 deletions(-) diff --git a/release/readme.in.html b/release/readme.in.html index b86d7adc888..eff1f6fe1b5 100644 --- a/release/readme.in.html +++ b/release/readme.in.html @@ -1,5 +1,5 @@ - + @@ -35,7 +35,8 @@
-

EnergyPlus Logo EnergyPlus

+

+ EnergyPlus Logo EnergyPlus

Version @CMAKE_VERSION_MAJOR@.@CMAKE_VERSION_MINOR@.@CMAKE_VERSION_PATCH@
@CMAKE_PROJECTED_RELEASE_DATE@
@@ -90,12 +91,41 @@

Using EnergyPlus

* Python Ecosystem *

- While EnergyPlus will continue to provide users with current workflows and installation methods, we are pushing - toward a more flexible EnergyPlus that behaves like a standard Python library. An upcoming version will allow - users to pip install energyplus, which will bring down the EnergyPlus native libraries plus the Python API - bindings, ready to be used by the user's desired Python environment. This should make setting up EnergyPlus - much easier for many use cases! + The EnergyPlus-Python connections continue to grow. The Python-focused deployment via PyPi is still coming, + but will remain on the test server on PyPi for now. + Once official releases are ready, they will be on the + main PyPi page, so check there if interested. + The pip install energyplus experience will bring EnergyPlus native libraries plus the Python API + bindings, ready to be used by the user's desired Python environment. This should make setting up EnergyPlus + much easier for many Python-facing use cases!

+

+ In addition to the Pip Install work coming along, we are also working to improve our Python integration for + traditional EnergyPlus use cases. As of 24.2, when a user downloads the install package onto their machine, + they will get the new cross-platform Python-based EP-Launch. The classic EP-Launch is still packaged for now, + but will likely be deprecated in favor of the Python tools soon. There are two ways to launch this new + EP-Launch: +

    +
  • + For Windows, there is a batch file right inside the EnergyPlus install folder called + EPLaunchPython that will launch the EP-Launch application: + EnergyPlus Python Launch Shortcut + Just double click it! It will open a terminal window before launching the Python app, but + you can ignore that for now. Once we get some testing feedback, we'll include it as a proper shortcut + on the Start Menu and other locations. +
    • +
  • + On all platforms, you can launch the new EP-Launch right from the command line using a new auxiliary + command class. Simply launch a terminal, and execute a single command. On Windows, it would be + C:\Path\To\EnergyPlusV24-2-0\energyplus.exe auxiliary eplaunch. On POSIX-y systems, it would + be /path/to/energyplus auxiliary eplaunch. Give it a try and let us know how it goes. As + always, we appreciate issue reports on our + GitHub repository. +
    • +
+

What’s going on in V@CMAKE_VERSION_MAJOR@.@CMAKE_VERSION_MINOR@?

@@ -158,23 +188,21 @@
No, they are different
aria-expanded="false" aria-controls="collapseCompatible"> Is version @CMAKE_VERSION_MAJOR@.@CMAKE_VERSION_MINOR@ backward compatible? - Can I run v@PREV_VERSION_MAJOR@.@PREV_VERSION_MINOR@ file in v@CMAKE_VERSION_MAJOR@.@CMAKE_VERSION_MINOR@? + Can I run v@PREV_VERSION_MAJOR@.@PREV_VERSION_MINOR@ file in + v@CMAKE_VERSION_MAJOR@.@CMAKE_VERSION_MINOR@?
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 + 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.
    -
  • AirLoopHVAC:UnitarySystem
    • -
  • ComfortViewFactorAngles
    • -
  • HeatExchanger:AirToAir:SensibleAndLatent
    • -
  • People
    • -
  • ZoneHVAC:PackagedTerminalAirConditioner
    • -
  • ZoneHVAC:PackagedTerminalHeatPump
    • -
  • ZoneHVAC:WaterToAirHeatPump
    • +
  • HeatPump:PlantLoop:EIR:Cooling
    • +
  • HeatPump:PlantLoop:EIR:Heating
    • +
  • OutputControl:Files
    • +
  • ZoneHVAC:TerminalUnit:VariableRefrigerantFlow
@@ -215,7 +243,7 @@

Documentation

href="https://energyplus.net/documentation">online. For new users of EnergyPlus, a guide called the EnergyPlus Essentials was developed and is available with the installed pdf documentation. Big Ladder Software is also hosting html versions of the - EnergyPlus Documentation online. + EnergyPlus Documentation online.

There are some other documents of interest available on the EnergyPlus web site including:

@@ -246,31 +274,32 @@

New Features

Description - 10081 - API Enhancements + 10311 + NewFeature: Additional ASHRAE Metrics for E+ 24-1 - 10277 - Enhancement for Heat Exchanger for Variable-Speed Heat Recovery Ventilation + 10372 + Add Reports to Support createRMD - ruleset model description - 10363 - Add E+ API demo to the install + 10379 + Air-To-Water Heat Pump with Heat Recovery - 10385 - Indoor living wall module + 10415 + Chiller economizing using thermosiphon or fluid heat exchanger free cooling - -

Runtime Performance Enhancing Developments

- - - + + - - + + + + + +
PR #Description10511Variable flow condenser plant control
10231SetupOutputVariable wrapper to use enum type parameters (endUseCategory, ReportingFrequency, and eResouceType)10658A couple API Endpoints
10716Initial Python App Packaging

Targeted Refactoring Efforts

@@ -280,24 +309,20 @@

Targeted Refactoring Efforts

Description - 10281 - Initial WeatherManager refactor - - - 10289 - First (and only?) Pollution module refactor + 10323 + Reformat eplusout.dbg file for easier excel viewing - 10347 - OutputProcessor Refactor + 10474 + Fans Refactor - 10351 - DaylightingManager Refactor -- Part 2 + 10720 + Material Refactor - 10404 - Heat Pump Plant Loop EIR refactoring + Many PRs + Addressing CppCheck warnings and suggestions across our codebase @@ -316,18 +341,18 @@

Targeted Refactoring Efforts

Platforms

- We test and develop on Windows 10 and 11, and currently produce 32 and 64 bit builds on Windows. The 32-bit - build is likely to be removed at some point soon. For Linux, we provide packages for - Ubuntu 20.04 and 22.04. This release also includes an Ubuntu 18.04 build, but moving forward we will be - eliminating that. On Mac, we are releasing an installer for OSX 10.15, 11, and 12, but the 10.15 will be + We test and develop on Windows 10 and 11, and currently produce 32 and 64 bit builds on Windows. The 32-bit + build is likely to be removed at some point soon. For Linux, we provide packages for + Ubuntu 20.04 and 22.04. This release also includes an Ubuntu 18.04 build, but moving forward we will be + eliminating that. On Mac, we are releasing an installer for OSX 10.15, 11, and 12, but the 10.15 will be eliminated soon.

    -
  • Windows 10 and 11
    • +
  • Windows 11
  • - Linux (Ubuntu 18.04, 20.04, 22.04) 64 bit versions + Linux (Ubuntu 22.04 and 24.04) 64 bit versions
    • -
  • Mac OSX 10.15, 11, and 12 64 bit versions
    • +
  • Mac OSX 12 x64 and 13 arm64
  • EnergyPlus V@CMAKE_VERSION_MAJOR@.@CMAKE_VERSION_MINOR@ has been tested on all of these platforms
    • @@ -412,7 +437,8 @@

    Additional steps you may want to consider:

    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.

    -

    Other Notices and Acknowledgments are found in the Other Notices and Acknowledgments are found in the + Acknowledgments document.