doc: |
  ==============
  ICCLIM indices
  ==============

  The European Climate Assessment & Dataset project (`ECAD`_) defines a set of 26 core climate indices. Those have been
  made accessible directly in xclim through their ECAD name for compatibility. However, the methods in this module are
  only wrappers around the corresponding methods of `xclim.indices`. Note that none of the checks performed by the
  `xclim.utils.Indicator` class (like with `xclim.atmos` indicators)are performed in this module.

  .. _ECAD: https://www.ecad.eu/
realm: atmos
references: European Climate Assessment & Dataset https://www.ecad.eu/
indicators:
  TG:
    base: tg_mean
  TX:
    base: tx_mean
  TN:
    base: tn_mean
  TG90p:
    base: tg90p
    cf_attrs:
      long_name: Days with TG>90th percentile of daily mean temperature (warm days)
  TG10p:
    base: tg10p
    cf_attrs:
      long_name: Days with TG<10th percentile of daily mean temperature (cold days)
  TGx:
    base: tg_max
  TGn:
    base: tg_min
  TX90p:
    base: tx90p
    cf_attrs:
      long_name: Days with TX>90th percentile of daily maximum temperature (warm day-times)
  TX10p:
    base: tx10p
    cf_attrs:
      long_name: Days with TX<10th percentile of daily maximum temperature (cold day-times)
  TXx:
    base: tx_max
  TXn:
    base: tx_min
  TN90p:
    base: tn90p
    cf_attrs:
      long_name: Days with TN>90th percentile of daily minimum temperature (warm nights)
  TN10p:
    base: tn10p
    cf_attrs:
      long_name: Days with TN<10th percentile of daily minimum temperature (cold nights)
  TNx:
    base: tn_max
  TNn:
    base: tn_min
  HI:
    base: huglin_index
    cf_attrs:
      long_name: >
        Huglin heliothermal index (Summation of ((Tmean + Tmax)/2 - 10°C) * Latitude-based
        day-length coefficient (`k`), for days between 1 April and 31 October)
    compute: huglin_index
    parameters:
      method: icclim
      thresh: 10 degC
      start_date: 04-01
      end_date: 11-01
  BEDD:
    base: biologically_effective_degree_days
    cf_attrs:
      long_name: >
        Biologically effective growing degree days (Summation of min(max((Tmin + Tmax)/2 - 10°C, 0), 9°C),
        for days between 1 April and 30 September)
    compute: biologically_effective_degree_days
    parameters:
      method: icclim
      thresh_tasmin: 10 degC
      max_daily_degree_days: 9 degC
      start_date: 04-01
      end_date: 10-01
      low_dtr: null
      high_dtr: null
      lat: null
  CSDI:
    base: cold_spell_duration_index
    cf_attrs:
      long_name: Cold-spell duration index
    parameters:
      window: 6
  WSDI:
    base: warm_spell_duration_index
    cf_attrs:
      long_name: Warm-spell duration index
    parameters:
      window: 6
  SU:
    base: tx_days_above
    cf_attrs:
      long_name: Summer days (TX>25°C)
    parameters:
      thresh: 25 degC
  CSU:
    base: maximum_consecutive_warm_days
    cf_attrs:
      long_name: Maximum number of consecutive summer day
    parameters:
      thresh: 25 degC
  TR:
    base: tropical_nights
    cf_attrs:
      long_name: Tropical nights (TN>20°C)
    parameters:
      thresh: 20 degC
  GD4:
    base: growing_degree_days
    cf_attrs:
      long_name: Growing degree days (sum of TG>4°C)
    parameters:
      thresh: 4 degC
  FD:
    base: frost_days
    cf_attrs:
      long_name: Frost days (TN<0°C)
    parameters:
      thresh: 0 degC
  CFD:
    base: consecutive_frost_days
    cf_attrs:
      long_name: Maximum number of consecutive frost days (TN<0°C)
    parameters:
      thresh: 0 degC
  GSL:
    base: growing_season_length
    cf_attrs:
      long_name: Growing season length
    parameters:
      thresh: 5 degC
      window: 6
  ID:
    base: ice_days
    cf_attrs:
      long_name: Ice days (TX<0°C)
    parameters:
      thresh: 0 degC
  HD17:
    base: heating_degree_days
    cf_attrs:
      long_name: Heating degree days (sum of17°C - TG)
    parameters:
      thresh: 17 degC
  CDD:
    base: cdd
    cf_attrs:
      long_name: Maximum number of consecutive dry days (RR<1 mm)
    parameters:
      thresh: 1 mm/day
  CWD:
    base: cwd
    cf_attrs:
      long_name: Maximum number of consecutive wet days (RR≥1 mm)
    parameters:
      thresh: 1 mm/day
  RR:
    base: prcptot
    cf_attrs:
      long_name: Precipitation sum
  PRCPTOT:
    base: wet_prcptot
    cf_attrs:
      long_name: Precipitation sum over wet days
    parameters:
      thresh: 1 mm/day
  SDII:
    base: sdii
    parameters:
      thresh: 1 mm/day
  ETR:
    base: etr
    cf_attrs:
      long_name: Intra-period extreme temperature range
  DTR:
    base: dtr
    cf_attrs:
      long_name: Mean of diurnal temperature range
  vDTR:
    base: dtrvar
    cf_attrs:
      long_name: Mean absolute day-to-day difference in DTR
  RR1:
    base: wetdays
    cf_attrs:
      long_name: Wet days (RR≥1 mm)
    parameters:
      thresh: 1 mm/day
  R10mm:
    base: wetdays
    cf_attrs:
      long_name: Heavy precipitation days (precipitation≥10 mm)
    parameters:
      thresh: 10 mm/day
  R20mm:
    base: wetdays
    cf_attrs:
      long_name: Very heavy precipitation days (precipitation≥20 mm)
    parameters:
      thresh: 20 mm/day
  RX1day:
    base: rx1day
    cf_attrs:
      long_name: Highest 1-day precipitation amount
  RX5day:
    base: max_n_day_precipitation_amount
    cf_attrs:
      long_name: Highest 5-day precipitation amount
    parameters:
      window: 5
  R75p:
    base: days_over_precip_thresh
    parameters:
      thresh: 1 mm/day
      pr_per:
        description: 75th percentile of wet day precipitation flux.

  R95p:
    base: days_over_precip_thresh
    parameters:
      thresh: 1 mm/day
      pr_per:
        description: 95th percentile of wet day precipitation flux.
  R99p:
    base: days_over_precip_thresh
    parameters:
      thresh: 1 mm/day
      pr_per:
        description: 99th percentile of wet day precipitation flux.
  R75pTOT:
    base: fraction_over_precip_thresh
    cf_attrs:
      long_name: Precipitation fraction due to moderate wet days (>75th percentile)
    parameters:
      thresh: 1 mm/day
      pr_per:
        description: 75th percentile of wet day precipitation flux.
  R95pTOT:
    base: fraction_over_precip_thresh
    cf_attrs:
      long_name: Precipitation fraction due to very wet days (>95th percentile)
    parameters:
      thresh: 1 mm/day
      pr_per:
        description: 95th percentile of wet day precipitation flux.
  R99pTOT:
    base: fraction_over_precip_thresh
    cf_attrs:
      long_name: Precipitation fraction due to extremely wet days (>99th percentile)
    parameters:
      thresh: 1 mm/day
      pr_per:
        description: 99th percentile of wet day precipitation flux.
  SD:
    realm: land
    base: snow_depth
    cf_attrs:
      long_name: Mean of daily snow depth
  SD1:
    realm: land
    base: snd_season_length
    cf_attrs:
      long_name: Snow days (SD≥1 cm)
    parameters:
      thresh: 1 cm
  SD5cm:
    realm: land
    base: snd_season_length
    cf_attrs:
      long_name: Snow days (SD≥5 cm)
    parameters:
      thresh: 5 cm
  SD50cm:
    realm: land
    base: snd_season_length
    cf_attrs:
      long_name: Snow days (SD≥50 cm)
    parameters:
      thresh: 50 cm
  CD:
    base: cold_and_dry_days
    cf_attrs:
      long_name: Cold and dry days
    parameters:
      tas_per:
        description: Daily 25th percentile of temperature.
      pr_per:
        description: Daily 25th percentile of wet day precipitation flux.
  WD:
    base: warm_and_dry_days
    cf_attrs:
      long_name: Warm and dry days
    parameters:
      tas_per:
        description: Daily 75th percentile of temperature.
      pr_per:
        description: Daily 25th percentile of wet day precipitation flux.
  WW:
    base: warm_and_wet_days
    cf_attrs:
      long_name: Warm and wet days
    parameters:
      tas_per:
        description: Daily 75th percentile of temperature.
      pr_per:
        description: Daily 75th percentile of wet day precipitation flux.
  CW:
    base: cold_and_wet_days
    cf_attrs:
      long_name: cold and wet days
    parameters:
      tas_per:
        description: Daily 25th percentile of temperature.
      pr_per:
        description: Daily 75th percentile of wet day precipitation flux.
