opyplus.StandardOutput

class opyplus.StandardOutput(buffer_or_path, start_year=None, print_function=<function StandardOutput.<lambda>>)

Class describing an EnergyPlus Standard Output (eso file).

Parameters

buffer_or_path: typing.StringIO or str

start_year: int or None

print_function: typing.Callable

Notes

Initially, standard_output will have tuple instants (using ‘year’, ‘month’, ‘day’, ‘hour’, ‘minute’ columns), depending on given frequency). It is possible to create a datetime index afterwards.

StandardOutput datetime index respects left convention: instant 00:00 covers following range: [00:00, 01:00[. !! this is not the same convention as in weather data chapter !!

Methods

create_datetime_index(self, start_year)	Create the datetime index for a given start_year.
get_data(self[, environment_title_or_num, …])	Get eso data as a pandas data frame.
get_environments(self)	Get eso output environments.
get_info(self)	Get eso info.
get_variables(self)	Get eso variables.
to_csv(self, dir_path[, sep, decimal])	Write eso data to csv files (one per (env, freq)).

create_datetime_index(self, start_year)

Create the datetime index for a given start_year.

Parameters

start_year: int

get_data(self, environment_title_or_num=-1, frequency=None)

Get eso data as a pandas data frame.

Parameters

environment_title_or_num: str or int

title or number of the simulated environment. If empty, last environment will be used.

frequency: {‘timestep’, ‘hourly’, ‘daily’, ‘monthly’, ‘annual’, ‘run_period’, None}

If None, will look for the smallest frequency of environment.

get_environments(self)

Get eso output environments.

Returns

typing.Dict[str, opyplus.standard_output.output_environment.OutputEnvironment]

get_info(self)

Get eso info.

Returns

str

get_variables(self)

Get eso variables.

Returns

typing.Dict[str, typing.List[opyplus.standard_output.output_variable.OutputVariable]]

to_csv(self, dir_path, sep=';', decimal=', ')

Write eso data to csv files (one per (env, freq)).

Parameters

dir_path: str

sep: str

csv separator (default “;”)

decimal: str

csv decimal (default “,”)