marmot.plottingmodules.capacity_out.CapacityOut#

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

Bases: marmot.plottingmodules.plotutils.plot_data_helper.PlotDataStoreAndProcessor

Generator outage plots.

The capacity_out.py module contains methods that are related to generators that are on an outage.

CapacityOut 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

capacity_out_stack([start_date_range, ...])

Creates Timeseries stacked area plots of generation on outage by technology.

capacity_out_stack_PASA([start, end, timezone])

capacity_out_stack(start_date_range: Optional[str] = None, end_date_range: Optional[str] = None, data_resolution: str = '', **_)[source]#

Creates Timeseries stacked area plots of generation on outage by technology.

Each scenario is plotted by a separate facet plot.

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