EPEsoMonthlyVariable class

class eprun.eprun.EPEsoMonthlyVariable[source]

A class for a monthly variable recorded in an EPEsoSimulationEnvironment instance.

Note

An EPEsoMonthlyVariable instance is returned as the result of the get_monthly_variable or get_monthly_variables methods. It should not be instantiated directly.

Code Example

>>> from eprun import EPEso
>>> eso=EPEso(r'simulation_files\eplusout.eso')
>>> env=eso.get_environment('RUN PERIOD 1')
>>> mv=env.get_monthly_variables()[0]
>>> print(type(mv))
<class 'eprun.epeso_monthly_variable.EPEsoMonthlyVariable'>
>>> print(mv.summary())
48 - TEST 352A - Other Equipment Total Heating Energy (J)
>>> print(mv.values[:5])
(942796800.0, 851558400.0, 942796800.0, 912384000.0, 942796800.0)

get_dataframe()[source]

Returns a pandas dataframe of the monthly variable.

Return type: pandas.DataFrame

get_max_times()[source]

Returns the times when the maximum values occur.

Return type: tuple (datetime.datetime)

get_min_times()[source]

Returns the times when the minumum values occur.

Return type: tuple (datetime.datetime)

property max_days

The day numbers for the maximum values of the monthly variable.

Return type: tuple (int)

property max_hours

The hour numbers for the maximum values of the monthly variable.

Return type: tuple (int)

property max_minutes

The minute numbers for the maximum values of the monthly variable.

Return type: tuple (int)

property max_values

The maximum values of the monthly variable.

Return type: tuple (float)

property min_days

The day numbers for the minimum values of the monthly variable.

Return type: tuple (int)

property min_hours

The hour numbers for the minimum values of the monthly variable.

Return type: tuple (int)

property min_minutes

The minute numbers for the minimum values of the monthly variable.

Return type: tuple (int)

property min_values

The minimum values of the monthly variable.

Return type: tuple (float)

property object_name

The object name of the monthly variable.

Return type: str

plot(ax=None, **kwargs)[source]

Plots the monthly variable on the supplied axes.

Parameters

ax (matplotlib.axes.Axes) – An Axes instance. Optional, if not supplied then automatically created.
kwargs – Keyword arguments to be supplied to the matplotlib plot call.

Returns

The Axes instance.

Return type

matplotlib.axes.Axes

property quantity

The quantity of the monthly variable.

Return type: str

property report_code

The report code of the daily variable.

Return type: str

summary()[source]

Returns a summary of the daily variable.

Return type: str

property unit

The unit of the monthly variable.

Return type: str

property values

The (mean) values of the monthly variable.

Return type: tuple (float)