pyiem.windrose_utils module#

util script to call windrose package

pyiem.windrose_utils.windrose(station, **kwargs)[source]#

Utility function that generates a windrose plot

Parameters:

  • station (str) – station identifier to search database for

  • database (str,optional) – database name to look for data within

  • months (list,optional) – optional list of months to limit plot to

  • hours (list,optional) – optional list of hours to limit plot to

  • sts (datetime,optional) – start datetime

  • ets (datetime,optional) – end datetime

  • units (str,optional) – units to plot values as, default to mph.

  • nsector (int,optional) – number of bins to devide the windrose into

  • justdata (boolean,optional) – if True, write out the data only

  • sname (str,optional) – The name of this station, if not specified it will default to the ((station)) identifier

  • sknt (list,optional) – A list of wind speeds in knots already generated

  • drct (list,optional) – A list of wind directions (deg N) already generated

  • valid (list,optional) – A list of valid datetimes (with tzinfo set), used in the case of providing sknt and drct.

  • level (int,optional) – In case of RAOB, which level interests us (hPa)

  • bins (list,optional) – bins to use for the wind speed

  • tzname (str,optional) – Time zone to use for the plot.

  • cmap (cmap,optional) – Matplotlib colormap to pass to barplot.

  • limit_by_doy (bool,optional) – Use the sts and ets to define a period of days each year to limit the data by. Default false.

  • plot_convention (str) – How to orient the bars. The default is the meteorological convention of from, the other option is to. This only impacts the plot, the provided data should still follow from.

Returns:

matplotlib.Figure instance or textdata

On this page