EPEsoSimulationEnviroment class

class eprun.eprun.EPEsoSimulationEnvironment[source]

A class representing the results from a simulation environment section of an EPEso instance.

Note

An EPEsoSimulationEnvironment instance is returned as the result of the get_environment or get_environments methods. It should not be instantiated directly.

Code Example

>>> from eprun import EPEso
>>> eso=EPEso(fp=r'files\eplusout.eso')
>>> envs=eso.get_environments()
[EPEsoSimuationEnvironment(environment_title="DENVER CENTENNIAL  GOLDEN   N ANN HTG 99% CONDNS DB"),
 EPEsoSimuationEnvironment(environment_title="DENVER CENTENNIAL  GOLDEN   N ANN CLG 1% CONDNS DB=>MWB"),
 EPEsoSimuationEnvironment(environment_title="RUN PERIOD 1")]
>>> print(envs[0].environment_title)
DENVER CENTENNIAL  GOLDEN   N ANN HTG 99% CONDNS DB

property elevation

The elevation of the simulation environment section.

Returns: The elevation in metres.
Return type: float

property environment_title

The environment title of the simulation environment section.

Return type: str

get_annual_dataframe()[source]

Returns a pandas DataFrame from the annual data.

Return type: pandas.DataFrame

get_annual_periods()[source]

Returns the annual time periods.

Return type: EPEsoAnnualPeriods

get_annual_summary()[source]

Returns a summary of the annual periods and variables.

Return type: str

get_annual_variable(report_code)[source]

get_annual_variables()[source]

Return the annual variables.

Return type: tuple (EPEsoAnnualVariable)

get_daily_dataframe()[source]

Returns a pandas DataFrame from the daily data.

Return type: pandas.DataFrame

get_daily_periods()[source]

Returns the daily time periods.

Return type: EPEsoDailyPeriods

get_daily_summary()[source]

Returns a summary of the daily periods and variables.

Return type: str

get_daily_variable(report_code)[source]

Return a daily variable.

Parameters: report_code (int) – The report code of the variable.
Raises: KeyError – If a daily variable with the report code does not exist.
Return type: EPEsoDailyVariable

get_daily_variables()[source]

Return the daily variables.

Return type: tuple (EPEsoDailyVariable)

get_interval_dataframe()[source]

Returns a pandas DataFrame from the interval data.

Return type: pandas.DataFrame

get_interval_periods()[source]

Returns the interval time periods.

Return type: EPEsoIntervalPeriods

get_interval_summary()[source]

Returns a summary of the interval periods and variables.

Return type: str

get_interval_variable(report_code)[source]

Return an interval variable.

Parameters: report_code (int) – The report code of the variable.
Raises: KeyError – If an interval variable with the report code does not exist.
Return type: EPEsoIntervalVariable

get_interval_variables()[source]

Return the interval variables.

Return type: tuple (EPEsoIntervalVariable)

get_monthly_dataframe()[source]

Returns a pandas DataFrame from the monthly data.

Return type: pandas.DataFrame

get_monthly_periods()[source]

Returns the monthly time periods.

Return type: EPEsoMonthlyPeriods

get_monthly_summary()[source]

Returns a summary of the monthly periods and variables.

Return type: str

get_monthly_variable(report_code)[source]

Return a monthly variable.

Parameters: report_code (int) – The report code of the variable.
Raises: KeyError – If a monthly variable with the report code does not exist.
Return type: EPEsoMonthlyVariable

get_monthly_variables()[source]

Return the monthly variables.

Return type: tuple (EPEsoMonthlyVariable)

get_number_of_variables()[source]

Returns all the number of variables in the simulation environment.

Returns: A dictionary with keys as the different variable intervals and values as the number of variables.
Return type: dict (str,int)

get_run_period_dataframe()[source]

get_run_period_periods()[source]

Returns the run period time periods.

Return type: EPEsoRunPeriodPeriods

get_run_period_summary()[source]

get_run_period_variable()[source]

get_run_period_variables()[source]

Return the run period variables.

Return type: tuple (EPEsorunPeriodVariable)

get_timezone()[source]

Returns the time zone as a datetime.timezone instance.

Return type: datetime.timezone

get_variables()[source]

Returns all the variables in the simulation environment.

Returns: A dictionary with keys as the different variable intervals and values as the interval objects.
Return type: dict(str,list)

property latitude

The latitude of the simulation environment section.

Returns: The latitude in degrees.
Return type: float

property longitude

The longitude of the simulation environment section.

Returns: The longitude in degrees.
Return type: float

summary()[source]

Returns a summary of the all periods and variables in the simulation environment.

Return type: str

property time_zone

The time zone of the simulation environment section.

Return type: str