marmot.plottingmodules.hydro.Hydro#

class Hydro(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, **kwargs)[source]#

Bases: marmot.plottingmodules.plotutils.plot_data_helper.PlotDataStoreAndProcessor

Hydro generator plots.

The hydro.py module contains methods that are related to hydro generators.

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

Methods

hydro_continent_net_load([start_date_range, ...])

Creates a scatter plot of hydro generation vs net load

hydro_net_load([end, timezone])

Line plot of hydro generation vs net load.
hydro_continent_net_load(start_date_range: Optional[str] = None, end_date_range: Optional[str] = None, **_)[source]#

Creates a scatter plot of hydro generation vs net load

Data is saved within this method.

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.

Returns

DataSavedInModule exception

Return type

DataSavedInModule

hydro_net_load(end: int = 7, timezone: str = '', **_)[source]#

Line plot of hydro generation vs net load.

Creates separate plots for each week of the year, or longer depending on ‘Day After’ value passed through plot_select.csv

Data is saved within this method.

Parameters

  • end (float, optional) – Determines length of plot period. Defaults to 7.

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

Returns

DataSavedInModule exception

Return type

DataSavedInModule