Guide For Interface Developers: Everything You Need To Know About Energyplus Input and Output
Guide For Interface Developers: Everything You Need To Know About Energyplus Input and Output
COPYRIGHT 1998-2010 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. No part of this material may be reproduced or transmitted in any form or by any means without the prior written
permission of the University of Illinois or the Ernest Orlando Lawrence Berkeley National Laboratory.
EnergyPlus is a Trademark of the US Department of Energy.
TABLE OF CONTENTS
Introduction ......................................................................................................................................1
Figure 1. EnergyPlus Input/Output Overview ......................................................... 1
Interface Expectations....................................................................................................... 2
Input Interface Attributes ............................................................................................. 2
Post-processing Interface Attributes ........................................................................... 2
EnergyPlus Install Contents ............................................................................................................3
Input Overview .................................................................................................................................5
General Input Rules .......................................................................................................... 5
Input Data Dictionary......................................................................................................... 6
Rules specific to the Input Data Dictionary ................................................................. 6
Input Data File................................................................................................................... 6
Rules specific to Input Data file:.................................................................................. 6
Input Details .....................................................................................................................................7
IDD Conventions ............................................................................................................... 7
Using the Input-Output Reference Document ........................................................... 13
Figure 2. Using IDFEditor to find the latest groups and objects for the
Energy+.idd .......................................................................................................... 13
Standard EnergyPlus Units ............................................................................................. 14
Table 1. Standard EnergyPlus Units .................................................................... 14
EnergyPlus Reports ........................................................................................................ 15
Output ............................................................................................................................................16
Figure 3. Example Chart from Standard Output File ........................................... 17
Weather Data.................................................................................................................................18
Running EnergyPlus......................................................................................................................19
Table 2. EnergyPlus Output Files........................................................................ 19
Table 3. EnergyPlus Errors ................................................................................. 20
Table 4. Timings Comparison (EnergyPlus vs. BLAST)...................................... 20
4/20/10
TABLE OF CONTENTS
Licensing ........................................................................................................................................21
Appendix A. Simple IDF file..........................................................................................................22
4/20/10
ii
Introduction
Interface Expectations
Introduction
This document is intended for developers who are creating user interfaces for EnergyPlus. It
provides an overview of the essentials of the input-output structure of EnergyPlus and
describes the parts of each in detail.
Input
EnergyPlus Program
Main Program
File Types
Data Dictionary File (IDD)
File produced by Energy Plus developers.
Module
Module
Module
Module
Section;
Object,data,data,,data;
Object,data,data,,data;
End Section;
Module
Module
Output
File Types:
Standard Reports
Standard Reports (Detail)
Optional Reports
Optional Reports (Detail)
Initialization Reports
Overview of File Format:
Header
Data Dictionary
Data
Note: These files will
created by EnergyPlus.
files with the InputProcessor. The InputProcessor uses the specifications/rules defined
in the IDD and interprets the IDF raw data. The InputProcessor is really quite dumb and
only understands a few things about each field (alpha or numeric) qualified by certain key
elements in the IDD (\ comments which are discussed later).
4) Each module in EnergyPlus has one or several routines (normally called GetInput
routines) that obtain the information from the IDF file data. These subroutines decode
the portion of the IDF file that is pertinent to the local module. These GetInput routines
are more context sensitive than the InputProcessor and may perform further error
detection. For example, the cooling coil module may read in the coil type and its
associated parameters (number of rows, tube diameter, fin spacing, etc.).
5) EnergyPlus performs the simulation elements specified in the IDF. Output is generated
as a continuous stream (for the most part) and must be interpreted into a more cohesive
form by output processing. The user has control over which outputs are produced and
when/how often.
6) EnergyPlus produces output as required by the user into one of the output files. These
files can be readily processed into spreadsheet formats for graphing and other
summarizing.
4/20/10
Introduction
Interface Expectations
Interface Expectations
The input-output interfaces may be combined into a single program or may be available
separately. The following attributes are expected from these interfaces.
Input Interface Attributes
The input interface agents will be expected to fulfill two main requirements:
Perform the consistency and value checks necessary to assure that the input file
conforms to EnergyPlus requirements.
Additionally, the input interface agent might:
Ability to warn users about potential output file size. It is expected that the data files
generated by the EnergyPlus program will be significantly larger than the output files from
its parent programs. As a result, users may be unaware that selecting too many reports
could lead to enormous output files. It is recommended that some sort of checking be
done to alert users when the term of the simulation and the number of reports selected
eclipse some reasonable file size limit.
Ability to combine and summarize data (average, peak, total, etc.) and produce the
various text and graphical reports requested by the user.
4/20/10
Interface Expectations
4/20/10
Interface Expectations
Weather Converter: The WeatherConverter program can process raw weather data in
several formats into the EnergyPlus weather data format (epw).
In addition, the
WeatherConverter program can be used to generate a simple report of the weather data as
well as produce a .csv file of the format. The .csv (comma separated variable) format can
easily be imported into spread sheet programs or other tables. This program is installed in
the Parent \ PreProcess \ WeatherConverter folder. The WeatherConverter also has a DLL
file which could be used directly by an external interface.
BLAST Translator: The BLAST translator program can be used to convert a BLAST input
file into a format that can be executed from EnergyPlus. Extensive system translation is not
done with this program mostly geometry and other space gain elements as well as zone
oriented (i.e. People) schedules. If the BLAST input file contains thermostatic controls in the
zones, then the EnergyPlus IDF file will include a purchased-air solution of that BLAST input
file. This program is no longer part of the EnergyPlus install but is available with each new
release.
DOE-2 Translator: The DOE-2 translator program is similar to the BLAST Translator
program but for DOE-2 files. DOE-2 translator output must be processed by the EPMacro
program prior to running in EnergyPlus (the EP-Launch program/EPL-Run procedure does
this automatically for all .imf files). This program is no longer part of the EnergyPlus install
but is available with each new release.
4/20/10
Input Overview
Input Overview
The general structure of the input files for EnergyPlus is plain text. Fields are comma
delimited and each line is terminated with a semicolon. This allows for a very rudimentary
input processor that can be instantly flexible to developers needs. However, it puts more
burdens on the EnergyPlus developers to process the input information, supply defaults as
needed, and perform validity checks. Guidelines were established for the input:
Input will be a flat ASCII file with comma-delimited columns and each line (where each
line can run over several physical file records) terminated with a semicolon.
Input should be readable, editable, simply parsed with few value checks or
consistency checks.
Definitions in a data dictionary will define the input. The data dictionary should be selfdocumenting.
All input units will be metric (SI). Conversions from user units will be done in the
interface agents.
Two input files are necessary for the input processing. The first is the data dictionary which
will specify the requirements for each item. The EnergyPlus Input Processor uses these
requirements to process the input data file and report any anomalies found. Both input files
have similar structures: 1) Sections single lines/commands, which may help group the
simulation input for readability and 2) Classes/Objects data attributes for the simulation.
Classes are the term used in the data dictionary each class will specify the kind of data
(alpha or numeric) that will be included in the simulation input. Objects are instances of these
classes and appear in the IDF with appropriate data.
Fields do not extend over line boundaries. Usually, if a comma or (as appropriate) semicolon is not the last field value on a line, one will be inserted. Of course, several fields
may appear on a single line as long as they are comma separated.
Commas delimit fields therefore, no fields can have embedded commas. No error will
occur but you won't get what you want.
Input records can be up to 500 characters in length. If you go over that, no error will
occur but you won't get what you want.
Each Alpha string (including Section and Class/Object keywords) is mapped to UPPER
case during processing, unless the retaincase flag marks the field in the IDD. Get
routines from the EnergyPlus code that use the Section and Object keywords
automatically map to UPPER case for finding the item. The primary drawback with this is
that error messages coming out of the input processor will be in UPPER case and may
not appear exactly as input.
4/20/10
Input Overview
Special characters, such as tabs, should NOT be included in the file. However, tabs can
be accommodated and are turned into spaces.
Duplicate Section names and Duplicate Class names are not allowed. That is, the first
class of an item named X will be the one used during processing. Error messages will
appear if you try to duplicate definitions.
4/20/10
Each Alpha string in the input data file can be up to 100 characters in length. Anything
beyond that is truncated.
Input Details
IDD Conventions
Input Details
This document does not cover the input classes in detail. For details on each class and
examples of both input and output resulting from that class/object, please view the Input
Output Reference document. In this document, we will show the conventions used in the
IDD and provide limited examples for illustration purposes. Even the list of objects is
dynamic, so we give you a method to see them from the IDFEditor.
An intelligent editor (IDFEditor) has been written and can be used as an illustration of how the
comments in the IDD might be used by Interface Developers to guide their developments.
IDFEditor is described in the Getting Started document.
A full example of a very simple IDF is included in Appendix A to this document.
IDD Conventions
The following is a basic description of the structure of the IDD (its actually taken directly from
the IDD file). As noted within, ! signifies a comment character as does the \. \ has also been
adopted as a convention for including more specific comments about each field in an object.
These have been used with success in the IDFEditor and it is hoped the flexibility will provide
other interface developers with useful information. Not all fields are filled in as of yet in the
existing IDD that will come over time.
!IDD_Version VERSION
! **************************************************************************
!
! Object Description
! -----------------! To define an object (a record with data), develop a key word that is unique
! Each data item to the object can be A (Alphanumeric string) or N (numeric)
! Number each A and N. This will show how the data items will be put into the
! arrays that are passed to the Input Processor "Get" (GetObjectItem) routines.
! All alpha fields are limited to 100 characters. Numeric fields should be
! valid numerics (can include such as 1.0E+05) and are placed into double
! precision variables.
!
! NOTE: Even though a field may be optional, a comma representing that field
!
must be included (unless it is the last field in the object). Since the
!
entire input is "field-oriented" and not "keyword-oriented", the EnergyPlus
!
Input Processor must have some representation (even if blank) for each
!
field.
!
! Object Documentation
! -------------------! In addition, the following special comments appear one per line and
! most are followed by a value. Comments may apply to a field or the object
! or a group of objects.
!
! Field-level comments:
!
! \field
Name of field
!
(should be succinct and readable, blanks are encouraged)
!
! \note
Note describing the field and its valid values
!
! \required-field To flag fields which may not be left blank
!
(this comment has no "value")
!
! \units
Units (must be from EnergyPlus standard units list)
!
EnergyPlus units are standard SI units
4/20/10
Input Details
IDD Conventions
!
! \ip-units
IP-Units (for use by input processors with IP units)
!
This is only used if the default conversion is not
!
appropriate.
!
! \minimum
Minimum that includes the following value
!
! \minimum>
Minimum that must be > than the following value
!
! \maximum
Maximum that includes the following value
!
! \maximum<
Maximum that must be < than the following value
!
! \default
Default for the field (if N/A then omit entire line)
!
! \deprecated
This field is not really used and will be deleted from the
object.
!
The information is gotten internally within the program.
!
! \autosizable
Flag to indicate that this field can be used with the Auto
!
Sizing routines to produce calculated results for the
!
field. If a value follows this, then that will be used
!
when the "Autosize" feature is flagged. To trigger
!
autosizing for a field, enter Autosize as the field's
!
value. Only applicable to numeric fields.
!
! \autocalculatable Flag to indicate that this field can be automatically
!
calculated. To trigger auto calculation for a field, enter
!
Autocalculate as the field's value. Only applicable to
!
numeric fields.
!
! \type
Type of data for the field !
integer
!
real
!
alpha
(arbitrary string),
!
choice
(alpha with specific list of choices, see
!
\key)
!
object-list (link to a list of objects defined elsewhere,
!
see \object-list and \reference)
!
! \retaincase
Retains the alphabetic case for alpha type fields
!
! \key
Possible value for "\type choice" (blanks are significant)
!
use multiple \key lines to indicate all valid choices
!
! \object-list
Name of a list of user-provided object names that are valid
entries
!
for this field (used with "\reference")
!
see Zone and BuildingSurface:Detailed objects below for
!
examples.
!
** Note that a field may have only one \object-list reference.
!
** If it must reference more than one object-list, then a
!
composite object-list should be created which contains all
!
valid references.
!
! \reference
Name of a list of names to which this object belongs
!
used with "\type object-list" and with "\object-list"
!
see Zone and BuildingSurface:Detailed objects below for
!
examples:
!
!
Zone,
!
A1 , \field Name
!
\type alpha
4/20/10
Input Details
!
IDD Conventions
\reference ZoneNames
!
BuildingSurface:Detailed,
!
A4 , \field Zone Name
!
\note Zone the surface is a part of
!
\type object-list
!
\object-list ZoneNames
!
!
For each zone, the field "Name" may be referenced
!
by other objects, such as BuildingSurface:Detailed, so it is
!
commented with "\reference ZoneNames"
!
Fields that reference a zone name, such as
BuildingSurface:Detailed's
!
"Zone Name", are commented as
!
"\type object-list" and "\object-list ZoneNames"
!
** Note that a field may have multiple \reference commands.
!
** This is useful if the object belongs to a small specific
!
object-list as well as a larger more general object-list.
!
! Object-level comments:
!
! \memo
Memo describing the object
!
! \unique-object
To flag objects which should appear only once in an idf
!
(this comment has no "value")
!
! \required-object To flag objects which are required in every idf
!
(this comment has no "value")
!
! \min-fields
Minimum number of fields that should be included in the
!
object. If appropriate, the Input Processor will fill
!
any missing fields with defaults (for numeric fields).
!
It will also supply that number of fields to the "get"
!
routines using blanks for alpha fields (note -- blanks
!
may not be allowable for some alpha fields).
!
! \obsolete
This object has been replaced though is kept (and is read)
!
in the current version. Please refer to documentation as
!
to the dispersal of the object. If this object is
!
encountered in an IDF, the InputProcessor will post an
!
appropriate message to the error file.
!
usage: \obsolete New=>[New object name]
!
! \extensible:<#> This object is dynamically extensible -- meaning, if you
!
change the IDD appropriately (if the object has a simple list
!
structure -- just add items to the list arguments (i.e. BRANCH
!
LIST). These will be automatically redimensioned and used during
!
the simulation. <#> should be entered by the developer to signify
!
how many of the last fields are needed to be extended (and
EnergyPlus
!
will attempt to auto-extend the object).
!
! \format
The object should have a special format when saved in
!
the IDF Editor with the special format option enabled.
!
The options include SingleLine, Vertices, CompactSchedule,
!
FluidProperties, ViewFactors, and Spectral.
!
The SingleLine option puts all the fields for the object
!
on a single line. The Vertices option is used in objects
!
that use X, Y and Z fields to format those three fields
!
on a single line.
!
The CompactSchedule formats that specific object.
!
The FluidProperty option formats long lists of fluid
!
properties to ten values per line.
4/20/10
Input Details
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
!
4/20/10
IDD Conventions
The ViewFactor option formats three fields related to
view factors per line.
The Spectral option formats the four fields related to
window glass spectral data per line.
Group-level comments:
\group
Notes on comments
----------------1. If a particular comment is not applicable (such as units, or default)
then simply omit the comment rather than indicating N/A.
2. Memos and notes should be brief (recommend 5 lines or less per block).
More extensive explanations are expected to be in the user documentation
Default IP conversions (no \ip-units necessary)
m
=>
ft
W
=>
Btu/h
m3/s
=>
ft3/min
C
=>
F
kg/J
=>
lb/Btu
Pa
=>
psi
W/m-K
=>
Btu-in/h-ft2-F
W/K
=>
Btu/h-F
deltaC
=>
deltaF
m2
=>
ft2
K
=>
R
1/K
=>
1/R
(kg/s)/W
=>
(lbm/sec)/(Btu/hr)
J/kg
=>
Btu/lb
kg-H2O/kg-air
=>
lb-H2O/lb-air
kJ/kg
=>
Btu/lb
lux
=>
foot-candles
kg/m3
=>
lb/ft3
kg/s
=>
lb/s
kg/s-m
=>
lb/s-ft
m3
=>
ft3
m3
=>
gal
W/m2-K
=>
Btu/h-ft2-F
1/m
=>
1/ft
J/kg-K
=>
Btu/lb-F
J/m3-K
=>
Btu/ft3-F
m/s
=>
ft/min
m/s
=>
miles/hr
m2-K/W
=>
ft2-F-hr/Btu
W/m2
=>
Btu/h-ft2
A/K
=>
A/F
g/kg
=>
grains/lb
g/m-s
=>
lb/ft-s
g/m-s-K
=>
lb/ft-s-F
J/K
=>
Btu/F
J/kg-K2
=>
Btu/lb-F2
J/m3
=>
Btu/ft3
kg/kg-K
=>
lb/lb-F
kPa
=>
psi
kPa
=>
inHg
m2/s
=>
ft2/s
m3/kg
=>
ft3/lb
m3/m3
=>
ft3/ft3
3.281
3.412
2118.6438
1.8 (plus 32)
2325.83774250441
0.0001450377
6.93481276005548
1.8987
1.8
10.764961
1.8
0.555555556
0.646078115385742
0.00042956 (plus 7.6736)
1
0.429925
0.092902267
0.062428
2.2046
0.67194
35.319837041
264.172
0.176110194261872
0.304785126485827
0.000239005736137667
1.49237004739337E-05
196.86
2.2369
5.678263
0.316957210776545
0.555555555555556
7.00000
0.000671968949659
0.000373574867724868
0.000526917584820558
0.000132889924714692
2.68096514745308E-05
0.555555555555556
0.145038
0.29523
10.764961
16.018
1
10
Input Details
IDD Conventions
!
N-s/m2
=>
lbf-s/ft2
0.0208857913669065
!
V/K
=>
V/F
0.555555555555556
!
W/m-K2
=>
Btu/h-F2-ft
0.321418310071648
!
m3/s-m
=>
ft3/min-ft
645.89
!
J/m2-K
=>
Btu/ft2-F
4.89224766847393E-05
!
cycles/hr
=>
cycles/hr
1
!
kg/kg
=>
lb/lb
1
!
J/J
=>
Btu/Btu
1
!
g/GJ
=>
lb/MWh
0.00793664091373665
!
L/GJ
=>
gal/kWh
0.000951022349025202
!
m3/GJ
=>
ft3/MWh
127.13292
!
m3/s-m2
=>
ft3/min-ft2
196.85
!
m3/s-person
=>
ft3/min-person
2118.6438
!
W/m2-K2
=>
Btu/h-ft2-F2
0.097826
!
g/MJ
=>
lb/MWh
7.93664091373665
!
L/MJ
=>
gal/kWh
0.951022349025202
!
m3/MJ
=>
ft3/kWh
127.13292
!
W/W
=>
Btuh/Btuh
1
!
$/m2
=>
$/ft2
0.0928939733269818
!
$
=>
$
1
!
$/kW
=>
$/(kBtuh/h)
0.293083235638921
!
$/m3
=>
$/ft3
0.0283127014102352
!
years
=>
years
1
!
$/(W/K)
=>
$/(Btu/h-F)
0.52667614683731
!
$/(m3/s)
=>
$/(ft3/min)
0.000472000059660808
!
W/m
=>
Btu/h-ft
1.04072
!
K/m
=>
F/ft
0.54861322767449
!
W/s
=>
W/s
1
!
kmol
=>
kmol
1
!
J
=>
Wh
0.000277777777777778
!
GJ
=>
ton-hrs
78.9889415481832
!
kg/m2
=>
lb/ft2
0.204794053596664
!
kg
=>
lb
2.2046
!
percent/K
=>
percent/F
0.555555555555556
!
kg/s2
=>
lb/s2
2.2046
!
g/mol
=>
lb/mol
0.0022046
!
deltaJ/kg
=>
deltaBtu/lb
0.0004299
!
person/m2
=>
person/ft2
0.0928939733269818
!
m2/person
=>
ft2/person
10.764961
!
W/person
=>
Btu/h-person
3.412
!
m3/person
=>
ft3/person
35.319837041
!
m3/hr-person
=>
ft3/hr-person
35.319837041
!
m3/m2
=>
ft3/ft2
3.281
!
m3/hr-m2
=>
ft3/hr-ft2
3.281
!
m3/hr
=>
ft3/hr
35.319837041
!
s/m
=>
s/ft
0.304785126485827
!
! Other conversions supported (needs the \ip-units code)
!
!
m
=>
in
39.37
!
W
=>
W
1
!
m3/s
=>
gal/min
15852
!
Pa
=>
inHg
0.00029613
!
Pa
=>
inH2O
0.00401463
!
Pa
=>
ftH2O
0.00033455
!
W/person
=>
W/person
1
!
W/m2
=>
W/m2
1
!
W/m2
=>
W/ft2
0.0928939733269818
!
! Units fields that are not translated
!
deg
!
hr
!
A
4/20/10
11
Input Details
IDD Conventions
!
dimensionless
!
V
!
ohms
!
A/V
!
eV
!
percent
!
s
!
W/m2 or deg C
!
W/m2, W or deg C
!
minutes
! **************************************************************************
First, the object name is given. (Site:Location) This is followed by a comma in both the
definition (IDD) and in an input file (IDF). In fact, all fields except the terminating field of an
IDD class object and IDF object are followed by commas. The final field in an IDD class
object or in an IDF object is terminated by a semi-colon.
Next is an alpha field, the location name. As noted above, for input, spaces are significant in
this field. The main inputs for Location are numeric fields. These are numbered (as is the
alpha field) for convenience. The \ designations will show various information about the
objects as described above in the IDD conventions discussion. Of importance for reading
this document are the units and possible minimum and maximum values for a field. Defaults
are produced if applicable and if the field is blank in the IDF. For this example, that wont
work because there is no default AND the Location name is a required field.
The \minimum, \maximum and \default comments are automatically processed in the Inptu
Processor for numeric fields. Any infractions of the \minimum, \maximum fields will be
automatically detected and messages will appear in the standard error file. After all the input
is checked, infractions will cause program termination (before the bulk of the simulation is
completed). Defaults are also enforced if you leave the numeric field blank.
4/20/10
12
Input Details
IDD Conventions
\min-fields deserves some explanation. This has object level enforcement. When min-fields
is specified for an object, it has meaning to the InputProcessor telling the IP the number of
fields that must be returned to a GetInput routine regardless of how many fields may actually
appear in the IDF. So, min-fields is actually an automatic assistance in most instances.
Some objects need all the parameters listed by the definition; some do not. In the
descriptions that are contained in the Input Output Reference, we try to indicate which parts
are optional. Usually, these will be the last fields in the object input or definition.
Using the Input-Output Reference Document
To assist you in using the Input Output Reference document, it is grouped similarly to the IDD
file.
To determine the latest set of groups and objects, it will be useful for you to open the
IDFEditor (an intelligent editor that is installed with EnergyPlus) and write out the current
object list. The following figure shows the screen shot of the IDFEditor and the help menu to
select the objectlist. Select create objectlist.txt to create the object list it will be put into
the IDFEditor program folder.
Figure 2. Using IDFEditor to find the latest groups and objects for the Energy+.idd
The produced list will look something like:
Simulation Parameters
---------------------------
4/20/10
13
Input Details
Version
SimulationControl
Building
ShadowCalculation
SurfaceConvectionAlgorithm:Inside
SurfaceConvectionAlgorithm:Outside
HeatBalanceAlgorithm
ZoneCapacitanceMultiplier
Timestep
ConvergenceLimits
Simulation Parameters and Location Climate Weather File Access are groups.
Version, Building, etc are objects.
unit
angular degrees
Length
Area
Volume
Time
Frequency
Temperature
absolute temperature
temperature difference
speed
energy (or work)
power
mass
force
degree
meter
square meter
cubic meter
seconds
Hertz
Celsius
Kelvin
Kelvin
meters per second
Joules
Watts
kilograms
Newton
4/20/10
abbreviation
deg
m
m2
m3
s
Hz
C
K
delK
m/s
J
W
kg
N
14
Input Details
EnergyPlus Reports
mass flow
volume flow
pressure
pressure difference
specific enthalpy
density
heat flux
specific heat
conductivity
diffusivity
heat transfer coefficient
R-value
heating or cooling capacity
electric potential
electric current
illuminace
luminous flux
luminous intensity
luminance
vapor diffusivity
viscosity
porosity
thermal gradient coeff for moisture
capacity
isothermal moisture capacity
kg/s
m3/s
Pa
delPa
J/kg
kg/m3
W/m2
J/kg-K
W/m-K
m2/s
W/m2-K
m2-K/W
W
V
A
lx
lm
cd
cd/m2
-------
m3/kg
kg/m-s
m3/m3
kg/kg-K
EnergyPlus Reports
Several items are used to specify what will appear in the output file(s). The output is
described in the next section of this document. What appears here is a sample of outputs
more detailed and complete versions can be found in the Output Details and Examples
document. In addition to the individual reports, there are sets of predefined reports that can
appear. View the Input for Output section and the Tabular reports section in the Input Output
Reference document for more details.
4/20/10
15
Output
EnergyPlus Reports
Output
EnergyPlus produces several output files as shown in the section on Running EnergyPlus.
This section will discuss the data contained in the standard output file (eplusout.eso). It,
too, has a data dictionary but unlike the input files, the output data dictionary is contained
within the output file. Thus, the basic structure of the standard output file is:
Data Dictionary Information
End of Data Dictionary
Data
Data
End of Data
As with the IDF structure, there are rules associated with the interpretation of the standard
output data dictionary. These rules are summarized as follows:
The first item on each line is an integer which represents the report code. This report
code will be listed in the data section where it will also be the first item on each line,
identifying the data. Only 2 lines in the output file will not have an integer as the first item
(End of Data Dictionary and End of Data lines).
The second item on each line is also an integer. This integer corresponds to the number
of items left on the dictionary line. Each string consists of a variable name and units in
square brackets. Square brackets are required for all strings. If there are no units
associated with a particular variable, then there are no characters between the brackets.
Six standard items appear at the start of every EnergyPlus Standard Output File Data
Dictionary:
Program Version,EnergyPlus, 1.0, Beta 2, Build 017
1,5,Environment Title[],Latitude[degrees],Longitude[degrees],Time Zone[],Elevation[m]
2,6,Day of Simulation[],Month[],Day of Month[],DST Indicator[1=yes 0=no], Hour[], StartMinute[], EndMinute[], DayType
3,3,Cumulative Day of Simulation[],Month[],Day of Month[],DST Indicator[1=yes 0=no],DayType
4,2,Cumulative Days of Simulation[],Month[]
5,1,Cumulative Days of Simulation[]
This example illustrates the non-consecutive nature of the report codes. Internally,
EnergyPlus counts each variable that could be reported. This is the assigned report code.
However, the user may not request each possible variable for reporting. Note that, currently,
the requested reporting frequency is shown as a comment (!) line in the standard output file.
The data is produced when the actual simulation is performed (after the warmup days). Data
output is simpler in format than the data dictionary lines. From the dictionary above:
4/20/10
16
Output
EnergyPlus Reports
-7.00,1610.26
This output file can be easily turned into a form that is read into commonly used spreadsheet
programs where it can be further analyzed, graphed, etc.
Solar Shading Test
50
45
40
Temperature [C]
35
30
25
20
15
10
5
07
/2
1
01
07
:0
0:
/2
00
1
03
07
:0
0:
/2
00
1
05
07
:0
0:
/2
00
1
07
07
:0
0:
/2
00
1
09
07
:0
0:
/2
00
1
11
07
:0
0:
/2
00
1
13
07
:0
0:
/2
00
1
15
07
:0
0:
/2
00
1
17
07
:0
0:
/2
00
1
19
07
:0
0:
/2
00
1
21
07
:0
0:
/2
00
1
23
:0
0:
00
Time
4/20/10
17
Weather Data
EnergyPlus Reports
Weather Data
Weather data in EnergyPlus is a simple text-based format, similar to the input data and
output data files. The weather data format includes basic location information in the first eight
lines: location (name, state/province/region, country), data source, latitude, longitude, time
zone, elevation, peak heating and cooling design conditions, holidays, daylight saving period,
typical and extreme periods, two lines for comments, and period covered by the data. The
data are also comma-separated and contain much of the same data in the TMY2 weather
data set (NREL 1995). EnergyPlus does not require a full year or 8760 (or 8784) hours in its
weather files. In fact, EnergyPlus allows and reads subsets of years and even sub-hourly (5
minute, 15 minute) datathe weather format includes a minutes field. EnergyPlus comes
with a utility that reads standard weather service file types such as TMY2, IWEC and WYEC2
files, as examples, as well as being able to read a user defined custom format.
The data dictionary for EnergyPlus Weather Data is shown in the Auxiliary Programs
document please review that document for further information.
4/20/10
18
Running EnergyPlus
EnergyPlus Reports
Running EnergyPlus
EnergyPlus is written in language conforming to Fortran Standard 90/95. It runs as a 32 bit
console (non-Windows) application on Intel compatible computers (Windows NT, Windows
95/98). More explicit details on running EnergyPlus are available in a separate document
(Running EnergyPlus in Auxiliary Programs document). The following files are used to run
EnergyPlus:
EnergyPlus.exe (the executable file)
Energy+.ini (described below)
Energy+.idd (the input data dictionary file)
In.idf (the input file)
In.epw optional (weather data file)
The input data dictionary and input data file have been discussed in the previous sections of
this document.
For weather simulations, EnergyPlus accepts EnergyPlus weather files. Previous versions
accepted BLAST formatted weather files and now a BLASTWeatherConverter program is
provided. The actual file name is in.epw.
The Energy+.ini file is a standard Windows ini file and can be manipulated using the
Windows API calls though EnergyPlus uses standard Fortran to manipulate it. It is a very
simple ini file and is fully described in the Auxiliary Programs document. Energy+.ini and in.idf
file should be in the directory from which you are running EnergyPlus.exe.
For the advanced user, there is also the EPMacro program, described in the Auxiliary
Programs Document. You run it as a separate program before EnergyPlus (the batch file
included in the install and shown in the GettingStarted document contains the commands).
EnergyPlus creates the following files (plus more):
Table 2. EnergyPlus Output Files
FileName
4/20/10
Description
Audit.out
Echo of input
Eplusout.err
Error file
Eplusout.eso
Eplusout.eio
Eplusout.rdd
Eplusout.dxf
Eplusout.end
19
Running EnergyPlus
EnergyPlus Reports
The eplusout.err file may contain three levels of errors (Warning, Severe, Fatal) as well as
the possibility of just message lines. These errors may be duplicated in other files (such as
the standard output file).
Table 3. EnergyPlus Errors
Error Level
Action
Warning
Take note
Severe
Should Fix
Fatal
Extensive timing studies and fine-tuning of EnergyPlus is NOT complete. To give you an
idea of comparable run times, we present the following (does not include HVAC) with an early
version of EnergyPlus running on a 450MHZ machine. Remember, BLAST would be 1
calculation per hour, EnergyPlus (in this case) was 4 calculations per hour. Obviously, these
are quite out of date. However, a recent change in a developers test machine illustrates the
importance of maximum memory. A 5 zone full year run on a 1.8GHZ, 1GB machine was
running about 8 minutes with a new 2.1GHZ, 2GB machine the same file takes about 2
minutes.
Table 4. Timings Comparison (EnergyPlus vs. BLAST)
File
GeometryTest (5 Zones, 2 Design
Day, Full Weather Year)
SolarShadingTest (9 Zones, Full
Weather Year)
4/20/10
BLAST Per
Zone
EnergyPlus Per
Zone
13 sec
33 sec
7 sec
25 sec
20
Licensing
EnergyPlus Reports
Licensing
In order to make efficient distribution of your interface, you should consider licensing
EnergyPlus. First, you must license/register to use EnergyPlus. Since we are distributing
EnergyPlus via the World Wide Web, at no charge, it will be easy to get your hands on a copy
for testing out your interface. However, you may wish to understand more of the internals
and, to make a complete distribution package, will need to at least execute a distribution
license.
http://www.eere.energy.gov/buildings/energyplus/energyplus_licensing.html contains the
details on licensing EnergyPlus for commercial or non-commercial use.
4/20/10
21
EnergyPlus Reports
4/20/10
22
EnergyPlus Reports
Zonal Equipment:
Central Air Handling Equipment:
System Equipment Autosize:
Purchased Cooling:
Purchased Heating:
Purchased Chilled Water:
Purchased Hot Water:
Coils:
Pumps:
Boilers:
Chillers:
Towers:
NA
No
No
No
No
No
No
None
None
None
None
None
Results:
Standard Reports:
Timestep or Hourly Variables:
Time bins Report:
HTML Report:
Environmental Emissions:
Utility Tariffs:
Output:PreprocessorMessage,
No Preprocessor Used,
!- Preprocessor Name
Information,
!- Error Severity
Illustrative Message,
!- Message Line 1
No problems for processing; !- Message Line 2
Version,
3.0;
!- Version Identifier
Timestep,
4;
Building,
Simple One Zone (Wireframe DXF), !- Name
0.0000000E+00,
!- North Axis {deg}
Suburbs,
!- Terrain
.04,
!- Loads Convergence Tolerance Value
.004,
!- Temperature Convergence Tolerance Value {deltaC}
MinimalShadowing,
!- Solar Distribution
30;
!- Maximum Number of Warmup Days
HeatBalanceAlgorithm,
ConductionTransferFunction;
!- Algorithm
SurfaceConvectionAlgorithm:Inside,
Detailed;
!- Algorithm
SurfaceConvectionAlgorithm:Outside,
Detailed;
!- Algorithm
SimulationControl,
No,
No,
No,
Yes,
Yes;
!!!!!-
RunPeriod,
1,
1,
12,
31,
Tuesday,
Yes,
Yes,
No,
Yes,
Yes;
!!!!!!!!!!-
Begin Month
Begin Day of Month
End Month
End Day of Month
Day of Week for Start Day
Use Weather File Holidays and Special Days
Use Weather File Daylight Saving Period
Apply Weekend Holiday Rule
Use Weather File Rain Indicators
Use Weather File Snow Indicators
Site:Location,
4/20/10
23
EnergyPlus Reports
DENVER_STAPLETON_CO_USA_WMO_724690, !- Name
39.77,
!- Latitude {deg}
-104.87,
!- Longitude {deg}
-7.00,
!- Time Zone {hr}
1611.00;
!- Elevation {m}
!
!
!
!
!
!
!
!
1%
!!!!!!!!!!!!!!-
Material:NoMass,
R13LAYER,
Rough,
2.290965,
0.9000000,
0.7500000,
0.7500000;
!!!!!!-
Name
Roughness
Thermal Resistance {m2-K/W}
Thermal Absorptance
Solar Absorptance
Visible Absorptance
Material:NoMass,
R31LAYER,
Rough,
5.456,
0.9000000,
0.7500000,
0.7500000;
!!!!!!-
Name
Roughness
Thermal Resistance {m2-K/W}
Thermal Absorptance
Solar Absorptance
Visible Absorptance
Material,
C5 - 4 IN HW CONCRETE,
!- Name
4/20/10
24
EnergyPlus Reports
!!!!!!!!-
Roughness
Thickness {m}
Conductivity {W/m-K}
Density {kg/m3}
Specific Heat {J/kg-K}
Thermal Absorptance
Solar Absorptance
Visible Absorptance
Construction,
R13WALL,
R13LAYER;
!- Name
!- Outside Layer
Construction,
FLOOR,
C5 - 4 IN HW CONCRETE;
!- Name
!- Outside Layer
Construction,
ROOF31,
R31LAYER;
!- Name
!- Outside Layer
Site:GroundTemperature:BuildingSurface,
18.89,
!- January Ground Temperature {C}
18.92,
!- February Ground Temperature {C}
19.02,
!- March Ground Temperature {C}
19.12,
!- April Ground Temperature {C}
19.21,
!- May Ground Temperature {C}
19.23,
!- June Ground Temperature {C}
19.07,
!- July Ground Temperature {C}
19.32,
!- August Ground Temperature {C}
19.09,
!- September Ground Temperature {C}
19.21,
!- October Ground Temperature {C}
19.13,
!- November Ground Temperature {C}
18.96;
!- December Ground Temperature {C}
Zone,
ZONE ONE,
0.0000000E+00,
0.0000000E+00,
0.0000000E+00,
0.0000000E+00,
1,
1,
autocalculate,
autocalculate;
!!!!!!!!!-
ScheduleTypeLimits,
Fraction,
0.0 : 1.0,
CONTINUOUS;
!- Name
!- Range
!- Numeric Type
GlobalGeometryRules,
UpperLeftCorner,
CounterClockWise,
WorldCoordinateSystem;
Name
Direction of Relative North {deg}
X Origin {m}
Y Origin {m}
Z Origin {m}
Type
Multiplier
Ceiling Height {m}
Volume {m3}
BuildingSurface:Detailed,
Zn001:Wall001,
!- Name
Wall,
!- Surface Type
R13WALL,
!- Construction Name
ZONE ONE,
!- Zone Name
Outdoors,
!- Outside Boundary Condition
,
!- Outside Boundary Condition Object
SunExposed,
!- Sun Exposure
WindExposed,
!- Wind Exposure
0.5000000,
!- View Factor to Ground
4,
!- Number of Vertices
0.0000000E+00,0.0000000E+00,4.572000, !- X,Y,Z ==> Vertex 1
0.0000000E+00,0.0000000E+00,0.0000000E+00, !- X,Y,Z ==> Vertex 2
15.24000,0.0000000E+00,0.0000000E+00, !- X,Y,Z ==> Vertex 3
15.24000,0.0000000E+00,4.572000; !- X,Y,Z ==> Vertex 4
4/20/10
25
EnergyPlus Reports
BuildingSurface:Detailed,
Zn001:Wall002,
!- Name
Wall,
!- Surface Type
R13WALL,
!- Construction Name
ZONE ONE,
!- Zone Name
Outdoors,
!- Outside Boundary Condition
,
!- Outside Boundary Condition Object
SunExposed,
!- Sun Exposure
WindExposed,
!- Wind Exposure
0.5000000,
!- View Factor to Ground
4,
!- Number of Vertices
15.24000,0.0000000E+00,4.572000, !- X,Y,Z ==> Vertex 1
15.24000,0.0000000E+00,0.0000000E+00, !- X,Y,Z ==> Vertex 2
15.24000,15.24000,0.0000000E+00, !- X,Y,Z ==> Vertex 3
15.24000,15.24000,4.572000; !- X,Y,Z ==> Vertex 4
BuildingSurface:Detailed,
Zn001:Wall003,
!- Name
Wall,
!- Surface Type
R13WALL,
!- Construction Name
ZONE ONE,
!- Zone Name
Outdoors,
!- Outside Boundary Condition
,
!- Outside Boundary Condition Object
SunExposed,
!- Sun Exposure
WindExposed,
!- Wind Exposure
0.5000000,
!- View Factor to Ground
4,
!- Number of Vertices
15.24000,15.24000,4.572000, !- X,Y,Z ==> Vertex 1
15.24000,15.24000,0.0000000E+00, !- X,Y,Z ==> Vertex 2
0.0000000E+00,15.24000,0.0000000E+00, !- X,Y,Z ==> Vertex 3
0.0000000E+00,15.24000,4.572000; !- X,Y,Z ==> Vertex 4
BuildingSurface:Detailed,
Zn001:Wall004,
!- Name
Wall,
!- Surface Type
R13WALL,
!- Construction Name
ZONE ONE,
!- Zone Name
Outdoors,
!- Outside Boundary Condition
,
!- Outside Boundary Condition Object
SunExposed,
!- Sun Exposure
WindExposed,
!- Wind Exposure
0.5000000,
!- View Factor to Ground
4,
!- Number of Vertices
0.0000000E+00,15.24000,4.572000, !- X,Y,Z ==> Vertex 1
0.0000000E+00,15.24000,0.0000000E+00, !- X,Y,Z ==> Vertex 2
0.0000000E+00,0.0000000E+00,0.0000000E+00, !- X,Y,Z ==> Vertex 3
0.0000000E+00,0.0000000E+00,4.572000; !- X,Y,Z ==> Vertex 4
BuildingSurface:Detailed,
Zn001:Flr001,
Floor,
FLOOR,
ZONE ONE,
Surface,
Zn001:Flr001,
NoSun,
NoWind,
1.000000,
4,
15.24000,0.000000,0.0,
0.000000,0.000000,0.0,
0.000000,15.24000,0.0,
15.24000,15.24000,0.0;
BuildingSurface:Detailed,
Zn001:Roof001,
Roof,
ROOF31,
ZONE ONE,
Outdoors,
4/20/10
!- Name
!- Surface Type
!- Construction Name
!- Zone Name
!- Outside Boundary Condition
!- Outside Boundary Condition Object
!- Sun Exposure
!- Wind Exposure
!- View Factor to Ground
!- Number of Vertices
!- X,Y,Z ==> Vertex 1
!- X,Y,Z ==> Vertex 2
!- X,Y,Z ==> Vertex 3
!- X,Y,Z ==> Vertex 4
!!!!!-
Name
Surface Type
Construction Name
Zone Name
Outside Boundary Condition
26
EnergyPlus Reports
!- Outside Boundary Condition Object
!- Sun Exposure
!- Wind Exposure
!- View Factor to Ground
!- Number of Vertices
!- X,Y,Z ==> Vertex 1
!- X,Y,Z ==> Vertex 2
!- X,Y,Z ==> Vertex 3
!- X,Y,Z ==> Vertex 4
!- Key Value
!- Variable Name
!- Reporting Frequency
Output:Variable,
*,
!- Key Value
Daylight Saving Time Indicator, !- Variable Name
daily;
!- Reporting Frequency
Output:Variable,
*,
DayType Index,
daily;
!- Key Value
!- Variable Name
!- Reporting Frequency
Output:Variable,
*,
!- Key Value
Zone Mean Air Temperature, !- Variable Name
hourly;
!- Reporting Frequency
Output:Variable,
*,
!- Key Value
Zone Total Internal Latent Gain, !- Variable Name
hourly;
!- Reporting Frequency
Output:Variable,
*,
!- Key Value
Zone Mean Radiant Temperature, !- Variable Name
hourly;
!- Reporting Frequency
Output:Variable,
*,
!- Key Value
Zone Air Balance Surface Convection Rate, !- Variable Name
hourly;
!- Reporting Frequency
Output:Variable,
*,
!- Key Value
Zone Air Balance Air Energy Storage Rate, !- Variable Name
hourly;
!- Reporting Frequency
Output:Variable,
*,
!- Key Value
Surface Inside Temperature, !- Variable Name
daily;
!- Reporting Frequency
Output:Variable,
*,
!- Key Value
Surface Outside Temperature, !- Variable Name
daily;
!- Reporting Frequency
Output:Variable,
*,
!- Key Value
Surface Int Convection Coeff, !- Variable Name
daily;
!- Reporting Frequency
Output:Variable,
*,
!- Key Value
Surface Ext Convection Coeff, !- Variable Name
daily;
!- Reporting Frequency
Output:Reports,
4/20/10
27
EnergyPlus Reports
!- Type of Report
!- Report Name
Output:Reports,
surfaces,
dxf:wireframe;
!- Type of Report
!- Report Name
Output:Reports,
construction;
!- Type of Report
Output:Meter:MeterFileOnly,
ExteriorLights:Electricity, !- Name
hourly;
!- Reporting Frequency
Output:Meter:MeterFileOnly,
Carbon Equivalent:Facility, !- Name
hourly;
!- Reporting Frequency
Output:Meter:MeterFileOnly,
EnergyTransfer:Building, !- Name
hourly;
!- Reporting Frequency
Output:Meter:MeterFileOnly,
EnergyTransfer:Facility, !- Name
hourly;
!- Reporting Frequency
OutputControl:Table:Style,
HTML;
!- Column Separator
Output:Table:SummaryReports,
AllSummary;
!- Report 1 Name
Exterior:Lights,
ExtLights,
AlwaysOn,
5250,
AstronomicalClock,
Grounds Lights;
!!!!!-
ScheduleTypeLimits,
On/Off,
0:1,
DISCRETE;
!- Name
!- Range
!- Numeric Type
Schedule:Day:Hourly,
On,
On/Off,
1.,
1.,
1.,
1.,
1.,
1.,
1.,
1.,
1.,
1.,
1.,
1.,
1.,
1.,
1.,
1.,
1.,
1.,
1.,
1.,
1.,
1.,
1.,
1.;
!!!!!!!!!!!!!!!!!!!!!!!!!!-
4/20/10
Name
Schedule Name
Design Level {W}
Control Option
End-Use Subcategory
Name
Schedule Type Limits Name
Hour 1
Hour 2
Hour 3
Hour 4
Hour 5
Hour 6
Hour 7
Hour 8
Hour 9
Hour 10
Hour 11
Hour 12
Hour 13
Hour 14
Hour 15
Hour 16
Hour 17
Hour 18
Hour 19
Hour 20
Hour 21
Hour 22
Hour 23
Hour 24
28
EnergyPlus Reports
Schedule:Week:Daily,
On Weeks,
On,
On,
On,
On,
On,
On,
On,
On,
On,
On,
On,
On;
!!!!!!!!!!!!!-
Name
Sunday Schedule:Day Name
Monday Schedule:Day Name
Tuesday Schedule:Day Name
Wednesday Schedule:Day Name
Thursday Schedule:Day Name
Friday Schedule:Day Name
Saturday Schedule:Day Name
Holiday Schedule:Day Name
SummerDesignDay Schedule:Day Name
WinterDesignDay Schedule:Day Name
CustomDay1 Schedule:Day Name
CustomDay2 Schedule:Day Name
Schedule:Year,
AlwaysOn,
On/Off,
On Weeks,
1,
1,
12,
31;
!!!!!!!-
Name
Schedule Type Limits Name
Schedule:Week Name 1
Start Month 1
Start Day 1
End Month 1
End Day 1
4/20/10
29