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

Is a .csv output file created when running EP in python plugin mode?

asked 2020-10-17 15:55:50 -0500

sajithwjay's avatar

I am running the python EnergyPlus plugin option to run PythonPluginCustomSchedule.idf example file provided in the energyplus 9.4 packages. Although Output: Variable object is populated in the idf there is no .csv file of the outputs created. Is there a way to enable that or is this option still not available?

I came across this concern when running energyplus in Eppy as well.

Kind regards,

edit retag flag offensive close merge delete



@sajithwjay are you running this example IDF in EP-Launch, or through the EnergyPlus command line or a similar batch file process?

Aaron Boranian's avatar Aaron Boranian  ( 2020-10-18 12:20:42 -0500 )edit

I am running through the Windows command prompt

sajithwjay's avatar sajithwjay  ( 2020-10-20 23:56:15 -0500 )edit

Hi, have you found solution? I am running Eppy but I have faced the same concern - how to get csv file :(

Mikk's avatar Mikk  ( 2022-05-26 10:17:58 -0500 )edit

2 Answers

Sort by ยป oldest newest most voted

answered 2020-10-21 09:33:19 -0500

If you are running any IDF by hand through the Windows command prompt, Mac terminal, etc. then you are using the EnergyPlus command line interface. In order to generate the .csv output file using this approach, you want to include the -r or --readvars option that will run the ReadVarsESO utility than converts the ESO output file and its contents of output variables and/or meters into CSV format. An example is shown below:

image description

If you were using EP-Launch to simulate an IDF, it always runs the ReadVarsESO utility by default.

As an alternative, you could add the OutputControl:Files object to the example file you're simulating. This is a new object that was added to EnergyPlus in v9.4 which allows you to apply "Yes/No" settings for what output files the simulation should generate. This object is not defined in the example file you're simulating, so all of these fields are set to their default of "No".

The first input field of this OutputControl:Files object for the CSV file specifically uses a new EnergyPlus feature in v9.4 that natively generates the CSV output file without using the ReadVarsESO utility. From source code testing in the Github pull request that I linked to, this approach reduces the time spent writint outputs to the CSV file for runs that generate a large number of output variables and/or meters compared to using ReadVarsESO.

edit flag offensive delete link more

answered 2021-10-21 20:27:34 -0500

halimgur's avatar

I found out that if I am using the new option "OutputControl:Files" to specify CSV files, I should not use the option "-r" in the command line when calling api.runtime.run_energyplus from my Python environment (spyder to be exact).

edit flag offensive delete link more

Your Answer

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

Add Answer

Training Workshops


Question Tools



Asked: 2020-10-17 15:55:50 -0500

Seen: 595 times

Last updated: Oct 21 '20