EPEsoIntervalVariable class

class eprun.eprun.EPEsoIntervalVariable[source]

A class for an interval variable recorded in an EPEsoSimulationEnvironment instance.

Note

An EPEsoIntervalVariable instance is returned as the result of the get_interval_variable or get_interval_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')
>>> iv=env.get_interval_variables()[0]
>>> print(type(iv))
<class 'eprun.epeso_interval_variable.EPEsoIntervalVariable'>
>>> print(iv.summary())
7 - Environment - Site Outdoor Air Drybulb Temperature (C)
>>> print(iv.values[:5])
(-4.5, -3.0, -3.625, -2.75, -2.0)

get_dataframe()[source]

Returns a pandas dataframe of the interval variable.

Return type: pandas.DataFrame

get_series()[source]

Returns a pandas series of the interval variable

Return type: pandas.Series

property object_name

The object name of the interval variable.

Return type: str

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

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

Return type: str

property report_code

The report code of the interval variable.

Return type: str

summary()[source]

Returns a summary of the interval variable.

Return type: str

property unit

The unit of the interval variable.

Return type: str

property values

The (mean) values of the interval variable.

Return type: tuple (float)