climate.indicators.temperature¶

Temperature indices.

Module Contents¶

climate.indicators.temperature.australian_hardiness_zones(ds, **kwargs)¶

Australian hardiness zones.

A climate indice based on a multi-year rolling average of the annual minimum temperature. Developed specifically to aid in determining plant suitability of geographic regions. The Australian National Botanical Gardens (ANBG) classification scheme divides categories into 5-degree Celsius zones, starting from -15 degrees Celsius and ending at 20 degrees Celsius.

Units:

hz: dimensionless

This function wraps xclim.indicators.atmos.australian_hardiness_zones.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.australian_hardiness_zones().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.biologically_effective_degree_days(ds, **kwargs)¶

Biologically effective degree days.

Considers daily minimum and maximum temperature with a given base threshold between 1 April and 31 October, with a maximum daily value for cumulative degree days (typically 9°C), and integrates modification coefficients for latitudes between 40°N and 50°N as well as for swings in daily temperature range. Metric originally published in Gladstones (1992).

Units:

bedd: K days

This function wraps xclim.indicators.atmos.biologically_effective_degree_days.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.biologically_effective_degree_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.cold_spell_days(ds, **kwargs)¶

Cold spell days.

The number of days that are part of a cold spell. A cold spell is defined as a minimum number of consecutive days with mean daily temperature below a given threshold.

Units:

cold_spell_days: days

This function wraps xclim.indicators.atmos.cold_spell_days.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.cold_spell_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.cold_spell_duration_index(ds, **kwargs)¶

Cold spell duration index (csdi).

Number of days part of a percentile-defined cold spell. A cold spell occurs when the daily minimum temperature is below a given percentile for a given number of consecutive days.

Units:

csdi_{window}: days

This function wraps xclim.indicators.atmos.cold_spell_duration_index.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.cold_spell_duration_index().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.cold_spell_frequency(ds, **kwargs)¶

Cold spell frequency.

The frequency of cold periods of N days or more, during which the temperature over a given time window of days is below a given threshold.

Units:

cold_spell_frequency: dimensionless

This function wraps xclim.indicators.atmos.cold_spell_frequency.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.cold_spell_frequency().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.cold_spell_max_length(ds, **kwargs)¶

Cold spell maximum length.

The maximum length of a cold period of N days or more, during which the temperature over a given time window of days is below a given threshold.

Units:

cold_spell_max_length: days

This function wraps xclim.indicators.atmos.cold_spell_max_length.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.cold_spell_max_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.cold_spell_total_length(ds, **kwargs)¶

Cold spell total length.

The total length of cold periods of N days or more, during which the temperature over a given time window of days is below a given threshold.

Units:

cold_spell_total_length: days

This function wraps xclim.indicators.atmos.cold_spell_total_length.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.cold_spell_total_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.consecutive_frost_days(ds, **kwargs)¶

Consecutive frost days.

Maximum number of consecutive days where the daily minimum temperature is below 0°C

Units:

consecutive_frost_days: days

This function wraps xclim.indicators.atmos.consecutive_frost_days.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.consecutive_frost_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.maximum_consecutive_frost_free_days(ds, **kwargs)¶

Maximum consecutive frost free days.

Maximum number of consecutive frost-free days: where the daily minimum temperature is above or equal to 0°C

Units:

consecutive_frost_free_days: days

This function wraps xclim.indicators.atmos.maximum_consecutive_frost_free_days.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.maximum_consecutive_frost_free_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.cool_night_index(ds, **kwargs)¶

Cool night index.

A night coolness variable which takes into account the mean minimum night temperatures during the month when ripening usually occurs beyond the ripening period.

Units:

cool_night_index: degC

This function wraps xclim.indicators.atmos.cool_night_index.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.cool_night_index().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.cooling_degree_days(ds, **kwargs)¶

Cooling degree days.

The cumulative degree days for days when the mean daily temperature is above a given threshold and buildings must be air conditioned.

Units:

cooling_degree_days: K days

This function wraps xclim.indicators.atmos.cooling_degree_days.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.cooling_degree_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.cooling_degree_days_approximation(ds, **kwargs)¶

Cooling degree days approximation.

The cumulative degree days for days when temperatures are above a given threshold and buildings must be air conditioned. This method integrates mean, minimum, and maximum temperatures, accounting for asymmetry in the distributions of temperatures throughout the diurnal cycle.

Units:

cooling_degree_days_approximation: K days

This function wraps xclim.indicators.atmos.cooling_degree_days_approximation.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.cooling_degree_days_approximation().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.corn_heat_units(ds, **kwargs)¶

Corn heat units.

A temperature-based index used to estimate the development of corn crops. Corn growth occurs when the daily minimum and maximum temperatures exceed given thresholds.

Units:

chu: dimensionless

This function wraps xclim.indicators.atmos.corn_heat_units.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.corn_heat_units().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.chill_portions(ds, **kwargs)¶

Chill portions.

Chill portions are a measure to estimate the bud breaking potential of different crops. The constants and functions are taken from Luedeling et al. (2009) which formalises the method described in Fishman et al. (1987). The model computes the accumulation of cold temperatures in a two-step process. First, cold temperatures contribute to an intermediate product that is transformed to a chill portion once it exceeds a certain concentration. The intermediate product can be broken down at higher temperatures but the final product is stable even at higher temperature. Thus the dynamic model is more accurate than other chill models like the Chilling hours or Utah model, especially in moderate climates like Israel, California or Spain.

Units:

cp: dimensionless

This function wraps xclim.indicators.atmos.chill_portions.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.chill_portions().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.chill_units(ds, **kwargs)¶

Chill units.

Chill units are a measure to estimate the bud breaking potential of different crop based on Richardson et al. (1974). The Utah model assigns a weight to each hour depending on the temperature recognising that high temperatures can actual decrease, the potential for bud breaking. Providing positive_only=True will ignore days with negative chill units.

Units:

cu: dimensionless

This function wraps xclim.indicators.atmos.chill_units.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.chill_units().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.degree_days_exceedance_date(ds, **kwargs)¶

Degree day exceedance date.

The day of the year when the sum of degree days exceeds a threshold, occurring after a given date. Degree days are calculated above or below a given temperature threshold.

Units:

degree_days_exceedance_date: dimensionless

This function wraps xclim.indicators.atmos.degree_days_exceedance_date.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.degree_days_exceedance_date().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.daily_freezethaw_cycles(ds, **kwargs)¶

Daily freeze-thaw cycles.

The number of days with a freeze-thaw cycle. A freeze-thaw cycle is defined as a day where maximum daily temperature is above a given threshold and minimum daily temperature is at or below a given threshold, usually 0°C for both.

Units:

dlyfrzthw: days

This function wraps xclim.indicators.atmos.daily_freezethaw_cycles.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.daily_freezethaw_cycles().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.daily_temperature_range(ds, **kwargs)¶

Mean of daily temperature range.

The average difference between the daily maximum and minimum temperatures.

Units:

dtr: K

This function wraps xclim.indicators.atmos.daily_temperature_range.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.daily_temperature_range().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.max_daily_temperature_range(ds, **kwargs)¶

Maximum of daily temperature range.

The maximum difference between the daily maximum and minimum temperatures.

Units:

dtrmax: K

This function wraps xclim.indicators.atmos.max_daily_temperature_range.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.max_daily_temperature_range().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.daily_temperature_range_variability(ds, **kwargs)¶

Variability of daily temperature range.

The average day-to-day variation in daily temperature range.

Units:

dtrvar: K

This function wraps xclim.indicators.atmos.daily_temperature_range_variability.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.daily_temperature_range_variability().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.extreme_temperature_range(ds, **kwargs)¶

Extreme temperature range.

The maximum of the maximum temperature minus the minimum of the minimum temperature.

Units:

etr: K

This function wraps xclim.indicators.atmos.extreme_temperature_range.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.extreme_temperature_range().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.fire_season(ds, **kwargs)¶

Fire season mask.

Binary mask of the active fire season, defined by conditions on consecutive daily temperatures and, optionally, snow depths.

Units:

fire_season: dimensionless

This function wraps xclim.indicators.atmos.fire_season.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.fire_season().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.first_day_tg_above(ds, **kwargs)¶

First day of temperatures superior to a given temperature threshold.

Returns first day of period where temperature is superior to a threshold over a given number of days (default: 1), limited to a starting calendar date (default: January 1st).

Units:

first_day_tg_above: dimensionless

This function wraps xclim.indicators.atmos.first_day_tg_above.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.first_day_tg_above().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.first_day_tg_below(ds, **kwargs)¶

First day of temperatures inferior to a given temperature threshold.

Returns first day of period where temperature is inferior to a threshold over a given number of days (default: 1), limited to a starting calendar date (default: July 1st).

Units:

first_day_tg_below: dimensionless

This function wraps xclim.indicators.atmos.first_day_tg_below.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.first_day_tg_below().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.first_day_tn_above(ds, **kwargs)¶

First day of temperatures superior to a given temperature threshold.

Returns first day of period where temperature is superior to a threshold over a given number of days (default: 1), limited to a starting calendar date (default: January 1st).

Units:

first_day_tn_above: dimensionless

This function wraps xclim.indicators.atmos.first_day_tn_above.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.first_day_tn_above().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.first_day_tn_below(ds, **kwargs)¶

First day of temperatures inferior to a given temperature threshold.

Returns first day of period where temperature is inferior to a threshold over a given number of days (default: 1), limited to a starting calendar date (default: July 1st).

Units:

first_day_tn_below: dimensionless

This function wraps xclim.indicators.atmos.first_day_tn_below.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.first_day_tn_below().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.first_day_tx_above(ds, **kwargs)¶

First day of temperatures superior to a given temperature threshold.

Returns first day of period where temperature is superior to a threshold over a given number of days (default: 1), limited to a starting calendar date (default: January 1st).

Units:

first_day_tx_above: dimensionless

This function wraps xclim.indicators.atmos.first_day_tx_above.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.first_day_tx_above().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.first_day_tx_below(ds, **kwargs)¶

First day of temperatures inferior to a given temperature threshold.

Returns first day of period where temperature is inferior to a threshold over a given number of days (default: 1), limited to a starting calendar date (default: July 1st).

Units:

first_day_tx_below: dimensionless

This function wraps xclim.indicators.atmos.first_day_tx_below.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.first_day_tx_below().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.freezethaw_spell_frequency(ds, **kwargs)¶

Freeze-thaw spell frequency.

Frequency of daily freeze-thaw spells. A freeze-thaw spell is defined as a number of consecutive days where maximum daily temperatures are above a given threshold and minimum daily temperatures are at or below a given threshold, usually 0°C for both.

Units:

freezethaw_spell_frequency: days

This function wraps xclim.indicators.atmos.freezethaw_spell_frequency.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.freezethaw_spell_frequency().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.freezethaw_spell_max_length(ds, **kwargs)¶

Maximal length of freeze-thaw spells.

Maximal length of daily freeze-thaw spells. A freeze-thaw spell is defined as a number of consecutive days where maximum daily temperatures are above a given threshold and minimum daily temperatures are at or below a threshold, usually 0°C for both.

Units:

freezethaw_spell_max_length: days

This function wraps xclim.indicators.atmos.freezethaw_spell_max_length.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.freezethaw_spell_max_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.freezethaw_spell_mean_length(ds, **kwargs)¶

Freeze-thaw spell mean length.

Average length of daily freeze-thaw spells. A freeze-thaw spell is defined as a number of consecutive days where maximum daily temperatures are above a given threshold and minimum daily temperatures are at or below a given threshold, usually 0°C for both.

Units:

freezethaw_spell_mean_length: days

This function wraps xclim.indicators.atmos.freezethaw_spell_mean_length.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.freezethaw_spell_mean_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.freezing_degree_days(ds, **kwargs)¶

Freezing degree days.

The cumulative degree days for days when the average temperature is below a given threshold, typically 0°C.

Units:

freezing_degree_days: K days

This function wraps xclim.indicators.atmos.freezing_degree_days.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.freezing_degree_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.freshet_start(ds, **kwargs)¶

Day of year of spring freshet start.

Day of year of the spring freshet start, defined as the first day when the temperature exceeds a certain threshold for a given number of consecutive days.

Units:

freshet_start: dimensionless

This function wraps xclim.indicators.atmos.freshet_start.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.freshet_start().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.frost_days(ds, **kwargs)¶

Frost days.

Number of days where the daily minimum temperature is below a given threshold.

Units:

frost_days: days

This function wraps xclim.indicators.atmos.frost_days.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.frost_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.frost_free_season_end(ds, **kwargs)¶

Frost free season end.

First day when the temperature is below a given threshold for a given number of consecutive days after a median calendar date.

Units:

frost_free_season_end: dimensionless

This function wraps xclim.indicators.atmos.frost_free_season_end.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.frost_free_season_end().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.frost_free_season_length(ds, **kwargs)¶

Frost free season length.

Duration of the frost free season, defined as the period when the minimum daily temperature is above 0°C without a freezing window of N days, with freezing occurring after a median calendar date.

Units:

frost_free_season_length: days

This function wraps xclim.indicators.atmos.frost_free_season_length.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.frost_free_season_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.frost_free_season_start(ds, **kwargs)¶

Frost free season start.

First day when minimum daily temperature exceeds a given threshold for a given number of consecutive days

Units:

frost_free_season_start: dimensionless

This function wraps xclim.indicators.atmos.frost_free_season_start.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.frost_free_season_start().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.frost_free_spell_max_length(ds, **kwargs)¶

Frost free spell maximum length.

The maximum length of a frost free period of N days or more, during which the minimum temperature over a given time window of days is above a given threshold.

Units:

frost_free_spell_max_length: days

This function wraps xclim.indicators.atmos.frost_free_spell_max_length.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.frost_free_spell_max_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.frost_season_length(ds, **kwargs)¶

Frost season length.

Duration of the freezing season, defined as the period when the daily minimum temperature is below 0°C without a thawing window of days, with the thaw occurring after a median calendar date.

Units:

frost_season_length: days

This function wraps xclim.indicators.atmos.frost_season_length.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.frost_season_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.growing_degree_days(ds, **kwargs)¶

Growing degree days.

The cumulative degree days for days when the average temperature is above a given threshold.

Units:

growing_degree_days: K days

This function wraps xclim.indicators.atmos.growing_degree_days.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.growing_degree_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.growing_season_end(ds, **kwargs)¶

Growing season end.

The first day when the temperature is below a certain threshold for a certain number of consecutive days after a given calendar date.

Units:

growing_season_end: dimensionless

This function wraps xclim.indicators.atmos.growing_season_end.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.growing_season_end().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.growing_season_length(ds, **kwargs)¶

Growing season length.

Number of days between the first occurrence of a series of days with a daily average temperature above a threshold and the first occurrence of a series of days with a daily average temperature below that same threshold, occurring after a given calendar date.

Units:

growing_season_length: days

This function wraps xclim.indicators.atmos.growing_season_length.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.growing_season_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.growing_season_start(ds, **kwargs)¶

Growing season start.

The first day when the temperature exceeds a certain threshold for a given number of consecutive days.

Units:

growing_season_start: dimensionless

This function wraps xclim.indicators.atmos.growing_season_start.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.growing_season_start().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.heat_spell_frequency(ds, **kwargs)¶

Heat spell frequency.

Number of heat spells. A heat spell occurs when rolling averages of daily minimum and maximumtemperatures exceed given thresholds for a number of days.

Units:

heat_spell_frequency: dimensionless

This function wraps xclim.indicators.atmos.heat_spell_frequency.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.heat_spell_frequency().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.heat_spell_max_length(ds, **kwargs)¶

Heat spell maximum length.

The longest heat spell of a period. A heat spell occurs when rolling averages of daily minimum and maximum temperatures exceed given thresholds for a number of days.

Units:

heat_spell_max_length: days

This function wraps xclim.indicators.atmos.heat_spell_max_length.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.heat_spell_max_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.heat_spell_total_length(ds, **kwargs)¶

Heat spell total length.

Total length of heat spells. A heat spell occurs when rolling averages of daily minimum and maximum temperatures exceed given thresholds for a number of days.

Units:

heat_spell_total_length: days

This function wraps xclim.indicators.atmos.heat_spell_total_length.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.heat_spell_total_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.heat_wave_frequency(ds, **kwargs)¶

Heat wave frequency.

Number of heat waves. A heat wave occurs when daily minimum and maximum temperatures exceed given thresholds for a number of days.

Units:

heat_wave_frequency: dimensionless

This function wraps xclim.indicators.atmos.heat_wave_frequency.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.heat_wave_frequency().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.heat_wave_index(ds, **kwargs)¶

Heat wave index.

Number of days that constitute heatwave events. A heat wave occurs when daily minimum and maximum temperatures exceed given thresholds for a number of days.

Units:

heat_wave_index: days

This function wraps xclim.indicators.atmos.heat_wave_index.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.heat_wave_index().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.heat_wave_max_length(ds, **kwargs)¶

Heat wave maximum length.

Maximal duration of heat waves. A heat wave occurs when daily minimum and maximum temperatures exceed given thresholds for a number of days.

Units:

heat_wave_max_length: days

This function wraps xclim.indicators.atmos.heat_wave_max_length.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.heat_wave_max_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.heat_wave_total_length(ds, **kwargs)¶

Heat wave total length.

Total length of heat waves. A heat wave occurs when daily minimum and maximum temperatures exceed given thresholds for a number of days.

Units:

heat_wave_total_length: days

This function wraps xclim.indicators.atmos.heat_wave_total_length.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.heat_wave_total_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.heating_degree_days(ds, **kwargs)¶

Heating degree days.

The cumulative degree days for days when the mean daily temperature is below a given threshold and buildings must be heated.

Units:

heating_degree_days: K days

This function wraps xclim.indicators.atmos.heating_degree_days.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.heating_degree_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.heating_degree_days_approximation(ds, **kwargs)¶

Heating degree days approximation.

The cumulative degree days for days where temperatures are below a given threshold and buildings must be heated. This method integrates mean, minimum, and maximum temperatures, accounting for asymmetry in the distributions of temperatures throughout the diurnal cycle.

Units:

heating_degree_days_approximation: K days

This function wraps xclim.indicators.atmos.heating_degree_days_approximation.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.heating_degree_days_approximation().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.hot_days(ds, **kwargs)¶

Hot days.

Number of days where the daily maximum temperature is above a given threshold.

Units:

hot_days: days

This function wraps xclim.indicators.atmos.hot_days.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.hot_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.hot_spell_frequency(ds, **kwargs)¶

Hot spell frequency.

The frequency of hot periods of N days or more, during which the temperature over a given time window of days is above a given threshold.

Units:

hot_spell_frequency: dimensionless

This function wraps xclim.indicators.atmos.hot_spell_frequency.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.hot_spell_frequency().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.hot_spell_max_length(ds, **kwargs)¶

Hot spell maximum length.

The maximum length of a hot period of N days or more, during which the temperature over a given time window of days is above a given threshold.

Units:

hot_spell_max_length: days

This function wraps xclim.indicators.atmos.hot_spell_max_length.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.hot_spell_max_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.hot_spell_max_magnitude(ds, **kwargs)¶

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:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.hot_spell_max_magnitude().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.hot_spell_total_length(ds, **kwargs)¶

Hot spell total length.

The total length of hot periods of N days or more, during which the temperature over a given time window of days is above a given threshold.

Units:

hot_spell_total_length: days

This function wraps xclim.indicators.atmos.hot_spell_total_length.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.hot_spell_total_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.huglin_index(ds, **kwargs)¶

Huglin heliothermal index.

Heat-summation index for agroclimatic suitability estimation, developed specifically for viticulture. Considers daily minimum and maximum temperature with a given base threshold, typically between 1 April and 30September, and integrates a day-length coefficient calculation for higher latitudes. Metric originally published in Huglin (1978). Day-length coefficient based on Hall & Jones (2010).

Units:

hi: dimensionless

This function wraps xclim.indicators.atmos.huglin_index.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.huglin_index().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.ice_days(ds, **kwargs)¶

Ice days.

Number of days where the daily maximum temperature is below 0°C

Units:

ice_days: days

This function wraps xclim.indicators.atmos.ice_days.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.ice_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.last_spring_frost(ds, **kwargs)¶

Last spring frost.

The last day when minimum temperature is below a given threshold for a certain number of days, limited by a final calendar date.

Units:

last_spring_frost: dimensionless

This function wraps xclim.indicators.atmos.last_spring_frost.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.last_spring_frost().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.late_frost_days(ds, **kwargs)¶

Late frost days.

Number of days where the daily minimum temperature is below a given threshold between a givenstart date and a given end date.

Units:

late_frost_days: days

This function wraps xclim.indicators.atmos.late_frost_days.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.late_frost_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.latitude_temperature_index(ds, **kwargs)¶

Latitude temperature index.

A climate indice based on mean temperature of the warmest month and a latitude-based coefficient to account for longer day-length favouring growing conditions. Developed specifically for viticulture. Mean temperature of warmest month multiplied by the difference of latitude factor coefficient minus latitude. Metric originally published in Jackson, D. I., & Cherry, N. J. (1988).

Units:

lti: dimensionless

This function wraps xclim.indicators.atmos.latitude_temperature_index.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.latitude_temperature_index().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.maximum_consecutive_warm_days(ds, **kwargs)¶

Maximum consecutive warm days.

Maximum number of consecutive days where the maximum daily temperature exceeds a certain threshold.

Units:

maximum_consecutive_warm_days: days

This function wraps xclim.indicators.atmos.maximum_consecutive_warm_days.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.maximum_consecutive_warm_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tg10p(ds, **kwargs)¶

Days with mean temperature below the 10th percentile.

Number of days with mean temperature below the 10th percentile.

Units:

tg10p: days

This function wraps xclim.indicators.atmos.tg10p.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tg10p().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tg90p(ds, **kwargs)¶

Days with mean temperature above the 90th percentile.

Number of days with mean temperature above the 90th percentile.

Units:

tg90p: days

This function wraps xclim.indicators.atmos.tg90p.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tg90p().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tg_days_above(ds, **kwargs)¶

Number of days with mean temperature above a given threshold.

The number of days with mean temperature above a given threshold.

Units:

tg_days_above: days

This function wraps xclim.indicators.atmos.tg_days_above.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tg_days_above().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tg_days_below(ds, **kwargs)¶

Number of days with mean temperature below a given threshold.

The number of days with mean temperature below a given threshold.

Units:

tg_days_below: days

This function wraps xclim.indicators.atmos.tg_days_below.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tg_days_below().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tg_max(ds, **kwargs)¶

Maximum of mean temperature.

Maximum of daily mean temperature.

Units:

tg_max: K

This function wraps xclim.indicators.atmos.tg_max.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tg_max().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tg_mean(ds, **kwargs)¶

Mean temperature.

Mean of daily mean temperature.

Units:

tg_mean: K

This function wraps xclim.indicators.atmos.tg_mean.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tg_mean().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tg_min(ds, **kwargs)¶

Minimum of mean temperature.

Minimum of daily mean temperature.

Units:

tg_min: K

This function wraps xclim.indicators.atmos.tg_min.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tg_min().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.thawing_degree_days(ds, **kwargs)¶

Thawing degree days.

The cumulative degree days for days when the average temperature is above a given threshold, typically 0°C.

Units:

thawing_degree_days: K days

This function wraps xclim.indicators.atmos.thawing_degree_days.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.thawing_degree_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tn10p(ds, **kwargs)¶

Days with minimum temperature below the 10th percentile.

Number of days with minimum temperature below the 10th percentile.

Units:

tn10p: days

This function wraps xclim.indicators.atmos.tn10p.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tn10p().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tn90p(ds, **kwargs)¶

Days with minimum temperature above the 90th percentile.

Number of days with minimum temperature above the 90th percentile.

Units:

tn90p: days

This function wraps xclim.indicators.atmos.tn90p.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tn90p().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tn_days_above(ds, **kwargs)¶

Number of days with minimum temperature above a given threshold.

The number of days with minimum temperature above a given threshold.

Units:

tn_days_above: days

This function wraps xclim.indicators.atmos.tn_days_above.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tn_days_above().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tn_days_below(ds, **kwargs)¶

Number of days with minimum temperature below a given threshold.

The number of days with minimum temperature below a given threshold.

Units:

tn_days_below: days

This function wraps xclim.indicators.atmos.tn_days_below.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tn_days_below().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tn_max(ds, **kwargs)¶

Maximum of minimum temperature.

Maximum of daily minimum temperature.

Units:

tn_max: K

This function wraps xclim.indicators.atmos.tn_max.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tn_max().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tn_mean(ds, **kwargs)¶

Mean of minimum temperature.

Mean of daily minimum temperature.

Units:

tn_mean: K

This function wraps xclim.indicators.atmos.tn_mean.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tn_mean().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tn_min(ds, **kwargs)¶

Minimum temperature.

Minimum of daily minimum temperature.

Units:

tn_min: K

This function wraps xclim.indicators.atmos.tn_min.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tn_min().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tropical_nights(ds, **kwargs)¶

Tropical nights.

Number of days where minimum temperature is above a given threshold.

Units:

tropical_nights: days

This function wraps xclim.indicators.atmos.tropical_nights.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tropical_nights().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tx10p(ds, **kwargs)¶

Days with maximum temperature below the 10th percentile.

Number of days with maximum temperature below the 10th percentile.

Units:

tx10p: days

This function wraps xclim.indicators.atmos.tx10p.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tx10p().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tx90p(ds, **kwargs)¶

Days with maximum temperature above the 90th percentile.

Number of days with maximum temperature above the 90th percentile.

Units:

tx90p: days

This function wraps xclim.indicators.atmos.tx90p.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tx90p().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tx_days_above(ds, **kwargs)¶

Number of days with maximum temperature above a given threshold.

The number of days with maximum temperature above a given threshold.

Units:

tx_days_above: days

This function wraps xclim.indicators.atmos.tx_days_above.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tx_days_above().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tx_days_below(ds, **kwargs)¶

Number of days with maximum temperature below a given threshold.

The number of days with maximum temperature below a given threshold.

Units:

tx_days_below: days

This function wraps xclim.indicators.atmos.tx_days_below.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tx_days_below().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tx_max(ds, **kwargs)¶

Maximum temperature.

Maximum of daily maximum temperature.

Units:

tx_max: K

This function wraps xclim.indicators.atmos.tx_max.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tx_max().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tx_mean(ds, **kwargs)¶

Mean of maximum temperature.

Mean of daily maximum temperature.

Units:

tx_mean: K

This function wraps xclim.indicators.atmos.tx_mean.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tx_mean().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tx_min(ds, **kwargs)¶

Minimum of maximum temperature.

Minimum of daily maximum temperature.

Units:

tx_min: K

This function wraps xclim.indicators.atmos.tx_min.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tx_min().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.tx_tn_days_above(ds, **kwargs)¶

Number of days with daily minimum and maximum temperatures exceeding thresholds.

Number of days with daily maximum and minimum temperatures above given thresholds.

Units:

tx_tn_days_above: days

This function wraps xclim.indicators.atmos.tx_tn_days_above.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.tx_tn_days_above().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.usda_hardiness_zones(ds, **kwargs)¶

Usda hardiness zones.

A climate indice based on a multi-year rolling average of the annual minimum temperature. Developed specifically to aid in determining plant suitability of geographic regions. The USDA classificationscheme divides categories into 10 degree Fahrenheit zones, with 5-degree Fahrenheit half-zones, starting from -65 degrees Fahrenheit and ending at 65 degrees Fahrenheit.

Units:

hz: dimensionless

This function wraps xclim.indicators.atmos.usda_hardiness_zones.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.usda_hardiness_zones().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.temperature.warm_spell_duration_index(ds, **kwargs)¶

Warm spell duration index.

Number of days part of a percentile-defined warm spell. A warm spell occurs when the maximum daily temperature is above a given percentile for a given number of consecutive days.

Units:

warm_spell_duration_index: days

This function wraps xclim.indicators.atmos.warm_spell_duration_index.

Parameters:

ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.
**kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.warm_spell_duration_index().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData