geoglows.plots

geoglows.plots.forecast(df: DataFrame, *, plot_type: str = 'plotly', rp_df: DataFrame = None, plot_titles: list = None) → Figure

Plots forecasted streamflow and optional return periods :param df: the dataframe response from geoglows.data.forecast :param rp_df: optional dataframe of return period data :param plot_titles: optional list of strings to include in the figure title. each list item will be on a new line.

Returns:

go.Figure

geoglows.plots.forecast_stats(df: DataFrame, *, plot_type: str = 'plotly', rp_df: DataFrame = None, plot_titles: list = None) → Figure

Plots forecasted streamflow and optional return periods :param df: the dataframe response from geoglows.data.forecast_stats :param rp_df: optional dataframe of return period data :param plot_titles: optional list of strings to include in the figure title. each list item will be on a new line.

Returns:

go.Figure

geoglows.plots.forecast_ensembles(df: DataFrame, *, plot_type: str = 'plotly', rp_df: DataFrame = None, plot_titles: list = None) → Figure

Plots forecasted streamflow and optional return periods :param df: the dataframe response from geoglows.data.forecast_ensembles :param rp_df: optional dataframe of return period data :param plot_titles: optional list of strings to include in the figure title. each list item will be on a new line.

Returns:

go.Figure

geoglows.plots.forecast_records(df: DataFrame, *, plot_type: str = 'plotly', rp_df: DataFrame = None, plot_titles: list = None) → Figure

Plots forecasted streamflow and optional return periods :param df: :param plot_type: :param rp_df: :param plot_titles:

Returns:

go.Figure

geoglows.plots.retrospective(df: DataFrame, *, plot_type: str = 'plotly', rp_df: DataFrame = None, plot_titles: list = None) → Figure

Plots the retrospective simulation data

Parameters:

• df – a dataframe of the retrospective simulation

• plot_type – either plotly or html

• rp_df – a dataframe with the response from the return periods dataset

• plot_titles – additional key-value pairs to display in the title of the figure

Returns:

go.Figure

geoglows.plots.daily_averages(df: DataFrame, *, plot_type: str = 'plotly', plot_titles: list = None) → Figure

Makes a plotly figure of the daily average flows

Parameters:

• df – a dataframe of the daily average flows

• plot_type – either plotly or html

• plot_titles – additional key-value pairs to display in the title of the figure

Returns:

go.Figure

geoglows.plots.monthly_averages(df: DataFrame, *, plot_type: str = 'plotly', plot_titles: list = None) → Figure

Makes a plotly figure of the monthly average flows

Parameters:

• df – a dataframe of the monthly average flows

• plot_type – either plotly or html

• plot_titles – additional key-value pairs to display in the title of the figure

Returns:

go.Figure

geoglows.plots.annual_averages(df: DataFrame, *, plot_type: str = 'plotly', plot_titles: list = None) → Figure

Makes a plotly figure of the annual average flows

Parameters:

• df – a dataframe of the annual average flows

• plot_type – either plotly or html

• plot_titles – additional key-value pairs to display in the title of the figure

Returns:

go.Figure

geoglows.plots.flow_duration_curve(df: DataFrame, *, plot_type: str = 'plotly', plot_titles: list = None) → Figure

Makes a plotly figure of the flow duration curve

Parameters:

• df – a dataframe of the flow duration curve values

• plot_type – either plotly or html

• plot_titles – additional key-value pairs to display in the title of the figure

Returns:

go.Figure

geoglows.plots.corrected_retrospective(corrected: DataFrame, simulated: DataFrame, observed: DataFrame, rperiods: DataFrame = None, plot_titles: list = None, plot_type: str = 'plotly') → Figure

Makes a plotly figure of bias corrected retrospective simulation data

Parameters:

• corrected – the bias corrected simulation dataframe

• simulated – the retrospective simulation dataframe

• observed – the in situ measurements used to bias correct the simulation

• rperiods – the return periods for the simulated river

• plot_type – either plotly or html

• plot_titles – additional key-value pairs to display in the title of the figure

Returns:

go.Figure

geoglows.plots.corrected_month_average(corrected: DataFrame, simulated: DataFrame, observed: DataFrame, plot_titles: list = None, plot_type: str = 'plotly') → Figure

Makes a plotly figure of bias corrected monthly average simulation data

Parameters:

• corrected – the bias corrected simulation dataframe

• simulated – the retrospective simulation dataframe

• observed – the in situ measurements used to bias correct the simulation

• plot_type – either plotly or html

• plot_titles – additional key-value pairs to display in the title of the figure

Returns:

go.Figure

geoglows.plots.corrected_day_average(corrected: DataFrame, simulated: DataFrame, observed: DataFrame, plot_titles: list = None, plot_type: str = 'plotly') → Figure

Makes a plotly figure of bias corrected daily average simulation data

Parameters:

• corrected – the bias corrected simulation dataframe

• simulated – the retrospective simulation dataframe

• observed – the in situ measurements used to bias correct the simulation

• plot_type – either plotly or html

• plot_titles – additional key-value pairs to display in the title of the figure

Returns:

go.Figure

geoglows.plots.corrected_scatterplots(corrected: DataFrame, simulated: DataFrame, observed: DataFrame, plot_titles: list = None, plot_type: str = 'plotly') → Figure

Makes a plotly figure of scatter _plots showing the performance of the bias correction process

Parameters:

• corrected – the bias corrected simulation dataframe

• simulated – the retrospective simulation dataframe

• observed – the in situ measurements used to bias correct the simulation

• plot_type – either plotly or html

• plot_titles – additional key-value pairs to display in the title of the figure

Returns:

go.Figure