marmot.plottingmodules.sensitivities.Sensitivities#

class Sensitivities(Zones: typing.List[str], Scenarios: typing.List[str], AGG_BY: str, ordered_gen: typing.List[str], marmot_solutions_folder: pathlib.Path, marmot_color_dict: typing.Optional[dict] = None, scenario_diff: typing.Optional[typing.List[str]] = None, region_mapping: pandas.core.frame.DataFrame = Empty DataFrame Columns: [] Index: [], **kwargs)[source]#

Bases: marmot.plottingmodules.plotutils.plot_data_helper.PlotDataStoreAndProcessor

System sensitivity plots

The sensitivities.py module contains methods that are related to investigating generator sensitivities.

Sensitivities inherits from the PlotDataStoreAndProcessor class to assist in creating figures.

Parameters

  • Zones (List[str]) – List of regions/zones to plot.

  • Scenarios (List[str]) – List of scenarios to plot.

  • AGG_BY (str) – Informs region type to aggregate by when creating plots.

  • ordered_gen (List[str]) – Ordered list of generator technologies to plot, order defines the generator technology position in stacked bar and area plots.

  • marmot_solutions_folder (Path) – Directory containing Marmot solution outputs.

  • marmot_color_dict (dict, optional) – Dictionary of colors to use for generation technologies. Defaults to None.

  • scenario_diff (List[str], optional) – 2 value list, used to compare 2 scenarios. Defaults to None.

  • region_mapping (pd.DataFrame, optional) – Mapping file to map custom regions/zones to create custom aggregations. Aggregations are created by grouping PLEXOS regions. Defaults to pd.DataFrame().

Methods

sensitivities_gas([prop, timezone, ...])

Highlights the difference in generation between two scenarios of a single resource.
sensitivities_gas(prop: Optional[str] = None, timezone: str = '', start_date_range: Optional[str] = None, end_date_range: Optional[str] = None, **_)[source]#

Highlights the difference in generation between two scenarios of a single resource.

Plot is currently under development and not available to use.

The two scenarios are specified in the “Scenario_Diff_plot” field of Marmot_user_defined_inputs.csv The single resource is specified in the “properties” field of Marmot_plot_select.csv. Blue hatches represent additional energy produced by the resource, and red hatches represent decreased energy. The difference in Gas-CC and Gas-CT generation, curtailment, and net interchange are also plotted. Each zone is plotted on a separate figure. Figures and data tables are returned to plot_main

Parameters

  • prop (str, optional) – Controls what generator technology type to create plot for, e.g Gas-CT, Wind etc. Controlled through the plot_select.csv. Defaults to None.

  • timezone (str, optional) – The timezone to display on the x-axes. Defaults to “”.

  • start_date_range (str, optional) – Defines a start date at which to represent data from. Defaults to None.

  • end_date_range (str, optional) – Defines a end date at which to represent data to. Defaults to None.

Returns

Exception class, plot is not functional.

Return type

UnderDevelopment()