EPEsoMonthlyPeriods class

class eprun.eprun.EPEsoMonthlyPeriods[source]

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

Note

An EPEsoMonthlyPeriods instance is returned as the result of the get_monthly_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')
>>> mp=env.get_monthly_periods()
>>> print(type(mp))
<class 'eprun.epeso_monthly_periods.EPEsoMonthlyPeriods'>
>>> print(mp.get_start_times()[:5])
(datetime.datetime(2001, 1, 1, 0, 0, tzinfo=datetime.timezone.utc), 
 datetime.datetime(2001, 2, 1, 0, 0, tzinfo=datetime.timezone.utc), 
 datetime.datetime(2001, 3, 1, 0, 0, tzinfo=datetime.timezone.utc), 
 datetime.datetime(2001, 4, 1, 0, 0, tzinfo=datetime.timezone.utc), 
 datetime.datetime(2001, 5, 1, 0, 0, tzinfo=datetime.timezone.utc))
property cumulative_days_of_simulation

The ‘cumulative days of simulation’ for the monthly periods.

Return type

tuple (int)

get_end_times()[source]

Returns the end times for the monthly periods.

Return type

tuple (datetime.datetime)

get_periods()[source]

Returns the monthly periods as a list of Pandas periods.

Return type

list (pandas.Period)

get_start_times()[source]

Returns the start times for the monthly periods.

Return type

tuple (datetime.datetime)

property months

The months for the monthly periods.

Return type

tuple (int)

summary()[source]

Returns a summary of the monthly periods.

Return type

str