Skip to content
idfkit-docs - 25.1.0
Engineering Reference
Search
GitHub
Engineering Reference
External Interfaces
Getting Started
Input Output Reference
Interface Developer
Module Developer
Output Details
Plant Application Guide
Compliance
idfkit-docs - 25.1.0
GitHub
Engineering Reference
Engineering Reference
Overview
Overview
Document Overview
General Modeling Overview
Simulation Manager
Warmup Convergence
Integrated Solution Manager
Integrated Solution Manager
Basis for the Zone and Air System Integration
Summary of Predictor-Corrector Procedure
Air System Control
Moisture Predictor-Corrector
Carbon Dioxide Predictor-Corrector
Generic Contaminant Predictor-Corrector
Zone Air Mass Flow Conservation
Summary of Time Marching Solution
Surface Heat Balance Manager / Processes
Surface Heat Balance Manager / Processes
Conduction Through The Walls
Conduction Finite Difference Solution Algorithm
Combined Heat and Moisture Transfer (HAMT) Model
Effective Moisture Penetration Depth (EMPD) Model
Outside Surface Heat Balance
Inside Heat Balance
Adiabatic Boundary Conditions
Infrared Radiation Transfer Material
Transparent Insulation Material (TIM)
Surface Heat Balances With Moveable Insulation
Ground Heat Transfer Calculations using Foundation:Kiva
Ground Heat Transfer Calculations using C and F Factor Constructions
Approach
Approach
Undisturbed Ground Temperature Model: Finite Difference
Undisturbed Ground Temperature Model: Kusuda-Achenbach
Undisturbed Ground Temperature Model: Xing
Advanced Surface Concepts
Advanced Surface Concepts
Exterior Naturally Vented~ Cavity
Green Roof Model (EcoRoof)
Underwater Surface Boundary Condition
Climate, Sky and Solar/Shading Calculations
Climate, Sky and Solar/Shading Calculations
Climate Calculations
Design Week Specification
Sky Radiance Model
Shading Module
Solar Radiation Reflected from Exterior Surfaces
Solar Radiation Reflected from Exterior Surfaces
Diffuse Reflection of Beam Solar and Sky Solar Radiation
Daylighting and Window Calculations
Daylighting and Window Calculations
Daylighting Calculations
Daylight Factor Calculation
Time-Step Daylighting Calculation
DElight Daylighting Calculations
Complex Fenestration Daylighting Calculations
Daylighting Devices
Window Calculation Module
Window Heat Balance Calculation
Air Heat Balance Manager / Processes
Air Heat Balance Manager / Processes
Convection from Surfaces
Convection from Internal Sources
Infiltration/Ventilation
Air Exchange
Calculation of Zone Air Temperature
Building System Simulation System Manager / Processes
Building System Simulation System Manager / Processes
Air Loops
Air Loop Simulation
Primary Air System Simulation
Outdoor Air System
Outdoor Air Mixer
Zone Equipment Simulation
Air Path Components
Plant Load Profile
Plant/Condenser Loops
Steam Systems and Component Models
Loop, Equipment Sizing and other Design Data
Loop, Equipment Sizing and other Design Data
Sizing Manager
HVAC Sizing Simulation Manager
Zone Design Loads and Air Flow Rates
System Design Loads and Air Flow Rates
Plant and Condenser Loop Sizing
Coincident Plant Sizing using HVAC Sizing Simulation
Component Sizing
Zone Outdoor Air Design Data
Operational Faults
Demand Limiting
Alternative Modeling Processes
Alternative Modeling Processes
AirflowNetwork Model
RoomAir Models
Hybrid Model
Simulation Models -- Encyclopedic Reference
Simulation Models -- Encyclopedic Reference
Air System Distribution Terminals
Boilers
Chillers
Simulation Models - Encyclopedic Reference
Simulation Models - Encyclopedic Reference
Ice Thermal Storage
Coils
HVAC Controllers
Baseboard Heaters
Electric Baseboard Heater with Radiation and Convection
Simulation Models -- Encyclopedic Reference
Simulation Models -- Encyclopedic Reference
Cooling Towers and Evaporative Fluid Coolers
Demand Controlled Ventilation
Evaporative Coolers
Air System Fans
Air System Compound Component Groups
Variable Refrigerant Flow Heat Pumps
Heat Exchangers
Air System Humidifiers
Simulation Models -- Encyclopedic Reference
Simulation Models -- Encyclopedic Reference
Zone Internal Gains
Indoor Living Wall
Indoor Swimming Pool
Pipes
Pumps
Ideal Loads Air System
District Cooling
District Heating
CentralHeatPumpSystem
ChillerHeaterPerformance:Electric:EIR
Plant Temperature Source Component
Simulation Models -- Encyclopedic Reference
Simulation Models -- Encyclopedic Reference
Radiant System Models
Refrigeration Equipment
Setpoint Managers
Solar Collectors
System Availability Managers
Simulation Models -- Encyclopedic Reference
Simulation Models -- Encyclopedic Reference
Occupant Thermal Comfort
Trombe Walls
Water Thermal Tanks (includes Water Heaters)
Water Systems
Zone Controls
Zone Equipment and Zone Forced Air Units
On-Site Generation, Power Conversion, and Storage
On-Site Generation, Power Conversion, and Storage
Whole-Facility Electric Service
Electric Load Center Distribution Manager
Photovoltaic Arrays
Generators
Performance Curves and Lookup Tables
Performance Curves and Lookup Tables
Performance Curves
Lookup Tables
Economics Calculations
Economics Calculations
Component Costs
Tariff Computation
Life-Cycle Cost Computations
Special Modules/Reporting
Special Modules/Reporting
Environmental Impacts
Component Loads Summary
Output:Table:Annual
Heat Emissions
Resilience Metrics
External Interfaces
External Interfaces
External Interfaces Application Guide
External Interface(s)
External Interface(s)
Introduction
Coupling EnergyPlus with the Building Controls Virtual Test Bed
BCVTB Examples
Coupling EnergyPlus with Functional Mock-up Units for co-simulation
FMU Examples
Exporting~ EnergyPlus as a Functional Mock-up Unit for co-simulation
References
Getting Started
Getting Started
EnergyPlus Overview
EnergyPlus Overview
What is EnergyPlus?
Why does EnergyPlus exist and what were its original goals?
EnergyPlus Documentation Library
Getting Started with EnergyPlus
Running EnergyPlus
Running EnergyPlus
Introduction
EP-Launch Program
EnergyPlus File Extensions
Tutorial Example for running EnergyPlus
Tutorial Example for running EnergyPlus
Running EnergyPlus, Building Envelope, Internal Loads, Reports
Instructions
Overall scheme/methodology for running EnergyPlus
Overall scheme/methodology for running EnergyPlus
Building Simulation
A Methodology for Using Energyplus
Tutorial Exercise 2
Tutorial Exercise 2
Unitary System and VAV using HVACTemplate Inputs
Instructions
IDF Editor -- Brief Introduction
Other Useful programs/information
Other Useful programs/information
HVACTemplate Objects
Data Sets
Slab and Basement Programs
Coefficient Curve Generation
Useful Programs
WeatherData
Results Processing
HVAC-Diagram
CSVProc
convertESOMTR
DataFiles
Library Files
Energy Meters
Energy Meters
Standard Energy Meters
Custom Meters
Standard EnergyPlus Units
Input Output Reference
Input Output Reference
Input-Output Reference
Input-Output Reference
What's different about EnergyPlus Input and Output?
IDD Conventions
Input -- Output Descriptions (Document)
Using EnergyPlus as a Library
Group -- Simulation Parameters
Group -- Compliance Objects
Group -- Location -- Climate -- Weather File Access
Group -- Schedules
Group -- Surface Construction Elements
Group -- Thermal Zone Description/Geometry
Group -- Advanced Surface Concepts
Group -- Detailed Ground Heat Transfer
Group -- Room Air Models
Specifying Applicable Zone(s) or Space(s)
Group -- Daylighting
Group -- Exterior Energy Use Equipment
Group -- Airflow
Group -- Design Objects
HVAC: Primary and Secondary Systems
Group -- Node-Branch Management
Group -- Plant-Condenser Loops
Group -- Plant-Condenser Control
Group -- Plant Equipment
Group -- Water Heaters and Thermal Storage
Group -- Condenser Equipment
Group -- Air Distribution
Group -- Airflow Network
Group - Zone Equipment
Group -- Zone HVAC Air Loop Terminal Units
Group -- Zone Forced Air Units
Group -- Unitary Equipment
Group -- Variable Refrigerant Flow Equipment
Group -- Radiative textbf/
Group -- Refrigeration
Group - Zone Controls - Thermostats and Humidistats
Group -- Air Path
Group -- Non-Zone Equipment
Group Solar Collectors
Group Pumps
Plant-Condenser Flow Control
Group Heating and Cooling Coils
Coil:Cooling:DX
Group -- Fans
Group -- Humidifiers and Dehumidifiers
Group -- Energy Management System (EMS)
Group -- Python Plugins / Python EMS
Group ExternalInterface
Group User Defined HVAC and Plant Component Models
Group System Availability Managers
Group Setpoint Managers
Group Controllers
Group Evaporative Coolers
Group Heat Recovery
Group Demand Limiting Controls
Group -- Electric Load Center-Generator Specifications
Group Water Systems
Group - Operational Faults
Group - Performance Curves
Group Performance Tables
Group Fluid Properties
Group -- Hybrid Model
HVAC Template Objects
HVAC Template Objects
HVACTemplate Processing
Group -- HVAC Templates
EnergyPlus Economics
EnergyPlus Economics
Group -- Economics
Introduction to Economics
Conceptual Framework -- Variables and Hierarchy
UtilityCost:Tariff
UtilityCost:Qualify
UtilityCost:Charge:Simple
UtilityCost:Charge:Block
UtilityCost:Ratchet
UtilityCost:Variable
UtilityCost:Computation
UtilityCost:Tariff Examples
UtilityCost:Tariff Reporting
Economic Results Summary Report
Complex Tariff Modeling
Cost Estimating
Life-Cycle Costing
LifeCycleCost:Parameters
LifeCycleCost:RecurringCosts
LifeCycleCost:NonrecurringCost
LifeCycleCost:UsePriceEscalation
LifeCycleCost:UseAdjustment
CurrencyType
Parametric Objects
Input for Output
Output
Output
Using ReadVarsESO
Standard Output Reports
Standard Output Reports
Output:Table:TimeBins
Output:Table:Monthly
Output:Table:Annual
Output:Table:ReportPeriod
Output:Table:SummaryReports
OutputControl:Table:Style
Weather Data
Weather Data
Missing Weather File Data
Weather Data Hourly Interpolation
Weather File Data Reporting (errors) during Simulation
Running EnergyPlus
Running EnergyPlus
Energy+.ini
Errors
EnergyPlus Execution Time
Appendix A. Units and Abbreviations
Appendix A. Units and Abbreviations
Standard EnergyPlus Conditions
Standard EnergyPlus Units
Interface Developer
Interface Developer
Guide For Interface Developers
Introduction
Introduction
Interface Expectations
EnergyPlus Install Contents
Input Overview
Input Overview
General Input Rules
Input Data Dictionary
Input Data File
Input Details
Input Details
IDD Conventions
Standard EnergyPlus Units
EnergyPlus Reports
Output
Weather Data
Running EnergyPlus
Licensing
Appendix A.~ Simple IDF file
Module Developer
Module Developer
Guide For Module Developers
Introduction
Modules in EnergyPlus
Modules in EnergyPlus
What is a module anyway?
What is a module developer?
Adding new features
Input Concepts
Input Concepts
Input Data Dictionary
Data Dictionary Naming Conventions
Input Data File
Input Considerations
Advanced Input Considerations
DataSets
Module Structure
Module Structure
Module Outline
Module Example
Changing existing code
Considerations for Legacy Codes
Code Readability vs.~Speed of Execution
How it fits together
EnergyPlus Calling Structure
EnergyPlus Calling Structure
Top Level Calling Tree
High Level HVAC Calling Tree (schematic -- not all routines are shown)
Air System Calling Tree (schematic -- not all routines are shown)
Plant Calling Tree (schematic -- not all routines are shown)
Zone Equipment Calling Tree (schematic -- not all routines are shown)
Inserting the New Module into the Program
HVAC Network
HVAC Network
Branches, Connectors, and Nodes
Nodes in the simulation
Getting Nodes
Data Flow in an HVAC Component Module
Interfacing with Plant
Node Mass Flow Variables
EnergyPlus Services
EnergyPlus Services
Utility Routines/Functions
Input Services
Object Services
Branch & Node Checking and Services
Schedule Services
Data Services
Other Useful Utilities
Error Messages
Display Strings
Performance Curve Services
Fluid Property Services
Weather Services
Global Data: Flags and Parameters
Psychrometric services
Tabular Output Utilities
Internal Zone Gains Services
Output
Output
How Do I Output My Variables?
Output Variable Dos and Don'ts
Energy Management System
Energy Management System
EMS Actuator Interface
Running/Testing EnergyPlus -- for Developers
Running/Testing EnergyPlus -- for Developers
Environment Variables to Assist Running
Air Loop Simulation Environment Variables
Quick Procedure Outline For Making Code Changes to EnergyPlus
Important Rules for Module Developers
Appendix A.~ DataGlobals and DataEnvironments Modules
Appendix A.~ DataGlobals and DataEnvironments Modules
DataGlobals
DataEnvironment
Appendix B.~ Submissions and Check-ins
Appendix C.~ Documentation Specifics
Appendix D.~ Module, Subroutine, Function Templates
Appendix E.~ Test File Documentation
Appendix F. New or Changed Proposal Feature Template
Appendix G.
Output Details
Output Details
Output Details And Examples
Introduction
Output Files
Output Files
Output File List
eplusout.audit
eplusout.bnd
eplusout.dbg
eplusout.dxf
eplusout.edd
eplusout.eio
eplusout.end
eplusout.epmidf
eplusout.epmdet
eplusout.err
eplusout.eso
eplusout.mtd
eplusout.mtr
eplusout_perflog.csv
eplusout.rdd
eplusout.mdd
eplusout.shd
eplusout.sln
eplusout.sql
eplusssz.textless
epluszsz.textless
eplusout.textless
eplusmtr.textless
eplusmap.textless
eplusout.dfs
eplusscreen.csv
eplustbl.textless
readvars.rvaudit
eplusout.svg
eplusout.sci
eplusout.wrl
Delight output files
Example Input Files
Data Sets
Data Sets
Simple List Data Sets
Macro Data Sets
Plant Application Guide
Plant Application Guide
Introduction
Introduction
Organization
Scope
EnergyPlus Nomenclature
Generating an EnergyPlus Line Diagram
Generating an EnergyPlus Line Diagram
Example for EnergyPlus Line Diagram Generation
Inputting the system into the IDF file
Example System 1: Chiller and Condenser Loops
Example System 1: Chiller and Condenser Loops
Chilled water (CW) loop
Condenser Loop
Example System 2: Thermal Energy Storage
Example System 2: Thermal Energy Storage
Primary Cooling Loop (emphCoolSysPrimary
Condenser Loop (emphCondenser Loop
Heating Loop (emphHeatSys1
Example System 3: Primary/Secondary Pumping
Example System 3: Primary/Secondary Pumping
Primary Chilled Water Loop -- Chiller(s) and purchased cooling
Secondary Chilled Water Loop -- Plate Heat Exchanger
Primary/Secondary Pumping
Condenser Loop - Cooling Tower
References
Compliance
Compliance
Using Energyplus For Compliance
Introduction
Introduction
Background
Compliance Objects
Tabular Summary Reports
Features Related to Appendix G and LEED
Features Related to California Title 24 Compliance
EnergyPlus 25.1.0 Documentation
Engineering Reference
Engineering Reference
¶
Engineering Reference
Back to top