release
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
parent directory.. | ||||
<!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 README</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 22.1.0<br>
31 March 2022<br>
<em>EnergyPlus is a trademark of the US Department of Energy.</em>
</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2"></div>
<div class="col-md-8 text-center">
EnergyPlus is a simulation program designed for modeling buildings with all their associated
heating, cooling, lighting, ventilating, and other energy flows. EnergyPlus is a stand-alone simulation
engine
without a ‘user friendly’ graphical interface. EnergyPlus reads input and writes output as text files,
although as of 9.3, EnergyPlus started becoming a library.
</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>Using EnergyPlus</h2>
<p>
Utilities and tools for creating, editing, and running input files that come with EnergyPlus include IDF Editor
and EP-Launch. Many graphical user interfaces for EnergyPlus are available or under development. For the latest
tools, please see
<a href="https://www.buildingenergysoftwaretools.com/?capabilities=Whole-building+Energy+Simulation&keywords=EnergyPlus">
this website for third party interfaces</a>. A completely new cross-platform version of EP-Launch has been
developed and is available separate from the EnergyPlus install; see the <a
href="https://ep-launch.readthedocs.io/en/latest/intro.html#ep-launch">documentation</a> for more
information. Some tools may produce out of date IDF files; you can then use the IDFVersionUpdater program to
convert older files to current EnergyPlus version (you may need to use the Multiple Version Conversions
set – see below).
</p>
<h2>* Version Numbers *</h2>
<p>
EnergyPlus historically used version numbers that varied the major number and sometimes the minor
number. Starting with the March 2022 release, we are moving forward with a more modern version numbering scheme.
The EnergyPlus version will be based on the year and the release number. The March 2022 release is
EnergyPlus 22.1 and the Fall release will be EnergyPlus 22.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 22.1.1.
</p>
<h2><a id="Whats_going_on"></a>What’s going on in V22.1?</h2>
<div class="row">
<div class="col-md-12">
<a class="btn btn-primary margin-bottom-6" data-toggle="collapse" href="#cDifferent" role="button"
aria-expanded="false"
aria-controls="cDifferent">
Is 22.1 different from 9.6?
</a>
<div class="collapse" id="cDifferent">
<div class="card card-body">
<h5 class="card-title">Yes... and no.</h5>
<p class="card-text">
For a majority of users, EnergyPlus is still
basically the same tool, but with some great new features, bug fixes, and runtime performance
improvements. Running EnergyPlus can still be accomplished the same way, by creating an input
file in IDF or EpJSON syntax, running the EnergyPlus(.exe) binary, and gathering results of
interest. All this power is still available. 👍 <br>
As of EnergyPlus 9.3, EnergyPlus started becoming a bit more flexible thanks to the addition of
a formal C API with Python Bindings, as well as the ability to execute user-defined Python
"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 <b>during</b> a simulation. 👍 👍 👍<br>
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. <br>
See the full
<a href="https://github.com/NREL/EnergyPlus/releases/latest" class="card-link">ChangeLog</a>
for a complete list of new features added in this and previous versions.
</p>
</div>
</div>
</div>
</div>
<div class="row">
<div class="col-md-12">
<a class="btn btn-primary margin-bottom-6" data-toggle="collapse" href="#collapseIDDIDF" role="button"
aria-expanded="false"
aria-controls="collapseIDDIDF">
Are 22.1 and 9.6 IDD and IDF files the same?
</a>
<div class="collapse" id="collapseIDDIDF">
<div class="card card-body">
<h5 class="card-title">No, they are different</h5>
<p class="card-text">There are a few key changes in the V22.1 IDD. For best results, use the
transition program to
transfer from the earlier V9.6 files. Use the IDFVersionUpdater program for best results.</p>
</div>
</div>
</div>
</div>
<div class="row">
<div class="col-md-12">
<a class="btn btn-primary margin-bottom-6" data-toggle="collapse" href="#collapseCompatible" role="button"
aria-expanded="false"
aria-controls="collapseCompatible">
Is version 22.1 backward compatible? Can I run v9.6 file in v22.1?
</a>
<div class="collapse" id="collapseCompatible">
<div class="card card-body">
<h5 class="card-title">Some objects require transition</h5>
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 v22.1 release, there is only one object that requires conversion
(from V9.6)!
<ul class="list-group">
<li class="list-group-item transition-object-name">PythonPlugin:SearchPaths</li>
</ul>
</div>
</div>
</div>
</div>
<div class="row">
<div class="col-md-12">
<a class="btn btn-primary margin-bottom-6" data-toggle="collapse" href="#collapseInputCheck" role="button"
aria-expanded="false"
aria-controls="collapseInputCheck">
Will my updated file definitely work?
</a>
<div class="collapse" id="collapseInputCheck">
<div class="card card-body">
<h5 class="card-title">No, not definitely</h5>
With every EnergyPlus release, there are new checks on user input. Even if your file ran in an
earlier version, it may not run in the newer version after conversion due to newer checks on the
validity of input.
</div>
</div>
</div>
</div>
<h2><a id="Multiple_Version_Conversions_51"></a>Multiple Version Conversions</h2>
<p>
The install includes the IDFVersionUpdater program and the necessary programs to convert from the previous
version (including .rvi and .mvi files) to the current version. The install also includes the necessary programs
to convert from older versions back to v7.2.0. For versions older than v7.2.0, first we applaud your dedication
to EnergyPlus that stretches for quite some time, and second you will need to visit the
<a href="https://energyplushelp.freshdesk.com/support/solutions/folders/67000241428">Helpdesk</a> to request
multiple conversion set of programs.
</p>
<h2><a id="Documentation_55"></a>Documentation</h2>
<p>
The EnergyPlus documentation is included in pdf form in the installer. The pdfs are also available <a
href="https://energyplus.net/documentation">online</a>. For <strong>new users</strong> 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 <a href="http://bigladdersoftware.com/epx/docs/">online</a>.
</p>
<p>There are some other documents of interest available on the EnergyPlus web site including:</p>
<div class="list-group">
<a href="https://energyplus.net/quickstart" class="list-group-item list-group-item-action">An EnergyPlus
QuickStart Guide</a>
<a href="https://energyplus.net/testing" class="list-group-item list-group-item-action">Testing and Validation
Reports</a>
</div>
<p>
In addition, we are working to make our API documentation dynamic and hosted on ReadTheDocs. The
<a href="https://github.com/NREL/EnergyPlus/blob/develop/README.md">README</a> on our Github Repo will be kept
up to date with links to our documentation sources as we get things settled there.
</p>
<h2><a id="Weather_Data_63"></a>Weather Data</h2>
<p>A small subset of weather files that are available on the web site are also installed in the WeatherData folder.
EnergyPlus uses these files directly for annual simulations. The Weather Converter program that is part of
EnergyPlus can read these weather files and provide .csv (comma separated variable) as well as statistics
reports
about the included (or other) files. Weather data for more than 3000 locations in more than 100 countries can be
downloaded on the <a href="https://energyplus.net/weather">EnergyPlus Weather Page</a>.</p>
<h2>Highlights of this release (V22.1.0)</h2>
<h3><a id="Highlights_of_this_release"></a>New Features</h3>
<table class="table table-striped table-bordered">
<tr>
<th>PR #</th>
<th>Description</th>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/8740">8740</a></td>
<td>Add Window Assembly Factor Reporting and Fix Windows-CalcEngine U-value calculation with shade</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9151">9151</a></td>
<td>CondFD Surface Heat Source Actuators</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9169">9169</a></td>
<td>Change version numbering approach to YY.N</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9177">9177</a></td>
<td>Enhancement of Handling of Rainfall</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9185">9185</a></td>
<td>Enhancing Multi-speed Coil Speed Level Control Actuators</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9209">9209</a></td>
<td>Dedicated general exhaust system</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9251">9251</a></td>
<td>Flag added to toggle daylight saving when used with Schedule:File</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9261">9261</a></td>
<td>Adding SetpointManager:SystemNodeReset objects</td>
</tr>
</table>
<h3><a id="PerformanceFeatures"></a>Runtime Performance Enhancing Developments</h3>
<table class="table table-striped table-bordered">
<tr>
<th>PR #</th>
<th>Description</th>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9097">9097</a></td>
<td>Comment and cleanup of heat balance arrays</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9102">9102</a></td>
<td>Daylighting output revisions and other cleanup related to Enclosures vs Zones</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9255">9255</a></td>
<td>Speed up execution of test suite</td>
</tr>
</table>
<h3><a id="RefactoringEfforts"></a>Targeted Refactoring Efforts</h3>
<table class="table table-striped table-bordered">
<tr>
<th>PR #</th>
<th>Description</th>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9013">9013</a></td>
<td>Refactor DataHeatBalance</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9053">9053</a></td>
<td>Conversion to enum class - DataPlant::PlantEquipmentType</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9130">9130</a></td>
<td>Convert `const` `int`/`double` to `constexpr` Where Possible</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9137">9137</a></td>
<td>Clean up for PR: conv to enum DataPlant::PlantEquipmentType #9053</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9163">9163</a></td>
<td>Enum Refactor: DataZoneEquipment</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9166">9166</a></td>
<td>Convert remaining `const` `int`/`double` in `state` to `constexpr`</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9167">9167</a></td>
<td>Move `const` `Array1D`/`2D` to `constexpr std::array`</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9168">9168</a></td>
<td>Unify Enum Format - 1</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9170">9170</a></td>
<td>Convert `int constexpr` to `enum` : EconomicLifeCycleCost.*</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9199">9199</a></td>
<td>Convert compressor operation from int constexpr to enum</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9212">9212</a></td>
<td>Convert Plant LoopSides (Demand and Supply) to enum class</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9213">9213</a></td>
<td>Enum Refactor and follow-up for #9013</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9220">9220</a></td>
<td>Begin Passing ObjType enum</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9223">9223</a></td>
<td>Convert Plant Location to struct form</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9232">9232</a></td>
<td>Reduce Optional_string usage</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9235">9235</a></td>
<td>Cleanup interface manager</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/9244">9244</a></td>
<td>enum-based SELECT_CASE_var</td>
</tr>
</table>
<div class="row">
<div class="col-md-1"></div>
<div class="col-md-10">
<blockquote class="blockquote text-center">
<p class="mb-0">
The full changelog is no longer packaged with EnergyPlus, but can be found on the <a
href="https://github.com/NREL/EnergyPlus/releases/latest">release page</a>.
</p>
</blockquote>
</div>
<div class="col-md-1"></div>
</div>
<h2><a id="Platforms_90"></a>Platforms</h2>
<p>
Packages changed slightly as of the 9.4 release.
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 and 11. 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 <i>in addition to</i> Ubuntu 18.04. On Mac, we are officially releasing an installer for
OSX 10.15 and moving toward OSX 11 as well.
</p>
<ul class="list-group">
<li class="list-group-item">Windows 10 and 11</li>
<li class="list-group-item">Linux (Ubuntu 18.04 and 20.04) 64 bit versions</li>
<li class="list-group-item">Mac OSX 10.15 64 bit versions</li>
<li class="list-group-item">EnergyPlus V22.1 has been tested on all of these platforms</li>
<li class="list-group-item"><em>EnergyPlus does intensive computations, and based on configuration, can write
massive amounts of data to
disk. For best performance, computers should have a substantial amount of memory and high speed hard
drives.</em>
</li>
</ul>
<h2><a id="Installation_contents_100"></a>Installation contents</h2>
<p>The installation creates a program folder with icons/shortcuts for the programs/files in EnergyPlus that can be
accessed from Windows menus, including removing EnergyPlus from your system. In Windows OS, these will be
available from the “Programs” area in the Start Menu. Note that only a few of the programs will store anything
in your Windows\System directory (IDFEditor, EPLaunch, WeatherConverter).</p>
<h2><a id="Known_problems_104"></a>Known problems</h2>
<p>While every effort has been made to clean up all the “defects” that have occurred during our testing, quite a few
known (and even more unknown) probably remain. Specifics on the remaining known problems can be found on the
GitHub repository <a href="https://github.com/NREL/EnergyPlus/issues">issues page</a>. If you are interested in
what has been addressed, the issues resolved in this release are installed similarly in the
<a href="https://github.com/NREL/EnergyPlus/releases/latest">release details</a>.
</p>
<h2>Additional steps you may want to consider:</h2>
<ol>
<li>
<p>Download additional <a href="https://energyplus.net/weather">Weather Data</a> for use in running example
files or your files.</p>
</li>
<li>
<p>The <a href="https://unmethours.com/questions/">UnmetHours</a> forum allows users to search for answers,
ask new questions about
their building simulation models to other users, and generally get quick feedback. Members of the
EnergyPlus
development team are also on the forum answering when possible.
</p>
</li>
<li>
<p>The EnergyPlus helpdesk (<a href="https://energyplushelp.freshdesk.com/">energyplushelp.freshdesk.com</a>)
requires a login via self-registration or via sending a problem/question to the
email address <a href="mailto:[email protected]">[email protected]</a>. In addition
to having support tickets and responses from helpdesk personnel, there are knowledgebase articles.</p>
</li>
<li>
<p>BLDG-SIM: A free e-mail list for all building energy simulation program users to ask general building
simulation questions to other
users and to post announcements (for events, training, job postings, etc.).
See <a href="http://lists.onebuilding.org/listinfo.cgi/bldg-sim-onebuilding.org">lists.onebuilding.org/listinfo.cgi/bldg-sim-onebuilding.org</a>
for information on joining this email list.</p>
</li>
<li>
<p>Open-Source License (or distribution license): Licenses for the source code and distribution are
available from the website: <a href="https://energyplus.net/licensing">Licensing Info</a></p>
</li>
</ol>
<p>If you have any other questions, contact <a href="mailto:[email protected]">EnergyPlus Support</a>.</p>
<hr>
<div class="row">
<div class="col-md-2"></div>
<div class="col-md-8">
<blockquote class="blockquote text-center">
<p class="mb-0">
Thanks for downloading EnergyPlus.
Special thanks to our early testers for this release.
If you did not download the previous version, we welcome you.
If you are a returning customer, we hope you find the latest release exceeding your expectations.
We look forward to serving you!
</p>
<footer class="blockquote-footer">EnergyPlus Development, Testing, and Support Team</footer>
</blockquote>
</div>
<div class="col-md-2"></div>
</div>
<hr>
<footer>
<p>Copyright © 1996-2022 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>