Documentation¶
The EnergyPlus documentation is currently included in the installation in the "Documentation" folder as PDFs. It is also available as PDFs online and from third parties that have generated HTML documentation from the source. Using search in the documentation is critical to finding the information needed. Some of the documentation PDFs are very large, so searching is a good way to find specific information about a topic or an input object. The documentation includes:
- QuickStart Guide: Contains a brief high-level overview of EnergyPlus and get you up and running quickly with the program
- Input Output Reference: Contains 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 and Examples: Contains details on output from EnergyPlus. It also addresses the reference data sets that are included.
- Auxiliary Programs: 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, and other assorted topics.
- Engineering Reference: Provides more in-depth knowledge into the theoretical basis behind the various calculations contained in the program including algorithm descriptions.
- Application Guide for EMS: Provides an in-depth look at the Energy Management System (EMS) feature which provides a way to develop custom control and modeling routines.
- External Interface(s) Application Guide: Contains information specific to using the external interface feature of EnergyPlus to connect other simulation systems.
- Plant Application Guide: Details the methods for simulating chilled and hot water plant systems within EnergyPlus.
- Using EnergyPlus for Compliance Guide: Contains information specific to using EnergyPlus in compliance and standard rating systems.
- Tips & Tricks for Using EnergyPlus: Contains short tips and tricks for using various parts of EnergyPlus.