EPResult class

class eprun.eprun.EPResult[source]

A class representing the results of an EnergyPlus simulation.

Note

An EPResult instance is returned as the result of the runsim function. It should not be instantiated directly.

Code Example

>>> from eprun import eprun
>>> epresult=eprun(ep_dir='C:\EnergyPlusV9-6-0',
>>>                input_filepath='1ZoneUncontrolled.idf',
>>>                epw_filepath='USA_CO_Golden-NREL.724666_TMY3.epw',
>>>                sim_dir='simulation_files')
>>> print(type(epresult))
<class 'eprun.epresult.EPResult'>
>>> print(epresult.returncode)
0

property files

A dictionary of the results files from a successful EnergyPlus simulation. The keys of the dictionary are the file extensions e.g. ‘eso’, ‘err’ etc. The values of the dictionary are the absolute filepaths of the files.

Return type: dict (str,str)

get_end()[source]

Gets the .end output file.

Return type: EPEnd

get_err()[source]

Gets the .err output file.

Return type: EPErr

get_eso()[source]

Gets the .eso output file.

Return type: EPEso

property returncode

The returncode of the subprocess.run call to the EnergyPlus exe file. This indicates if the call to EnergyPlus was successful. 0 means success. 1 means failure.

Return type: int

property stdout

The stdout of the subprocess.run call to the EnergyPlus exe file. This is the text that would appear in the CommandPromt if the command was run there.

Return type: str