run_simulation
Validate building energy model by running EnergyPlus simulation. Review results for errors, unmet hours, and energy breakdown.
Instructions
Execute EnergyPlus on the loaded model — the authoritative runtime validation gate.
Fatal or severe errors mean the model did not simulate correctly. A clean exit does
not guarantee physically reasonable results. After this call, read the resource
idfkit://simulation/results for full QA diagnostics: unmet hours by zone,
end-use energy breakdown, classified warnings, and QA flags that drive the fix loop.
Preconditions: model loaded; weather file set via download_weather_file, or design_day=True. Side effects: writes outputs to output_directory; updates session simulation result. Next step: read idfkit://simulation/results to assess result quality.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| annual | No | Annual simulation. | |
| readvars | No | Run ReadVarsESO after the simulation to produce eplusout.csv (and eplusmtr.csv when meters are requested) alongside the .eso/.mtr files. | |
| design_day | No | Design-day only. | |
| weather_file | No | EPW path (default: last downloaded). | |
| energyplus_dir | No | EnergyPlus install dir. | |
| output_directory | No | Output dir. | |
| energyplus_version | No | Version filter "X.Y.Z". |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| errors | Yes | Error summary from a simulation run. | |
| success | Yes | ||
| energyplus | Yes | EnergyPlus installation metadata. | |
| runtime_seconds | Yes | ||
| output_directory | Yes | ||
| simulation_complete | Yes |