Processes

xclim Indicators

class finch.processes.xclim.cddProcess

cdd Maximum consecutive dry days (Precip < {thresh}) (v0.1)

Return the maximum number of consecutive days within the period where precipitation is below a certain threshold.

Parameters
  • pr (application/x-netcdf) – NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • thresh (string, optional) – threshold

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.consecutive_frost_daysProcess

consecutive_frost_days Maximum number of consecutive days with Tmin < 0C (v0.1)

Resample the daily minimum temperature series by computing the maximum number of days below the freezing point over each period.

Parameters
  • tasmin (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.cwdProcess

cwd Maximum consecutive wet days (Precip >= {thresh}) (v0.1)

Returns the maximum number of consecutive wet days.

Parameters
  • pr (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • thresh (string, optional) – threshold

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.dlyfrzthwProcess

dlyfrzthw daily freezethaw cycles (v0.1)

The number of days where Tmax > thresh_tasmax and Tmin <= thresh_tasmin.

Parameters
  • tasmax (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • tasmin (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • thresh_tasmax (string, optional) – threshold

  • thresh_tasmin (string, optional) – threshold

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.dtrProcess

dtr Mean Diurnal Temperature Range (v0.1)

The mean difference between the daily maximum temperature and the daily minimum temperature.

Parameters
  • tasmax (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • tasmin (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.dtrvarProcess

dtrvar Mean Diurnal Temperature Range Variability (v0.1)

Mean absolute day-to-day variation in daily temperature range.

Parameters
  • tasmax (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • tasmin (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.etrProcess

etr Intra-period Extreme Temperature Range (v0.1)

The maximum of max temperature (TXx) minus the minimum of min temperature (TNn) for the given time period.

Parameters
  • tasmax (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • tasmin (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.frost_daysProcess

frost_days Number of Frost Days (Tmin < 0C) (v0.1)

Number of days where daily minimum temperatures are below 0.

Parameters
  • tasmin (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.heat_wave_frequencyProcess

heat_wave_frequency Number of heat wave events (Tmin > {thresh_tasmin}and Tmax > {thresh_tasmax} for >= {window} days) (v0.1)

Number of heat waves over a given period. A heat wave is defined as an event where the minimum and maximum daily temperature both exceeds specific thresholds over a minimum number of days.

Parameters
  • tasmin (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • tasmax (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • thresh_tasmin (string, optional) – threshold

  • thresh_tasmax (string, optional) – threshold

  • window (integer, optional) – window

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.heat_wave_max_lengthProcess

heat_wave_max_length Maximum length of heat wave events (Tmin > {thresh_tasmin}and Tmax > {thresh_tasmax} for >= {window} days) (v0.1)

Parameters
  • tasmin (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • tasmax (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • thresh_tasmin (string, optional) – threshold

  • thresh_tasmax (string, optional) – threshold

  • window (integer, optional) – window

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.ice_daysProcess

ice_days Number of Ice Days (Tmax < 0) (v0.1)

Number of days where daily maximum temperatures are below 0.

Parameters
  • tasmax (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.prcptotProcess

prcptot Total precipitation (v0.1)

Resample the original daily mean precipitation flux and accumulate over each period.

Parameters
  • pr (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.rain_frzgrProcess

rain_frzgr Number of rain on frozen ground days (v0.1)

Number of days with rain above a threshold after a series of seven days below freezing temperature. Precipitation is assumed to be rain when the temperature is above 0.

Parameters
  • pr (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • tas (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • thresh (string, optional) – threshold

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.rx1dayProcess

rx1day maximum 1-day total precipitation (v0.1)

Resample the original daily total precipitation temperature series by taking the max over each period.

Parameters
  • pr (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.sdiiProcess

sdii Average precipitation during Wet Days (SDII) (v0.1)

Return the average precipitation over wet days.

Parameters
  • pr (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • thresh (string, optional) – threshold

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.tg10pProcess

tg10p Number of days when Tmean < 10th percentile (v0.1)

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

Parameters
  • tas (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • t10 (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.tg90pProcess

tg90p Number of days when Tmean > 90th percentile (v0.1)

Number of days with daily mean temperature over the 90th percentile.

Parameters
  • tas (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • t90 (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.tg_meanProcess

tg_mean Mean daily mean temperature (v0.1)

Resample the original daily mean temperature series by taking the mean over each period.

Parameters
  • tas (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.tn10pProcess

tn10p Number of days when Tmin < 10th percentile (v0.1)

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

Parameters
  • tasmin (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • t10 (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.tn90pProcess

tn90p Number of days when Tmin > 90th percentile (v0.1)

Number of days with daily minimum temperature over the 90th percentile.

Parameters
  • tasmin (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • t90 (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.tn_maxProcess

tn_max Maximum daily minimum temperature (v0.1)

The maximum of daily minimum temperature.

Parameters
  • tasmin (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.tn_meanProcess

tn_mean Mean daily minimum temperature (v0.1)

Mean of daily minimum temperature.

Parameters
  • tasmin (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.tn_minProcess

tn_min Minimum daily minimum temperature (v0.1)

Minimum of daily minimum temperature.

Parameters
  • tasmin (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.tx10pProcess

tx10p Number of days when Tmax < 10th percentile (v0.1)

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

Parameters
  • tasmax (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • t10 (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.tx90pProcess

tx90p Number of days when Tmax > 90th percentile (v0.1)

Number of days with daily maximum temperature over the 90th percentile.

Parameters
  • tasmax (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • t90 (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.tx_maxProcess

tx_max Maximum daily maximum temperature (v0.1)

The maximum value of daily maximum temperature.

Parameters
  • tasmax (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.tx_meanProcess

tx_mean Mean daily maximum temperature (v0.1)

The mean of daily maximum temperature.

Parameters
  • tasmax (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.

class finch.processes.xclim.tx_minProcess

tx_min Minimum daily maximum temperature (v0.1)

The minimum of daily maximum temperature.

Parameters
  • tasmax (application/x-netcdf) –

    NetCDF Files or archive (tar/zip) containing netCDF files. (Info)

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency

Returns

  • output_netcdf (application/x-netcdf) – The indicator values computed on the original input grid.

  • output_log (text/plain) – Collected logs during process run.