marmot.plottingmodules.ramping.Ramping#

class Ramping(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=[]), color_list: list = ['#396AB1', '#CC2529', '#3E9651', '#ff7f00', '#6B4C9A', '#922428', '#cab2d6', '#6a3d9a', '#fb9a99', '#b15928'], **kwargs)[source]#

Bases: marmot.plottingmodules.plotutils.plot_data_helper.PlotDataStoreAndProcessor

Generator start and ramping plots.

The ramping.py module contains methods that are related to the ramp periods of generators.

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

  • color_list (list, optional) – List of colors to apply to non-gen plots. Defaults to ColorList().colors.

Methods

capacity_started([start_date_range, ...])

Creates bar plots of total thermal capacity started by technology type.

count_ramps(**_)

Plot under development

count_starts_single_gen([prop, ...])

Counts the number of times a specified generator turns on during the simulation.
capacity_started(start_date_range: Optional[str] = None, end_date_range: Optional[str] = None, scenario_groupby: str = 'Scenario', **_)[source]#

Creates bar plots of total thermal capacity started by technology type.

Each sceanrio is plotted as a separate color grouped bar.

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.

  • scenario_groupby (str, optional) –

    Specifies whether to group data by Scenario or Year-Sceanrio. If grouping by Year-Sceanrio the year will be identified from the timestamp and appeneded to the sceanrio name. This is useful when plotting data which covers multiple years such as ReEDS. Defaults to Scenario.

    New in version 0.10.0.

Returns

Dictionary containing the created plot and its data table.

Return type

dict

count_ramps(**_)[source]#

Plot under development

Returns

Exception class, plot is not functional.

Return type

UnderDevelopment()

count_starts_single_gen(prop: Optional[str] = None, start_date_range: Optional[str] = None, end_date_range: Optional[str] = None, **_)[source]#

Counts the number of times a specified generator turns on during the simulation.

Parameters

prop (str, optional) – Name of the PLEXOS generator. Defaults to None.

Returns

Dictionary containing the created plot and its data table.

Return type

dict