windkit.ws_freq_gt_mean#

windkit.ws_freq_gt_mean(wc_obj, *, bysector=False, n_sectors=None)[source]#

Calculate the wind speed frequency greater than the mean from a wind climate.

Parameters:

wc_obj (xarray.Dataset) – Binned, Weibull or time series wind climate.
bysector (bool) – Calculate the frequency by sector, relative to the mean of each sector, defaults to False. For a Weibull wind climate the all-sector value is the frequency of the wdfreq-weighted sum of the sectorwise distributions above its mean. A time series wind climate is binned into sectors with windkit.wd_to_sector(), skipping samples without a direction.
n_sectors (int, optional) – Number of sectors to bin a time series wind climate into when bysector is True. Defaults to 12.

Returns:

wind_speed_fgtm, the frequency of wind speeds greater than the mean wind speed. Missing samples of a time series are skipped, and a sector without samples gives NaN.

Return type:

xarray.DataArray

Raises:

ValueError – If wc_obj is not a known wind climate, or n_sectors is given for anything but a time series wind climate with bysector=True or is not a positive integer.