marmot.formatters.formatextra.ExtraReEDSProperties

class ExtraReEDSProperties(model: marmot.formatters.formatbase.Process)

Bases: marmot.formatters.formatextra.ExtraProperties

Contains ReEDS specific ExtraProperties and methods

Parameters

model (Process) – model specific instance of a Process class, e.g ProcessPLEXOS, ProcessReEDS

Methods

generator_fom_cost(df, **_)	Creates a generator_FOM_Cost property for ReEDS result sets
generator_fuel_cost(df, **_)	Creates a generator_Fuel_Cost property for ReEDS result sets
generator_reserve_vom_cost(df, **_)	Creates a generator_Reserves_VOM_Cost property for ReEDS result sets
generator_vom_cost(df, **_)	Creates a generator_VO&M property for ReEDS result sets
region_total_load(df[, timescale])	Creates a region_Load property for ReEDS results sets
reserve_provision(df, **_)	Creates a reserve_Provision property for ReEDS result sets

Attributes

EXTRA_MARMOT_PROPERTIES

Dictionary of Extra custom properties that are created based off existing properties.

EXTRA_MARMOT_PROPERTIES: dict = {'generator_Curtailment': [('generator_Curtailment_Annual', 'annualize_property')], 'generator_Pump_Load': [('generator_Pump_Load_Annual', 'annualize_property')], 'generator_Total_Generation_Cost': [('generator_VOM_Cost', 'generator_vom_cost'), ('generator_Fuel_Cost', 'generator_fuel_cost'), ('generator_Reserves_VOM_Cost', 'generator_reserve_vom_cost'), ('generator_FOM_Cost', 'generator_fom_cost')], 'region_Demand': [('region_Demand_Annual', 'annualize_property'), ('region_Load', 'region_total_load')], 'region_Load': [('region_Load_Annual', 'annualize_property')], 'reserves_generators_Provision': [('reserve_Provision', 'reserve_provision')]}

Dictionary of Extra custom properties that are created based off existing properties.

region_total_load(df: pandas.core.frame.DataFrame, timescale: str = 'year') → pandas.core.frame.DataFrame

Creates a region_Load property for ReEDS results sets

ReEDS does not include storage charging in total load This is added to region_Demand to get region_Load

Parameters

• df (pd.DataFrame) – region_Demand df

• timescale (str, optional) – Data timescale. Defaults to ‘year’.

Returns

region_Load df

Return type

pd.DataFrame

reserve_provision(df: pandas.core.frame.DataFrame, **_) → pandas.core.frame.DataFrame

Creates a reserve_Provision property for ReEDS result sets

Parameters

df (pd.DataFrame) – reserves_generators_Provision df

Returns

reserve_Provision df

Return type

pd.DataFrame

generator_vom_cost(df: pandas.core.frame.DataFrame, **_) → pandas.core.frame.DataFrame

Creates a generator_VO&M property for ReEDS result sets

Parameters

df (pd.DataFrame) – generator_Total_Generation_Cost df

Returns

generator_VO&M df

Return type

pd.DataFrame

generator_fuel_cost(df: pandas.core.frame.DataFrame, **_) → pandas.core.frame.DataFrame

Creates a generator_Fuel_Cost property for ReEDS result sets

Parameters

df (pd.DataFrame) – generator_Total_Generation_Cost df

Returns

generator_Fuel_Cost df

Return type

pd.DataFrame

generator_reserve_vom_cost(df: pandas.core.frame.DataFrame, **_) → pandas.core.frame.DataFrame

Creates a generator_Reserves_VOM_Cost property for ReEDS result sets

Parameters

df (pd.DataFrame) – generator_Total_Generation_Cost df

Returns

generator_Reserves_VOM_Cost df

Return type

pd.DataFrame

generator_fom_cost(df: pandas.core.frame.DataFrame, **_) → pandas.core.frame.DataFrame

Creates a generator_FOM_Cost property for ReEDS result sets

Parameters

df (pd.DataFrame) – generator_Total_Generation_Cost df

Returns

generator_FOM_Cost df

Return type

pd.DataFrame