earthkit.climate.atmos.hot_spell_max_magnitude¶
- earthkit.climate.atmos.hot_spell_max_magnitude(tasmax: xarray.DataArray | str = 'tasmax', ds: xarray.Dataset | Any = None, *, thresh: Any = '25.0 degC', window: int = 3, freq: str = 'YS', resample_before_rl: bool = True, **kwargs: Any) Any¶
Hot spell maximum magnitude.
Magnitude of the most intensive heat wave per {freq}. A heat wave occurs when daily maximum temperatures exceed given thresholds for a number of days.
Units:
hot_spell_max_magnitude: K d
This function wraps xclim.indicators.atmos.hot_spell_max_magnitude.
- Parameters:
tasmax (
xarray.DataArray | str) – Maximum daily temperature.thresh (
Any) – Threshold temperature on which to designate a heatwave.window (
int) – Minimum number of days with temperature above the threshold to qualify as a heatwave.freq (
str) – Resampling frequency.resample_before_rl (
bool) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.ds (
xarray.Dataset | Any) – Input dataset.**kwargs (
Any) – Additional keyword arguments.
- Returns:
The computed index.
- Return type:
Any