climate.indicators.precipitation

Precipitation indices.

Module Contents

climate.indicators.precipitation.antecedent_precipitation_index(ds, **kwargs)

Antecedent precipitation index.

Calculate the running weighted sum of daily precipitation values given a window and weighting exponent. This index serves as an indicator for soil moisture.

Units:

  • api: mm

This function wraps xclim.indicators.atmos.antecedent_precipitation_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.antecedent_precipitation_index().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.maximum_consecutive_dry_days(ds, **kwargs)

Maximum consecutive dry days.

The longest number of consecutive days where daily precipitation below a given threshold.

Units:

  • cdd: days

This function wraps xclim.indicators.atmos.maximum_consecutive_dry_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_dry_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.cffwis_indices(ds, **kwargs)

Canadian fire weather index system indices.

Computes the six (6) fire weather indexes, as defined by the Canadian Forest Service: - The Drought Code - The Duff-Moisture Code - The Fine Fuel Moisture Code - The Initial Spread Index - The Build Up Index - The Fire Weather Index.

Units:

  • dc: dimensionless

  • dmc: dimensionless

  • ffmc: dimensionless

  • isi: dimensionless

  • bui: dimensionless

  • fwi: dimensionless

This function wraps xclim.indicators.atmos.cffwis_indices.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.cffwis_indices().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.cold_and_dry_days(ds, **kwargs)

Cold and dry days.

Number of days with temperature below a given percentile and precipitation below a given percentile.

Units:

  • cold_and_dry_days: days

This function wraps xclim.indicators.atmos.cold_and_dry_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_and_dry_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.cold_and_wet_days(ds, **kwargs)

Cold and wet days.

Number of days with temperature below a given percentile and precipitation above a given percentile.

Units:

  • cold_and_wet_days: days

This function wraps xclim.indicators.atmos.cold_and_wet_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_and_wet_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.maximum_consecutive_wet_days(ds, **kwargs)

Maximum consecutive wet days.

The longest number of consecutive days where daily precipitation is at or above a given threshold.

Units:

  • cwd: days

This function wraps xclim.indicators.atmos.maximum_consecutive_wet_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_wet_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.days_over_precip_doy_thresh(ds, **kwargs)

Number of days with precipitation above a given daily percentile.

Number of days in a period where precipitation is above a given daily percentile and a fixed threshold.

Units:

  • days_over_precip_doy_thresh: days

This function wraps xclim.indicators.atmos.days_over_precip_doy_thresh.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.days_over_precip_doy_thresh().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.days_over_precip_thresh(ds, **kwargs)

Number of days with precipitation above a given percentile.

Number of days in a period where precipitation is above a given percentile, calculated over a given period and a fixed threshold.

Units:

  • days_over_precip_thresh: days

This function wraps xclim.indicators.atmos.days_over_precip_thresh.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.days_over_precip_thresh().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.days_with_snow(ds, **kwargs)

Days with snowfall.

Number of days with snow between a lower and upper limit.

Units:

  • days_with_snow: days

This function wraps xclim.indicators.atmos.days_with_snow.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.days_with_snow().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.drought_code(ds, **kwargs)

Daily drought code.

The Drought Index is part of the Canadian Forest-Weather Index system. It is a numerical code that estimates the average moisture content of organic layers.

Units:

  • dc: dimensionless

This function wraps xclim.indicators.atmos.drought_code.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.drought_code().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.griffiths_drought_factor(ds, **kwargs)

Griffiths drought factor based on the soil moisture deficit.

The drought factor is a numeric indicator of the forest fire fuel availability in the deep litter bed. It is often used in the calculation of the McArthur Forest Fire Danger Index. The method implemented here follows :cite:t:`ffdi-finkele_2006`.

Units:

  • df: dimensionless

This function wraps xclim.indicators.atmos.griffiths_drought_factor.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.griffiths_drought_factor().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.duff_moisture_code(ds, **kwargs)

Duff moisture code (fwi component).

The duff moisture code is part of the Canadian Forest Fire Weather Index System. It is a numeric rating of the average moisture content of loosely compacted organic layers of moderate depth.

Units:

  • dmc: dimensionless

This function wraps xclim.indicators.atmos.duff_moisture_code.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.duff_moisture_code().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.dry_days(ds, **kwargs)

Number of dry days.

The number of days with daily precipitation under a given threshold.

Units:

  • dry_days: days

This function wraps xclim.indicators.atmos.dry_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.dry_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.dry_spell_frequency(ds, **kwargs)

Dry spell frequency.

The frequency of dry periods of N days or more, during which the accumulated or maximum precipitation over a given time window of days is below a given threshold.

Units:

  • dry_spell_frequency: dimensionless

This function wraps xclim.indicators.atmos.dry_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.dry_spell_frequency().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.dry_spell_max_length(ds, **kwargs)

Dry spell maximum length.

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

Units:

  • dry_spell_max_length: days

This function wraps xclim.indicators.atmos.dry_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.dry_spell_max_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.dry_spell_total_length(ds, **kwargs)

Dry spell total length.

The total length of dry periods of N days or more, during which the accumulated or maximum precipitation over a given time window of days is below a given threshold.

Units:

  • dry_spell_total_length: days

This function wraps xclim.indicators.atmos.dry_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.dry_spell_total_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.dryness_index(ds, **kwargs)

Dryness index.

The dryness index is a characterization of the water component in winegrowing regions which considers the precipitation and evapotranspiration factors without deduction for surface runoff or drainage. Metric originally published in Riou et al. (1994).

Units:

  • dryness_index: mm

This function wraps xclim.indicators.atmos.dryness_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.dryness_index().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.mcarthur_forest_fire_danger_index(ds, **kwargs)

Mcarthur forest fire danger index (ffdi) mark 5.

The FFDI is a numeric indicator of the potential danger of a forest fire.

Units:

  • ffdi: dimensionless

This function wraps xclim.indicators.atmos.mcarthur_forest_fire_danger_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.mcarthur_forest_fire_danger_index().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.first_snowfall(ds, **kwargs)

First day where snowfall exceeded a given threshold.

The first day where snowfall exceeded a given threshold during a time period (the threshold can be given as a snowfall flux or a liquid water equivalent snowfall rate).

Units:

  • first_snowfall: dimensionless

This function wraps xclim.indicators.atmos.first_snowfall.

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_snowfall().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.fraction_over_precip_doy_thresh(ds, **kwargs)

Fraction of precipitation due to wet days with daily precipitation over a given daily percentile.

The percentage of the total precipitation over a period occurring for days when the precipitation is above a threshold defining wet days and above a given percentile for that day.

Units:

  • fraction_over_precip_doy_thresh: dimensionless

This function wraps xclim.indicators.atmos.fraction_over_precip_doy_thresh.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.fraction_over_precip_doy_thresh().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.fraction_over_precip_thresh(ds, **kwargs)

Fraction of precipitation due to wet days with daily precipitation over a given percentile.

The percentage of the total precipitation over a period occurring for days when the precipitation is above a threshold defining wet days and above a given percentile for that day.

Units:

  • fraction_over_precip_thresh: dimensionless

This function wraps xclim.indicators.atmos.fraction_over_precip_thresh.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.fraction_over_precip_thresh().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.high_precip_low_temp(ds, **kwargs)

Days with precipitation and cold temperature.

Number of days with precipitation above a given threshold and temperature below a given threshold.

Units:

  • high_precip_low_temp: days

This function wraps xclim.indicators.atmos.high_precip_low_temp.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.high_precip_low_temp().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.keetch_byram_drought_index(ds, **kwargs)

Keetch-byram drought index (kbdi) for soil moisture deficit.

The KBDI indicates the amount of water necessary to bring the soil moisture content back to field capacity. It is often used in the calculation of the McArthur Forest Fire Danger Index. The method implemented here follows :cite:t:`ffdi-finkele_2006` but limits the maximum KBDI to 203.2 mm, rather than 200 mm, in order to align best with the majority of the literature.

Units:

  • kbdi: mm/day

This function wraps xclim.indicators.atmos.keetch_byram_drought_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.keetch_byram_drought_index().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.last_snowfall(ds, **kwargs)

Last day where snowfall exceeded a given threshold.

The last day where snowfall exceeded a given threshold during a time period (the threshold can be given as a snowfall flux or a liquid water equivalent snowfall rate).

Units:

  • last_snowfall: dimensionless

This function wraps xclim.indicators.atmos.last_snowfall.

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_snowfall().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.liquid_precip_ratio(ds, **kwargs)

Fraction of liquid to total precipitation.

The ratio of total liquid precipitation over the total precipitation. Liquid precipitation is approximated from total precipitation on days where temperature is above a given threshold.

Units:

  • liquid_precip_ratio: dimensionless

This function wraps xclim.indicators.atmos.liquid_precip_ratio.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.liquid_precip_ratio().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.liquid_precip_average(ds, **kwargs)

Averaged liquid precipitation.

Averaged liquid precipitation. Precipitation is considered liquid when the average daily temperature is above a given threshold.

Units:

  • liquidprcpavg: mm

This function wraps xclim.indicators.atmos.liquid_precip_average.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.liquid_precip_average().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.liquid_precip_accumulation(ds, **kwargs)

Total accumulated liquid precipitation.

Total accumulated liquid precipitation. Precipitation is considered liquid when the average daily temperature is above a given threshold.

Units:

  • liquidprcptot: mm

This function wraps xclim.indicators.atmos.liquid_precip_accumulation.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.liquid_precip_accumulation().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.max_n_day_precipitation_amount(ds, **kwargs)

Maximum n-day total precipitation.

Maximum of the moving sum of daily precipitation for a given period.

Units:

  • rx{window}day: mm

This function wraps xclim.indicators.atmos.max_n_day_precipitation_amount.

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_n_day_precipitation_amount().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.max_pr_intensity(ds, **kwargs)

Maximum precipitation intensity over time window.

Maximum precipitation intensity over a given rolling time window.

Units:

  • max_pr_intensity: mm h-1

This function wraps xclim.indicators.atmos.max_pr_intensity.

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_pr_intensity().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.precip_average(ds, **kwargs)

Averaged precipitation (solid and liquid).

Averaged precipitation. If the average daily temperature is given, the phase parameter can be used to restrict the calculation to precipitation of only one phase (liquid or solid). Precipitation is considered solid if the average daily temperature is below 0°C threshold (and vice versa).

Units:

  • prcpavg: mm

This function wraps xclim.indicators.atmos.precip_average.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.precip_average().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.precip_accumulation(ds, **kwargs)

Total accumulated precipitation (solid and liquid).

Total accumulated precipitation. If the average daily temperature is given, the phase parameter can be used to restrict the calculation to precipitation of only one phase (liquid or solid). Precipitation is considered solid if the average daily temperature is below 0°C (and vice versa).

Units:

  • prcptot: mm

This function wraps xclim.indicators.atmos.precip_accumulation.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.precip_accumulation().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.rain_on_frozen_ground_days(ds, **kwargs)

Number of rain on frozen ground days.

The number of days with rain above a given threshold after a series of seven days with average daily temperature below 0°C. Precipitation is assumed to be rain when the daily average temperature is above 0°C.

Units:

  • rain_frzgr: days

This function wraps xclim.indicators.atmos.rain_on_frozen_ground_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.rain_on_frozen_ground_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.rain_season(ds, **kwargs)

Rain season.

Start time, end time and length of the rain season, notably useful for West Africa (sivakumar, 1998). The rain season starts with a period of abundant rainfall, followed by a period without prolonged dry sequences, which must happen before a given date. The rain season stops during a dry period happening after a given date.

Units:

  • rain_season_start: dimensionless

  • rain_season_end: dimensionless

  • rain_season_length: days

This function wraps xclim.indicators.atmos.rain_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.rain_season().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.rprctot(ds, **kwargs)

Proportion of accumulated precipitation arising from convective processes.

The proportion of total precipitation due to convective processes. Only days with surpassing a minimum precipitation flux are considered.

Units:

  • rprctot: dimensionless

This function wraps xclim.indicators.atmos.rprctot.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.rprctot().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.max_1day_precipitation_amount(ds, **kwargs)

Maximum 1-day total precipitation.

Maximum total daily precipitation for a given period.

Units:

  • rx1day: mm/day

This function wraps xclim.indicators.atmos.max_1day_precipitation_amount.

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_1day_precipitation_amount().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.daily_pr_intensity(ds, **kwargs)

Simple daily intensity index.

Average precipitation for days with daily precipitation above a given threshold.

Units:

  • sdii: mm d-1

This function wraps xclim.indicators.atmos.daily_pr_intensity.

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_pr_intensity().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.snowfall_frequency(ds, **kwargs)

Snowfall frequency.

Percentage of days with snowfall above a given threshold (either a snowfall flux or a liquid water equivalent snowfall rate).

Units:

  • snowfall_frequency: %

This function wraps xclim.indicators.atmos.snowfall_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.snowfall_frequency().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.snowfall_intensity(ds, **kwargs)

Snowfall intensity.

Mean daily liquid water equivalent snowfall rate above threshold (either a snowfall flux or a liquid water equivalent snowfall rate)

Units:

  • snowfall_intensity: mm/day

This function wraps xclim.indicators.atmos.snowfall_intensity.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.snowfall_intensity().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.solid_precip_average(ds, **kwargs)

Averaged solid precipitation.

Averaged solid precipitation. Precipitation is considered solid when the average daily temperature is at or below a given threshold.

Units:

  • solidprcpavg: mm

This function wraps xclim.indicators.atmos.solid_precip_average.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.solid_precip_average().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.solid_precip_accumulation(ds, **kwargs)

Total accumulated solid precipitation.

Total accumulated solid precipitation. Precipitation is considered solid when the average daily temperature is at or below a given threshold.

Units:

  • solidprcptot: mm

This function wraps xclim.indicators.atmos.solid_precip_accumulation.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.solid_precip_accumulation().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.warm_and_dry_days(ds, **kwargs)

Warm and dry days.

Number of days with temperature above a given percentile and precipitation below a given percentile.

Units:

  • warm_and_dry_days: days

This function wraps xclim.indicators.atmos.warm_and_dry_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.warm_and_dry_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.warm_and_wet_days(ds, **kwargs)

Warm and wet days.

Number of days with temperature above a given percentile and precipitation above a given percentile.

Units:

  • warm_and_wet_days: days

This function wraps xclim.indicators.atmos.warm_and_wet_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.warm_and_wet_days().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.water_cycle_intensity(ds, **kwargs)

Water cycle intensity.

The sum of precipitation and actual evapotranspiration.

Units:

  • water_cycle_intensity: mm

This function wraps xclim.indicators.atmos.water_cycle_intensity.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.water_cycle_intensity().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.wet_precip_accumulation(ds, **kwargs)

Total accumulated precipitation (solid and liquid) during wet days.

Total accumulated precipitation on days with precipitation. A day is considered to have precipitation if the precipitation is greater than or equal to a given threshold.

Units:

  • wet_prcptot: mm

This function wraps xclim.indicators.atmos.wet_precip_accumulation.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.wet_precip_accumulation().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.wet_spell_frequency(ds, **kwargs)

Wet spell frequency.

The frequency of wet periods of N days or more, during which the accumulated or maximum precipitation over a given time window of days is equal or above a given threshold.

Units:

  • wet_spell_frequency: dimensionless

This function wraps xclim.indicators.atmos.wet_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.wet_spell_frequency().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.wet_spell_max_length(ds, **kwargs)

Wet spell maximum length.

The maximum length of a wet period of N days or more, during which the accumulated or maximum precipitation over a given time window of days is equal or above a given threshold.

Units:

  • wet_spell_max_length: days

This function wraps xclim.indicators.atmos.wet_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.wet_spell_max_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.wet_spell_total_length(ds, **kwargs)

Wet spell total length.

The total length of dry periods of N days or more, during which the accumulated or maximum precipitation over a given time window of days is equal or above a given threshold.

Units:

  • wet_spell_total_length: days

This function wraps xclim.indicators.atmos.wet_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.wet_spell_total_length().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.wetdays(ds, **kwargs)

Number of wet days.

The number of days with daily precipitation at or above a given threshold.

Units:

  • wetdays: days

This function wraps xclim.indicators.atmos.wetdays.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.wetdays().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData

climate.indicators.precipitation.wetdays_prop(ds, **kwargs)

Proportion of wet days.

The proportion of days with daily precipitation at or above a given threshold.

Units:

  • wetdays_prop: 1

This function wraps xclim.indicators.atmos.wetdays_prop.

Parameters:

  • ds (conversions.EarthkitData | xarray.Dataset) – Input dataset. See xclim documentation for required variables.

  • **kwargs (Any) – Additional keyword arguments forwarded to xclim.indicators.atmos.wetdays_prop().

Returns:

The computed index as an Earthkit-compatible field.

Return type:

conversions.EarthkitData