EPEsoDailyVariable class

class eprun.eprun.EPEsoDailyVariable[source]

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

Note

An EPEsoDailyVariable instance is returned as the result of the get_daily_variable or get_daily_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')
>>> dv=env.get_daily_variables()[0]
>>> print(type(dv))
<class 'eprun.epeso_daily_variable.EPEsoDailyVariable'>
>>> print(dv.summary())
51 - ZN001:WALL001 - Surface Inside Face Temperature (C)
>>> print(dv.values[:5])
(0.2586823729828891, -2.1861342037263127, -3.1313024424355285, -2.9489865949136895, 0.3701320282261298)

get_dataframe()[source]

Returns a pandas dataframe of the interval 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_hours

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

Return type: tuple (int)

property max_minutes

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

Return type: tuple (int)

property max_values

The maximum values of the monthly variable.

Return type: tuple (float)

property min_hours

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

Return type: tuple (int)

property min_minutes

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

Return type: tuple (int)

property min_values

The minimum values of the daily variable.

Return type: tuple (float)

property object_name

The object name of the daily variable.

Return type: str

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

Plots the daily 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 daily 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 daily variable.

Return type: str

property values

The (mean) values of the daily variable.

Return type: tuple (float)