The documentation library has four components: Menus to
other documents, User Information, Engineering Reference and
Developer Information. All library documents are in portable
document format (PDF) form. There are several PDF readers
available including the original Adobe reader (Adobe’s reader
is available as a download from their web site at no charge).
Below are brief descriptions of the various components of the
EnergyPlus Documentation Library.
The main menu is not so much a document as a
navigation system to the rest of the documents in the library.
In Windows installations, you can actually perform complex
searching on the other documents through this menu.
If you press the button that says “press to search documents”,
the Adobe search menu will be displayed. You then enter the
word or phrase you want to search for (such as a Output:Variable
name) and it will display on screen the documents that contain
that word or phrase. You can then scroll through each found
place and display the descriptions.
The following documents relate to using EnergyPlus,
the engine. These documents cover a full range of
questions and should be the first place a beginning or even
experienced user would go to find out how the program works,
what it expects as input, what it produces as output, etc. In
general, the information in these documents is not highly
technical, but it is detailed enough to use the basic
capabilities of the program.
Getting Started with EnergyPlus - the Basics
Manual: You are currently reading the Overview
section of this document. The overview contains a “big
picture” description of the EnergyPlus program as well as
background of its development and the goals to which it
ascribes. The remainder of the Getting Started document
provides beginning users with an introduction into how to run
EnergyPlus, what files are needed for EnergyPlus to execute,
and what files are produced when EnergyPlus runs successfully.
It also provides some guidance as to how to determine what
potential sources of errors are when EnergyPlus runs into
problems and how serious those problems might be.
Input and Output Reference: This document
is a thorough description of the various input and output
files related to EnergyPlus, the format of these files, and
how the files interact and interrelate.
Output Details, Examples and Data Sets:
While the Input and Output Reference document touch on some of
the outputs from EnergyPlus, this document has more details
and specific examples. It also addresses the reference data
sets that are included.
Auxiliary Programs: This document contains
information for the auxiliary programs that are part of the
EnergyPlus package. For example, this document contains the
user manual for the Weather Converter program, descriptions on
using Ground Heat Transfer auxiliary programs with EnergyPlus,
Compact HVAC descriptions, the Transition program/package and
other assorted documents.
The Engineering Reference provides more
in-depth knowledge into the theoretical basis behind the
various calculations contained in the program. This reference
includes more information on modeling equations, limitations,
literature references, etc. The document contains the
following information and is structured along the lines of the
above illustration (Figure 2. EnergyPlus – Internal
elements).
Heat Balance Overview and Reference: This
section describes the heat balance calculations that form the
basis of the EnergyPlus building model. It includes
descriptions of shadowing calculations and other pieces of the
model.
HVAC Overview and Reference: This section
contains a description of the loop-based approach used by
EnergyPlus to model the HVAC systems: air loops, water loops,
etc. It includes a description of the higher-level managers
that control the simulation flow as well as some information
on the various components that can be linked together to
comprise an HVAC system.
HVAC Branch
Based Input Description: This section is a special
extension of both the input document and the HVAC overview
document. It contains more detail on the various HVAC input
objects and how these different object link together to form
an HVAC description. It contains vital information mainly for
the interface developer but also provides users with an
in-depth look at the inner workings of the loop approach
adopted by EnergyPlus.
Encyclopedic Reference: If the information
did not fit in the above categories, then the last part of the
Engineering Reference is a detailed description of the various
models.
The application guides are intended to address
specific applications using EnergyPlus where the other
documents may not provide cohesive examples of intended usage;
that is, the techniques for doing certain things may be spread
throughout other documents but warrant a more “how to”
approach that will be present in these documents. The
application guides are intended to become more prolific over
time, specifically targeted to questions users have sent to
the helpdesk support site.
Current Application Guides:
EMS Application Guide: **This guide
contains information useful to use the advanced feature of
EnergyPlus: Energy Management System tweaks. The Erl language
is described and examples for use are given.
Using EnergyPlus for Compliance Guide:
This guide contains information specific to using EnergyPlus
in Compliance and Standard Rating systems.
External Interface(s) Application Guide:
This guide contains information about external interfaces
(through the Building
Controls Virtual Test Bed link) to EnergyPlus.
Tips & Tricks for Using EnergyPlus:
This guide contains short tips and tricks for using various
parts of EnergyPlus.
Developer
Menu and Developer Information Documents[LINK]
The following documents will be most useful to
potential developers of EnergyPlus, both Interface Developers
and Module Developers. Interface Developers will be
creating input and output wraps on EnergyPlus so that is it is
usable to the architect, design engineers, and others. Module
developers will be creating new modules within the EnergyPlus
structure and framework.
Programming Standards: This document is
the source of all major policies relating to the actual
EnergyPlus source code. It describes rules to which all
program code should adhere, notes how to structure and
modularize code, and provides a listing of “approved” input
and output units. As a result, it is an important document for
both interface and module developers.
Interface Developer’s Guide: This document
is critically important to persons interested in developing an
interface that provides input to and read output from
EnergyPlus. It is a comprehensive guide to the input data
dictionary and the input data files that contain a user’s
building data. Each piece of input syntax is described in
detail. In addition, the mechanism for obtaining output and
the format in which output will be produced are discussed.
This document also contains sections on weather files and
units. Numerous samples and examples are given throughout the
document with a full file length example provided in the
appendix.
Module Developer’s Guide: This document
contains a wealth of information that is intended to provide
as much assistance as possible to persons interested in adding
modules to the EnergyPlus program. It reviews the module
concept as outlined in the programming standard and how they
have been implemented in EnergyPlus. It provides a description
of how the various modules work together and how the program
is structured from a module tree (inverted tree) perspective.
One of the most important features of this document is a list
of standard EnergyPlus service subroutines and modules that
greatly simplify the developers’ task of integrating their
work into the program. Input and output issues are also
addressed from the perspective of how modules actually obtain
data from the input file and how each section of the code
sends data to the output files.
EnergyPlus Documentation Library[LINK]
The documentation library has four components: Menus to other documents, User Information, Engineering Reference and Developer Information. All library documents are in portable document format (PDF) form. There are several PDF readers available including the original Adobe reader (Adobe’s reader is available as a download from their web site at no charge). Below are brief descriptions of the various components of the EnergyPlus Documentation Library.
Main Documentation Menu[LINK]
The main menu is not so much a document as a navigation system to the rest of the documents in the library. In Windows installations, you can actually perform complex searching on the other documents through this menu. If you press the button that says “press to search documents”, the Adobe search menu will be displayed. You then enter the word or phrase you want to search for (such as a Output:Variable name) and it will display on screen the documents that contain that word or phrase. You can then scroll through each found place and display the descriptions.
User Information Documents[LINK]
The following documents relate to using EnergyPlus, the engine. These documents cover a full range of questions and should be the first place a beginning or even experienced user would go to find out how the program works, what it expects as input, what it produces as output, etc. In general, the information in these documents is not highly technical, but it is detailed enough to use the basic capabilities of the program.
Getting Started with EnergyPlus - the Basics Manual: You are currently reading the Overview section of this document. The overview contains a “big picture” description of the EnergyPlus program as well as background of its development and the goals to which it ascribes. The remainder of the Getting Started document provides beginning users with an introduction into how to run EnergyPlus, what files are needed for EnergyPlus to execute, and what files are produced when EnergyPlus runs successfully. It also provides some guidance as to how to determine what potential sources of errors are when EnergyPlus runs into problems and how serious those problems might be.
Input and Output Reference: This document is a thorough description of the various input and output files related to EnergyPlus, the format of these files, and how the files interact and interrelate.
Output Details, Examples and Data Sets: While the Input and Output Reference document touch on some of the outputs from EnergyPlus, this document has more details and specific examples. It also addresses the reference data sets that are included.
Auxiliary Programs: This document contains information for the auxiliary programs that are part of the EnergyPlus package. For example, this document contains the user manual for the Weather Converter program, descriptions on using Ground Heat Transfer auxiliary programs with EnergyPlus, Compact HVAC descriptions, the Transition program/package and other assorted documents.
Engineering Reference Document[LINK]
The Engineering Reference provides more in-depth knowledge into the theoretical basis behind the various calculations contained in the program. This reference includes more information on modeling equations, limitations, literature references, etc. The document contains the following information and is structured along the lines of the above illustration (Figure 2. EnergyPlus – Internal elements).
Heat Balance Overview and Reference: This section describes the heat balance calculations that form the basis of the EnergyPlus building model. It includes descriptions of shadowing calculations and other pieces of the model.
HVAC Overview and Reference: This section contains a description of the loop-based approach used by EnergyPlus to model the HVAC systems: air loops, water loops, etc. It includes a description of the higher-level managers that control the simulation flow as well as some information on the various components that can be linked together to comprise an HVAC system.
HVAC Branch Based Input Description: This section is a special extension of both the input document and the HVAC overview document. It contains more detail on the various HVAC input objects and how these different object link together to form an HVAC description. It contains vital information mainly for the interface developer but also provides users with an in-depth look at the inner workings of the loop approach adopted by EnergyPlus.
Encyclopedic Reference: If the information did not fit in the above categories, then the last part of the Engineering Reference is a detailed description of the various models.
Application Menu and Application Guides[LINK]
The application guides are intended to address specific applications using EnergyPlus where the other documents may not provide cohesive examples of intended usage; that is, the techniques for doing certain things may be spread throughout other documents but warrant a more “how to” approach that will be present in these documents. The application guides are intended to become more prolific over time, specifically targeted to questions users have sent to the helpdesk support site.
Current Application Guides:
EMS Application Guide: **This guide contains information useful to use the advanced feature of EnergyPlus: Energy Management System tweaks. The Erl language is described and examples for use are given.
Using EnergyPlus for Compliance Guide: This guide contains information specific to using EnergyPlus in Compliance and Standard Rating systems.
External Interface(s) Application Guide: This guide contains information about external interfaces (through the Building Controls Virtual Test Bed link) to EnergyPlus.
Tips & Tricks for Using EnergyPlus: This guide contains short tips and tricks for using various parts of EnergyPlus.
Developer Menu and Developer Information Documents[LINK]
The following documents will be most useful to potential developers of EnergyPlus, both Interface Developers and Module Developers. Interface Developers will be creating input and output wraps on EnergyPlus so that is it is usable to the architect, design engineers, and others. Module developers will be creating new modules within the EnergyPlus structure and framework.
Programming Standards: This document is the source of all major policies relating to the actual EnergyPlus source code. It describes rules to which all program code should adhere, notes how to structure and modularize code, and provides a listing of “approved” input and output units. As a result, it is an important document for both interface and module developers.
Interface Developer’s Guide: This document is critically important to persons interested in developing an interface that provides input to and read output from EnergyPlus. It is a comprehensive guide to the input data dictionary and the input data files that contain a user’s building data. Each piece of input syntax is described in detail. In addition, the mechanism for obtaining output and the format in which output will be produced are discussed. This document also contains sections on weather files and units. Numerous samples and examples are given throughout the document with a full file length example provided in the appendix.
Module Developer’s Guide: This document contains a wealth of information that is intended to provide as much assistance as possible to persons interested in adding modules to the EnergyPlus program. It reviews the module concept as outlined in the programming standard and how they have been implemented in EnergyPlus. It provides a description of how the various modules work together and how the program is structured from a module tree (inverted tree) perspective. One of the most important features of this document is a list of standard EnergyPlus service subroutines and modules that greatly simplify the developers’ task of integrating their work into the program. Input and output issues are also addressed from the perspective of how modules actually obtain data from the input file and how each section of the code sends data to the output files.
Documentation content copyright © 1996-2026 The Board of Trustees of the University of Illinois and the Regents of the University of California through the Ernest Orlando Lawrence Berkeley National Laboratory. All rights reserved. EnergyPlus is a trademark of the US Department of Energy.
This documentation is made available under the EnergyPlus Open Source License v1.0.