EPEso class

class eprun.eprun.EPEso(fp)[source]

A class for an EnergyPlus .eso file.

Parameters: fp (str) – The filepath for the .eso file.

Code Example

>>> from eprun import EPEso
>>> eso=EPEso(r'simulation_files\eplusout.eso')
>>> print(type(eso))
<class 'eprun.epeso.EPEso'>
>>> print(eso.programme_version_statement)
{'programme': 'EnergyPlus', 
 'version': 'Version 9.4.0-998c4b761e', 
 'timestamp': 'YMD=2020.12.31 08:53'}
>>> print(eso.standard_items_dictionary[1])
{'comment': None,
 'items': [{'name': 'Environment Title', 'unit': None},
           {'name': 'Latitude', 'unit': 'deg'},
           {'name': 'Longitude', 'unit': 'deg'},
           {'name': 'Time Zone', 'unit': None},
           {'name': 'Elevation', 'unit': 'm'}],
 'number_of_values': 5}
>>> print(eso.variable_dictionary[7])
{'comment': 'Hourly',
 'number_of_values': 1,
 'object_name': 'Environment',
 'quantity': 'Site Outdoor Air Drybulb Temperature',
 'unit': 'C'}
>>> print(eso.get_environments())
[EPEsoSimuationEnvironment("DENVER CENTENNIAL  GOLDEN   N ANN HTG 99% CONDNS DB"),
 EPEsoSimuationEnvironment("DENVER CENTENNIAL  GOLDEN   N ANN CLG 1% CONDNS DB=>MWB"),
 EPEsoSimuationEnvironment("RUN PERIOD 1")]

See also

Output Details and Examples, page 126. https://energyplus.net/quickstart

get_environment(environment_title)[source]

Returns a simulation environment in the .eso file.

Parameters: environment_title (str) – The name of the simulation environment.
Raises: IndexError – If environment_title does not match any of the simulation environments.
Return type: EPEsoSimulationEnvironment

get_environments()[source]

Returns a list of the simulation environments in the .eso file.

Returns: A list of EPEsoSimulationEnvironment instances.
Return type: list (EPEsoSimulationEnvironment)

property programme_version_statement

A dictionary of the programme version statement.

Returns: A dictionary with keys ‘programme’, ‘version’ and ‘timestamp’.
Return type: dict (str, str)

property standard_items_dictionary

A dictionary of the standard items in the data dictionary.

Returns: A dictionary with the keys based on the report codes and the values given by a dictionary with keys ‘number_of_values’, ‘items’ and ‘comment’.
Return type: dict (int,dict)

property variable_dictionary

A dictionary of the variables in the data dictionary.

Returns: A dictionary with the keys based on the report codes and the values given by a dictionary with keys ‘number_of_values’, ‘object_name’, ‘quantity’, ‘unit’ and ‘comment’.
Return type: dict (int,dict)