environmentaltools.graphics.wrose

environmentaltools.graphics.wrose(wd: ndarray, ws: ndarray, legend_title: str = 'Wave rose', fig_title: str = None, var_name: str = 'Wave height (m)', bins: list = [0, 0.25, 0.5, 1.5, 2.5], calm_limit=0, file_name: str = None)[source]

Draws a wind or wave rose

Parameters:

  • wd (*) – time series with the circular variable

  • ws (*) – time series with the linear variable

  • legend_title (*) – set the title of the rose. Defaults to ‘Wave rose’.

  • fig_title (*) – set the title of the figure. Defaults to None.

  • var_name (*) – name of the mean variable. Default ‘Wave height (m)’

  • bins (*) – value of segments for variable

  • file_name (*) – name of the file to save the plot or None to see plots on the screen. Defaults to None.

Returns:

axis for the plot or None

Return type:

  • ax (matplotlib.axis)