marmot.plottingmodules.thermal_cap_reserve.ThermalReserve#

class ThermalReserve(Zones: List[str], Scenarios: List[str], AGG_BY: str, ordered_gen: List[str], marmot_solutions_folder: pathlib.Path, gen_categories: marmot.plottingmodules.plotutils.plot_data_helper.GenCategories = GenCategories(vre=[], pv=[], re=[], thermal=[]), marmot_color_dict: Optional[dict] = None, ylabels: Optional[List[str]] = None, xlabels: Optional[List[str]] = None, **kwargs)[source]#

Bases: marmot.plottingmodules.plotutils.plot_data_helper.PlotDataStoreAndProcessor

Thermal capacity in reserve plots.

The thermal_cap_reserve module contains methods that display the amount of generation in reserve, i.e non committed capacity.

ThermalReserve 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.

  • gen_categories (GenCategories) – Instance of GenCategories class, groups generator technologies into defined categories. Deafults to GenCategories.

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

  • ylabels (List[str], optional) – y-axis labels for facet plots. Defaults to None.

  • xlabels (List[str], optional) – x-axis labels for facet plots. Defaults to None.

Methods

thermal_cap_reserves([start_date_range, ...])

Plots the total thermal generation capacity that is not committed, i.e in reserve.
thermal_cap_reserves(start_date_range: Optional[str] = None, end_date_range: Optional[str] = None, data_resolution: str = '', **_)[source]#

Plots the total thermal generation capacity that is not committed, i.e in reserve.

If multiple scenarios are included, each one will be plotted on a separate facet subplot.

Parameters

  • 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.

  • data_resolution (str, optional) –

    Specifies the data resolution to pull from the formatted data and plot. Defaults to “”, which will pull interval data.

    New in version 0.10.0.

Returns

Dictionary containing the created plot and its data table.

Return type

dict