Question-and-Answer Resource for the Building Energy Modeling Community
Get started with the Help page
Ask Your Question
3

Tracking EnergyPlus runtime progress

asked 2017-04-26 06:55:54 -0500

dhollman's avatar

updated 2017-08-05 20:03:27 -0500

I'm looking for ideas / methods for how to track EnergyPlus as it runs. i.e., as the run goes from 0 to 100% complete.

It isn't necessary to predict the actual run TIME, but I'd at least like to know where EnergyPlus in terms of the steps it goes through from 1 to n.

What I've looked into so far:

  1. command-line arguments -- to see if there was something that already did what I needed. I looked at the information on GitHub but that didn't seem to provide this.

  2. The Input Output Reference doesn't seem to have anything specific to this there either -- but it certainly seems possible that I could have missed something.

  3. A possibility is to process the EnergyPlus log file(s). In the Input Output Reference document in section Running EnergyPlus (p2168) it states:

EnergyPlus produces several messages as it is executing, as a guide to its progress. These message illustrate the sequence of execution as well as provides checkpoints should the simulation fail.

and goes on to show an example of running the 1ZoneUncontrolled example. But, what specific inputs were required to produce that output? And what file is that output from? The document doesn't specify.

Thank you

edit retag flag offensive close merge delete

Comments

@Aaron Boranian kindly meant to correct a mistake - but it really was the Input Output Reference dated 9/29/14 which I was citing, not the Guide for Interface Developers document. Perhaps it says that also?

dhollman's avatar dhollman  ( 2017-04-26 11:43:29 -0500 )edit

@dhollman I updated the question for that because I assumed you were referencing the latest EnergyPlus version 8.7 instead of a previous version. That section you referenced may have shifted from the I/O Reference to the Guide for Interface Developers over those version updates.

Aaron Boranian's avatar Aaron Boranian  ( 2017-04-26 12:09:46 -0500 )edit

1 Answer

Sort by ยป oldest newest most voted
5

answered 2017-04-26 13:12:40 -0500

NOTE: All following links are for EnergyPlus v8.7 documentation. From the comments in the original post, the question is related to a previous version

As long as the EnergyPlus engine can locate the five key input files on your machine, it is able to simulate. When you run EnergyPlus, it will open a console window to report the different steps throughout the simulation process i.e., initial heat balances, warmup phase, design days for HVAC sizing, and then the run period. These are the execution messages that you refer to in the Guide for Interface Developers document from your original post. The example messages shown there are for the 1ZoneUncontrolled.idf example file, which is shown in Appendix A of that same document.

An example of that console window is shown below for a different IDF file that I created.

image description

Console window showing EnergyPlus processes throughout the simulation

As you can see, these messages do not directly correlate with 0 - 100% completion.

Normally, this console window will close automatically once the simulation finishes successfully or terminates due to a severe error. There is an option from EP-Launch to pause the console window when specific simulation processes are finished so that you can view all the messages. To do this, within EP-Launch use the menu command *View / Options ... *, click on Command Window in the list on the left side, and then check the box next to Pause During Simulation (Unless Minimized). Refer to the screen shots below for these steps.

image description

View / Options ... menu command in EP-Launch

image description

Pause simulation in console when running EnergyPlus

According to this section of the Output Details and Examples document, there is a Log output file that contains these console messages. I can't find anywhere in the other documents that explains how to create this Log file, and can't find an example Log file in any of my EnergyPlus project folders. Maybe @MJWitte or @JasonGlazer can chime in about that.

There may be a brute force method to have these messages written to a separate output file of your choice by editing the EPL-RUN.bat batch file. This should be done with caution, as it will affect any simulations you begin from EP-Launch.

edit flag offensive delete link more

Comments

@Aaron Boranian I am actually using the latest EnergyPlus, but just have an older PDF copy locally.

dhollman's avatar dhollman  ( 2017-04-27 06:52:33 -0500 )edit

@Aaron Boranian Thank you for all the detailed information. This seems to confirm that there is no specific or official method of tracking the EnergyPlus simulation runtime progress. You also clarified that the "log" output I was referring to is actually just the stdout of the program, which is fine. There are plenty of methods for capturing that text stream on the fly and reading it. I think this will work out, because I do not need an exactly precise % completion, just a general sense of progress to make sure app feedback to the user is positive.

dhollman's avatar dhollman  ( 2017-04-27 06:54:45 -0500 )edit

@dhollman Great! I'm glad that you found the answer useful. Could you accept the answer by clicking on the check mark on the left near the top of the answer? That way other users know that you're satisfied. Thanks!

Aaron Boranian's avatar Aaron Boranian  ( 2017-04-27 14:31:23 -0500 )edit

Just for completeness, the .log file has not been saved as a standard output file for quite a while. Will remove it from the docs.

MJWitte's avatar MJWitte  ( 2017-05-02 10:01:03 -0500 )edit

@MJWitte thanks for confirming that the docs were not quite up to date. That seems to close the loop on Aaron's suggestion.

dhollman's avatar dhollman  ( 2017-05-02 10:05:14 -0500 )edit

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Careers

Question Tools

1 follower

Stats

Asked: 2017-04-26 06:55:54 -0500

Seen: 455 times

Last updated: Apr 26 '17