Table of Contents: Auxiliary Programs — EnergyPlus 8.4
Table of Contents
|
Object Index
All 8.4 Docs
|
Docs Home
EnergyPlusTM Documentation, v8.4.0
Auxiliary EnergyPlus Programs
Extra programs for EnergyPlus
Auxiliary Programs Introduction
Weather Converter Program
Background
Weather Format for Simulation Programs
Weather Data Availability
Using the Weather Converter
File Menu
Fix Out of Range Data
Select Delta DB Trigger
Delete File
Input Folder = > Output Folder
Exit
Converting Data
Select File to Convert
Definitions File
Override Default Type
Select Output Format
Save File As…
Convert File
Help
Definitions File & Custom File Processing
Description of Def input file
Expected Formats for &location
Fields: City, StateProv, Country
Fields: InLat, InLong
Field: InTime
Field: InElev
Field: InWMO
Expected Formats for &miscdata
Fields: Comments1, Comments2
Field: SourceData
Field: OutputURL
Expected Formats for &wthdata
Field: InputFileType
Field: NumInHour
Fields below only used in Custom format processing
Field: DataElements
Custom Files - Auxiliary Data
Wetbulb (Wet Bulb Temperature)
HumRatio (Humidity Ratio)
Dirhorrad (Direct Horizontal Radiation)
Interval
Hour_Of_Year
Time (or HH:MM)
Date
Field: DataUnits
Field: DataConversionFactors
Field: DataMissingValues
Field: InFormat
Field: DelimiterChar
Field: DecimalSymbolChar
Field: DateSeparator
Expected Formats for &datacontrol
Field: NumRecordsToSkip
Field: MaxNumRecordsToRead
Fields: MissingDataAction, MissingWindDirAction, MissingOpaqueSkyCoverAction
Fields: MissingWindDirValue, MissingOpaqueSkyCoverValue
Field: MaxWindSpeed
Field: MaxDirectSolar, MaxDiffuseSolar, MaxIlluminanceValue
Field: GenerateSolarRadiationWarnings, GenerateIlluminanceWarnings
Def File Examples
Custom File Processing
Custom File Processing - Solar Radiation Value Calculation
Reports/Files Produced by the Weather Converter
Audit / Log File
Statistical Report File
Design Day Calculations Output
[From ASHRAE Handbook of Fundamentals, 2009]:
Köppen Climate Classification
Tropical Moist Climates (A)
Dry Climates (B)
Moist Subtropical Mid-Latitude Climates (C)
Moist Continental Mid-latitude Climates (D)
Polar Climates (E)
Highlands Areas (H)
ASHRAE Climate Classification
EnergyPlus Weather File (EPW) Data Dictionary
Data Field Descriptions
Field: Year
Field: Month
Field: Day
Field: Hour
Field: Minute
Field: Data Source and Uncertainty Flags
Field: Dry Bulb Temperature
Field: Dew Point Temperature
Field: Relative Humidity
Field: Atmospheric Station Pressure
Field: Extraterrestrial Horizontal Radiation
Field: Extraterrestrial Direct Normal Radiation
Field: Horizontal Infrared Radiation Intensity
Field: Global Horizontal Radiation
Field: Direct Normal Radiation
Field: Diffuse Horizontal Radiation
Field: Global Horizontal Illuminance
Field: Direct Normal Illuminance
Field: Diffuse Horizontal Illuminance
Field: Zenith Luminance
Field: Wind Direction
Field: Wind Speed
Field: Total Sky Cover
Field: Opaque Sky Cover
Field: Visibility
Field: Ceiling Height
Field: Present Weather Observation
Field: Present Weather Codes
Field: Precipitable Water
Field: Aerosol Optical Depth
Field: Snow Depth
Field: Days Since Last Snowfall
Field: Albedo
Field: Liquid Precipitation Depth
Field: Liquid Precipitation Quantity
References
EPW CSV Format (In/Out)
Location Header/Data (CSV)
Design Conditions Header/Data (CSV)
Typical/Extreme Periods Header/Data (CSV)
Ground Temperatures Header/Data (CSV)
Holiday/Daylight Saving Header/Data (CSV)
Comment 1 Header/Data (CSV)
Comment 2 Header/Data (CSV)
Data Period Header/Data (CSV)
Data Records (CSV)
Missing Weather File Data
Source Weather Data Formats
Data Set vs. Data Format
SAMSON Data Set/Format
TMY2 Data Set/Format
Solar and Wind Energy Resource Assessment (SWERA) Format
WYEC2 Data Set/Format
Canadian Weather for Energy Calculations (CWEC)
International Weather for Energy Calculations (IWEC)
Typical Meteorological Year (TMY)
California Climate Zones 2 (CTZ2)
Solar and Wind Energy Resource Assessment (SWERA)
Spanish Weather for Energy Calculations (SWEC)
Italian Climatic data collection Gianni De Giorgio (IGDG)
Chinese Typical Year Weather (CTYW)
INETI Synthetic data for Portugal
ISHRAE India Weather Data Files (ISHRAE)
City University of Hong Kong (CUHK) Data Set
Chinese Standard Weather Data (CSWD)
Kuwait Weather Data from Kuwait Institute for Scientific Research (KISR)
Egyptian Weather for Energy Calculations (EWEC)
Israel weather data (MSI)
Representative Meteorological Year (RMY) Australia Climatic Data
Iranian Typical Meteorological Year (ITMY)
New Zealand National Institute of Water & Atmospheric Research Ltd (NIWA)
Chartered Institution of Building Services Engineers (CIBSE)
Meteonorm Data
Other Formats
Custom Format
Solar Data
Data Sources/Uncertainty
Advanced use - accessing weather conversion capabilities
Interface to the EPlusWth.dll
Files used by EPlusWth.dll
Abbreviations.csv
WBANLocations.csv
Cal Climate Zone Lat Long data.csv
ASHRAE_2009_Yearly_DesignConditions.csv
Public calls to EPlusWth.dll
SetupPWInternalDataPath
SetFixOutOfRangeData
SetDefaultChgLimit
ProcessWeather
References
Web Resources
Ground Heat Transfer in EnergyPlus
Caution
Introduction
Use of the Ground Temperatures with Slabs
Slab configuration Drawing
Running the Slab Program
Technical Details on Files for Ground Heat Transfer with Slabs
Slab Program Output Files
EnergyPlus idf Objects from Slab Program
Description of the Objects in the E+SlabGHT.IDD
Materials or GroundHeatTransfer:Slab:Materials Object
Field: NMAT: Number of Materials
Field: Albedo: Surface Albedo: NoSnow
Field: Albedo: Surface Albedo: Snow
Field EPSLW: Surface Emissivity: NoSnow
Field EPSLW: Surface Emissivity: Snow
Field: Z0 Surface Roughness: NoSnow
Field: Z0 Surface Roughness: Snow
Field: HIN: Indoor Hconv: Downward Flow
Field: HIN: Indoor Hconv: Upward Flow
MatlProps or GroundHeatTransfer:Slab:MatlProps Object
Field: RHO: Slab Material Density
Field: RHO: Soil Density
Field: CP: Slab CP
Field: CP: Soil CP
Field: TCON: Slab K
Field: TCON: Soil K
BoundConds or GroundHeatTransfer:Slab:BoundConds Object
Field: EVTR: Is surface evapotranspiration modeled
Field: FIXBC: is the lower boundary at a fixed temperature
Field: TDEEPin
Field: USPHflag: Is the ground surface h specified by the user?
Field: USERH: User specified ground surface heat transfer coeff
BldgProps or GroundHeatTransfer:Slab:BldgProps Object
Field: IYRS Number of years to iterate
Field: Shape Slab shape
Field: HBLDG: Building Height
Field: TIN1 - TIN12
Indoor Average temperature set point
Field: TINAmp: Daily Indoor sine wave variation amplitude
Field: ConvTol: Convergence Tolerance
Insulation or GroundHeatTransfer:Slab:Insulation Object
Field RINS: R value of under slab insulation
Field DINS: Width of strip of under slab insulation
Field RVINS: R value of vertical insulation
Field ZVINS: Depth of vertical insulation
Field IVINS: Flag: Is there vertical insulation?
EquivalentSlab or GroundHeatTransfer:Slab:EquivalentSlab Object
Field APRatio: The area to perimeter ratio for this slab
Field SLABDEPTH: Thickness of slab on grade
Field CLEARANCE: Distance from edge of slab to domain edge
Field ZCLEARANCE: Distance from bottom of slab to domain bottom
EquivSlab Object - Obsolete
Field APRatio: The area to perimeter ratio for this slab
Field: EquivSizing
EquivAutoGrid Object - Obsolete
Field SLABDEPTH: Thickness of slab on grade
Field CLEARANCE: Distance from edge of slab to domain edge
Additional Objects
Sample IDF File - Slab Program
Using Ground Temperatures with Basements
Running the Basement Program
Technical Details on Files for Ground Heat Transfer with Basements
Basement Program Output Files
The Basement idd
Description of the Objects in the BasementGHT.idd
SimParameters or GroundHeatTransfer:Basement:SimParameters Object
Field: F: Multiplier for the ADI solution:
Field: IYRS: Maximum number of yearly iterations:
MatlProps or GroundHeatTransfer:Basement:MatlProps Object
Field: NMAT: Number of materials in this domain
Field: Density for Foundation Wall
Field: Density for Floor Slab
Field: Density for Ceiling
Field: Density for Soil
Field: Density for Gravel
Field: Density for Wood
Field: Specific Heat for Foundation Wall
Field: Specific Heat for Floor Slab
Field: Specific Heat for Ceiling
Field: Specific Heat for Soil
Field: Specific Heat for Gravel
Field: Specific Heat for Wood
Field: Thermal Conductivity for Foundation Wall
Field: Thermal Conductivity for Floor Slab
Field: Thermal Conductivity for Ceiling
Field: Thermal Conductivity for Soil
Field: Thermal Conductivity for Gravel
Field: Thermal Conductivity for Wood
Insulation or GroundHeatTransfer:Basement:Insulation Object
Field: REXT: R Value of any exterior insulation
Field: INSFULL: Flag: Is the wall fully insulated?
SurfaceProps or GroundHeatTransfer:Basement:SurfaceProps Object
Field: ALBEDO: Surface albedo for No snow conditions
Field: ALBEDO: Surface albedo for snow conditions
Field: EPSLN: Surface emissivity No Snow
Field: EPSLN: Surface emissivity with Snow
Field: VEGHT: Surface roughness No snow conditions
Field: VEGHT: Surface roughness snow conditions
Field: PET: Flag, Potential evapotranspiration on?
BldgData or GroundHeatTransfer:Basement:BldgData Object
Field: DWALL: Wall thickness
Field: DSLAB: Floor Slab thickness
Field: DGRAVXY: Width of gravel pit beside basement wall
Field: DGRAVZN: Gravel depth extending above the floor slab
Field: DGRAVZP: Gravel depth below the floor slab
Interior or GroundHeatTransfer:Basement:Interior Object
Field: COND: Flag: Is the basement conditioned?
Field: HIN: Downward convection only heat transfer coefficient
Field: HIN: Upward convection only heat transfer coefficient
Field: HIN: Horizontal convection only heat transfer coefficient
Field: HIN: Downward combined (convection and radiation) heat transfer coefficient
Field: HIN: Upward combined (convection and radiation) heat transfer coefficient
Field: HIN: Horizontal combined (convection and radiation) heat transfer coefficient
ComBldg or GroundHeatTransfer:Basement:ComBldg Object
Field: January average temperature
Field: February average temperature
Field: March average temperature
Field: April average temperature
Field: May average temperature
Field: June average temperature
Field: July average temperature
Field: August average temperature
Field: September average temperature
Field: October average temperature
Field: November average temperature
Field: December average temperature
Field: Daily variation sine wave amplitude
EquivSlab or GroundHeatTransfer:Basement:EquivSlab Object
Field: APRatio: The area to perimeter ratio for this slab
Field: EquivSizing: Flag
EquivAutoGrid or GroundHeatTransfer:Basement:EquivAutoGrid Object
Field: CLEARANCE: Distance from outside of wall to edge of 3-D ground domain
Field: SlabDepth: Thickness of the floor slab
Field: BaseDepth: Depth of the basement wall below grade
Sample idf File - Basement
Additional Objects
Using the Interface Surface Temperature Results in EnergyPlus
Multiple Ground Temperatures
References
View Factor Calculation Program
Associated Files
Using the View Factor Interface program
Additional Information
Using Older Version Input Files - Transition
IDF Version Updater
Transition Console Program Details
IDF Version Converter / Transition File Lists
Converting imf files
EPDrawGUI
Main Tab
Option Tab
Input Macros
Introduction
Running the EP-Macro program
Incorporating External Files
Selectively Accepting or Skipping Lines of Input
Defining Blocks of Input
Arithmetic Operations
Macro Debugging and Listing Control
Listing Format
HVAC Diagram
Introduction
CoeffConv/CoeffCheck
CoeffConv
CoeffCheck
Running the CoeffConv or CoeffCheck programs
ExpandObjects
Introduction
HVAC Template Objects Processed
Ground Heat Transfer Objects Processed
Building Surface Objects Processed
CSVproc
convertESOMTR
CalcSoilSurfTemp Program
Running the Program
Program Inputs
Program Outputs
HVAC Performance Curve Fit Tool
Introduction
Inputs
Rated Data
Performance Data
Outputs
Error Message
Notes
References
Parametric Spreadsheets
Water-to-Water Heat Pump Parameter / Coefficient Generator (Cooling and Heating Mode)
Step 1: Catalog Data Input
Parameter Estimation Procedure
Step 2a: Generating First Set of Parameters (PE-Based Model)
Step 2b: Improving the Set of Parameters (PE-Based Model)
Step 3: Generating EnergyPlus Input Parameters
End Parameter Estimation Procedure
Curve Fit Model Procedure
Step 2: Generating the coefficients (Curve-Fit Model)
End Curve Fit Model Procedure
Water-to-Air Heat Pump Parameter / Coefficient Generator (Cooling)
Step 1: Catalog Data Input
Parameter Estimation Procedure
Step 2a: Generating First Set of Parameters (PE-Based Model)
Step 2b: Improving the Set of Parameters (PE-Based Model)
Step 3: Generating EnergyPlus Input Parameters
End Parameter Estimation Procedure
Curve Fit Model Procedure
Step 2: Generating the coefficients (Curve-Fit Model)
End Curve Fit Model Procedure
Water-to-Air Heat Pump Parameter / Coefficient Generator (Heating Mode)
Step 1: Catalog Data Input
Parameter Estimation Procedure
Step 2a: Generating First Set of Parameters (PE-Based Model)
Step 2b: Improving the Set of Parameters (PE-Based Model)
Step 3: Generating EnergyPlus Input Parameters
End Parameter Estimation Procedure
Curve Fit Model Procedure
Step 2: Generating the coefficients (Curve-Fit Model)
End Curve Fit Model Procedure
G-Function Spreadsheet
ParametricPreprocessor
AppGPostProcess - Appendix G PostProcessing program
BLASTTranslator
DOE2Translator
Running Console Applications
Modifying the batch file
Technical Details of Running EnergyPlus
EP-Launch Program
Start EP-Launch
Selecting Input and Weather Files
Running a Single Input File
Looking at the Results
Viewing the Drawing File without Running a Simulation
Editing the Input Files
File Menu
Edit Menu
View Menu
Command Window Options
Interface Options
Miscellaneous Options
Text Editor Options
Drawing Viewer Options
VRML Viewer Options
Spreadsheet Options
Diagramming Options
HTML Browser Options
ESO Viewer Options
PDF Viewer Options
File Association Options
Reset Options
Help Menu
Recently Used Files
Running Groups of Input Files
History of Simulations Performed
Utilities Tab
Caveats
When things go wrong
Bugs
EP-Launch Lite
EnergyPlus File Extensions
Input Files
IDD
idf
imf
ini
epw
Output Files
err
audit
eso
mtr
mtd
eio
rdd
mdd
dbg
dxf
sln
Postprocessing Program/Files
RunEPlus batch file
Running EnergyPlus by Hand
RunEPlus details
RunDirMulti Batch File
EnergyPlus Files
Input Files
Energy+.idd
in.idf
in.imf
Energy+.ini
in.epw
Output Files
eplusout.err
eplusout.audit
eplusout.eso
eplusout.mtr
eplusout.eio
eplusout.rdd
eplusout.dbg
eplusout.dxf
eplusout.sln
Postprocessing Program/Files
Creating Input Files
IDD Conventions
IDFEditor
Start IDF Editor
Creating or Selecting an Input Data File
Class List and Objects
Changing Values
Edit or Select Node Names Dialog
Working with Objects
File Menu
Edit Menu
View Menu
Help Menu
Caveats
Bugs
Manipulating Output Files
EP-Compare
Copyright © 2009-2026 Big Ladder Software LLC. All rights reserved. The Big Ladder name and logo are trademarks of Big Ladder Software LLC.