EPEsoIntervalPeriods class

class eprun.eprun.EPEsoIntervalPeriods[source]

A class for the interval time periods recorded in an EPEsoSimulationEnvironment instance.

Note

An EPEsoIntervalPeriods instance is returned as the result of the get_interval_periods method. 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')
>>> ip=env.get_interval_periods()
>>> print(type(ip))
<class 'eprun.epeso_interval_periods.EPEsoIntervalPeriods'>
>>> print(ip.get_start_times()[:5])
(datetime.datetime(2001, 1, 1, 0, 0, tzinfo=datetime.timezone.utc), 
 datetime.datetime(2001, 1, 1, 1, 0, tzinfo=datetime.timezone.utc), 
 datetime.datetime(2001, 1, 1, 2, 0, tzinfo=datetime.timezone.utc), 
 datetime.datetime(2001, 1, 1, 3, 0, tzinfo=datetime.timezone.utc), 
 datetime.datetime(2001, 1, 1, 4, 0, tzinfo=datetime.timezone.utc))

property day_types

The day types for the interval periods.

Return type: tuple (str)

property days_of_month

The days in the month for the interval periods.

Return type: tuple (int)

property days_of_simulation

The ‘day of simulation’ values for the interval periods.

Return type: tuple (int)

property dst_indicators

The daylight saving time indicators for the interval periods.

Return type: tuple (int)

property end_minutes

The end minutes for the interval periods.

Return type: tuple (int)

get_end_times()[source]

Returns the end times for the interval periods.

Return type: tuple (datetime.datetime)

get_interval()[source]

Returns the time interval between periods.

Return type: datetime.timedelta

get_periods()[source]

Returns the interval periods as a list of Pandas periods.

Return type: list (pandas.Period)

get_start_times()[source]

Returns the start times for the interval periods.

Return type: tuple (datetime.datetime)

property hours

The hours for the interval periods.

Return type: tuple (int)

property months

The months for the interval periods.

Return type: tuple (int)

property start_minutes

The start minutes for the interval periods.

Return type: tuple (int)

summary()[source]

Returns a summary of the interval periods.

Return type: str