marmot.formatters.formatextra.ExtraSIIProperties#

class ExtraSIIProperties(model: marmot.formatters.formatbase.Process)[source]#

Bases: marmot.formatters.formatextra.ExtraProperties

Contains SIIP specific ExtraProperties and methods

Parameters

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

Methods

generator_curtailment(df[, timescale])

Creates a generator_Curtailment property for SIIP result sets

region_total_load(df[, timescale])

Creates a region_Load property for SIIP results 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_Generation': [('generator_Curtailment', 'generator_curtailment'), ('generator_Generation_Annual', 'annualize_property')], 'region_Demand': [('region_Load', 'region_total_load')]}#

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

generator_curtailment(df: pandas.core.frame.DataFrame, timescale: str = 'interval') → pandas.core.frame.DataFrame[source]#

Creates a generator_Curtailment property for SIIP result sets

Parameters

  • df (pd.DataFrame) – generator_Generation df

  • timescale (str, optional) – Data timescale, e.g Hourly, Monthly, 5 minute etc. Defaults to ‘interval’.

Returns

generator_Curtailment df

Return type

pd.DataFrame

region_total_load(df: pandas.core.frame.DataFrame, timescale: str = 'interval') → pandas.core.frame.DataFrame[source]#

Creates a region_Load property for SIIP results sets

SIIP 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 ‘interval’.

Returns

region_Load df

Return type

pd.DataFrame