brightwind.analyse.plot.plot_scatter_wdir

brightwind.analyse.plot.plot_scatter_wdir(x_wdir_series, y_wdir_series, x_axis_title=None, y_axis_title=None, x_limits=(0, 360), y_limits=(0, 360))

Plots a scatter plot of two wind direction timeseries and adds a line from 0,0 to 360,360.

Parameters

  • x_wdir_series (pd.Series) – The x-axis values or reference wind directions.

  • y_wdir_series (pd.Series) – The y-axis values or target wind directions.

  • x_axis_title (str, None) – Title for the x-axis. If None, title will be taken from x_wdir_series name.

  • y_axis_title (str, None) – Title for the y-axis. If None, title will be taken from y_wdir_series name.

  • x_limits (tuple) – x-axis min and max limits.

  • y_limits (tuple) – y-axis min and max limits.

Returns

scatter plot

Return type

matplotlib.figure.Figure

Example usage

import brightwind as bw
data = bw.load_csv(bw.datasets.demo_data)

#To plot few variables
bw.plot_scatter_wdir(data.Dir78mS, data.Dir58mS)

#To overwrite the default axis titles.
bw.plot_scatter_wdir(data.Dir78mS, data.Dir58mS, x_axis_title='Wind direction at 78m',
                     y_axis_title='Wind direction at 58m')

#To set the x and y axis limits by using a tuple.
bw.plot_scatter_wdir(data.Dir78mS, data.Dir58mS, x_axis_title='Reference', y_axis_title='Target',
                     x_limits=(50,300), y_limits=(250,300))