Processes

This page documents the processes available with the default configuration of finch. The list of ensemble processes can be different, depending on the configuration. See Structure of the dataset configuration file.

Indicators Processes

class finch.processes.virtual.indicators.base_flow_index_Indicator_Process

base_flow_index Base flow index. (v0.1)

Return the base flow index, defined as the minimum 7-day average flow divided by the mean flow.

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

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._streamflow.BASE_FLOW_INDEX object>
class finch.processes.virtual.indicators.biologically_effective_degree_days_Indicator_Process

biologically_effective_degree_days Biologically effective growing degree days. (v0.1)

Growing-degree days with a base of 10degC and an upper limit of 19degC and adjusted for latitudes between 40degN and 50degN for April to October (Northern Hemisphere; October to April in Southern Hemisphere). A temperature range adjustment also promotes small and large swings in daily temperature range. Used as a heat-summation metric in viticulture agroclimatology.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • lat (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh_tasmin (string, optional) – The minimum temperature threshold.

  • low_dtr (string, optional) – The lower bound for daily temperature range adjustment (default: 10°C).

  • high_dtr (string, optional) – The higher bound for daily temperature range adjustment (default: 13°C).

  • max_daily_degree_days (string, optional) – The maximum amount of biologically effective degrees days that can be summed daily.

  • start_date (string, optional) – The hemisphere-based start date to consider (north = April, south = October).

  • end_date (string, optional) – The hemisphere-based start date to consider (north = October, south = April). This date is non-inclusive.

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency (default: “YS”; For Southern Hemisphere, should be “AS-JUL”).

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.BIOLOGICALLY_EFFECTIVE_DEGREE_DAYS object>
class finch.processes.virtual.indicators.blowing_snow_Indicator_Process

blowing_snow Days with blowing snow events. (v0.1)

Number of days when both snowfall over the last days and daily wind speeds are above respective thresholds.

Parameters
  • snd (application/x-netcdf, application/x-ogc-dods) –

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

  • sfcWind (application/x-netcdf, application/x-ogc-dods) –

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

  • snd_thresh (string, optional) – Threshold on net snowfall accumulation over the last window days.

  • sfcWind_thresh (string, optional) – Wind speed threshold.

  • window (integer, optional) – Period over which snow is accumulated before comparing against threshold.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._snow.BLOWING_SNOW object>
class finch.processes.virtual.indicators.calm_days_Indicator_Process

calm_days Calm days. (v0.1)

The number of days with average near-surface wind speed below threshold.

Parameters
  • sfcWind (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold average near-surface wind speed on which to base evaluation.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._wind.CALM_DAYS object>
class finch.processes.virtual.indicators.cdd_Indicator_Process

cdd Maximum number of consecutive dry days. (v0.1)

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

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • thresh (string, optional) – Threshold precipitation on which to base evaluation.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.CDD object>
class finch.processes.virtual.indicators.cffwis_Indicator_Process

cffwis Canadian Fire Weather Index System indices. (v0.1)

Computes the 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 and the Fire Weather Index.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • sfcWind (application/x-netcdf, application/x-ogc-dods) –

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

  • hurs (application/x-netcdf, application/x-ogc-dods) –

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

  • lat (application/x-netcdf, application/x-ogc-dods) –

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

  • snd (application/x-netcdf, application/x-ogc-dods) –

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

  • ffmc0 (application/x-netcdf, application/x-ogc-dods) –

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

  • dmc0 (application/x-netcdf, application/x-ogc-dods) –

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

  • dc0 (application/x-netcdf, application/x-ogc-dods) –

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

  • season_mask (application/x-netcdf, application/x-ogc-dods) –

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

  • season_method ({'LA08', 'WF93', 'GFWED', 'None'}, optional) – How to compute the start-up and shutdown of the fire season. If “None”, no start-ups or shutdowns are computed, similar to the R fire function. Ignored if season_mask is given.

  • overwintering (boolean, optional) – Whether to activate DC overwintering or not. If True, either season_method or season_mask must be given.

  • dry_start ({'CFS', 'GFWED', 'None'}, optional) – Whether to activate the DC and DMC “dry start” mechanism or not, see fire_weather_ufunc().

  • initial_start_up (boolean, optional) – If True (default), gridpoints where the fire season is active on the first timestep go through a start_up phase for that time step. Otherwise, previous codes must be given as a continuing fire season is assumed for those points. Any other keyword parameters as defined in fire_weather_ufunc() and in default_params.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.CFFWIS object>
class finch.processes.virtual.indicators.cold_and_dry_days_Indicator_Process

cold_and_dry_days Cold and dry days (v0.1)

Returns the total number of days when “Cold” and “Dry” conditions coincide.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • tas_per (application/x-netcdf, application/x-ogc-dods) –

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

  • pr_per (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.COLD_AND_DRY_DAYS object>
class finch.processes.virtual.indicators.cold_and_wet_days_Indicator_Process

cold_and_wet_days cold and wet days (v0.1)

Returns the total number of days when “cold” and “wet” conditions coincide.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • tas_per (application/x-netcdf, application/x-ogc-dods) –

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

  • pr_per (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.COLD_AND_WET_DAYS object>
class finch.processes.virtual.indicators.cold_spell_days_Indicator_Process

cold_spell_days Cold spell days. (v0.1)

The number of days that are part of cold spell events, defined as a sequence of consecutive days with mean daily temperature below a threshold in degC.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature below which a cold spell begins.

  • window (integer, optional) – Minimum number of days with temperature below threshold to qualify as a cold spell.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.COLD_SPELL_DAYS object>
class finch.processes.virtual.indicators.cold_spell_duration_index_Indicator_Process

cold_spell_duration_index Cold spell duration index. (v0.1)

Number of days with at least window consecutive days when the daily minimum temperature is below the tasmin_per percentiles.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmin_per (application/x-netcdf, application/x-ogc-dods) –

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

  • window (integer, optional) – Minimum number of days with temperature below threshold to qualify as a cold spell.

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'<', 'le', '<=', 'lt'}, optional) – Comparison operation. Default: “<”.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.COLD_SPELL_DURATION_INDEX object>
class finch.processes.virtual.indicators.cold_spell_frequency_Indicator_Process

cold_spell_frequency Cold spell frequency. (v0.1)

The number of cold spell events, defined as a sequence of consecutive days with mean daily temperature below a threshold.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature below which a cold spell begins.

  • window (integer, optional) – Minimum number of days with temperature below threshold to qualify as a cold spell.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.COLD_SPELL_FREQUENCY object>
class finch.processes.virtual.indicators.consecutive_frost_days_Indicator_Process

consecutive_frost_days Maximum number of consecutive frost days (Tn < 0). (v0.1)

The maximum number of consecutive days within the period where the temperature is under a certain threshold (default: 0degC). WARNING: The default freq value is valid for the northern hemisphere.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.CONSECUTIVE_FROST_DAYS object>
class finch.processes.virtual.indicators.consecutive_frost_free_days_Indicator_Process

consecutive_frost_free_days Maximum number of consecutive frost free days (Tn >= 0). (v0.1)

Return the maximum number of consecutive days within the period where the minimum temperature is above or equal to a certain threshold.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.CONSECUTIVE_FROST_FREE_DAYS object>
class finch.processes.virtual.indicators.continuous_snow_cover_end_Indicator_Process

continuous_snow_cover_end End date of continuous snow cover. (v0.1)

First day after the start of the continuous snow cover when snow depth is below threshold for at least window consecutive days.

Parameters
  • snd (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold snow thickness.

  • window (integer, optional) – Minimum number of days with snow depth below threshold.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._snow.CONTINUOUS_SNOW_COVER_END object>
class finch.processes.virtual.indicators.continuous_snow_cover_start_Indicator_Process

continuous_snow_cover_start Start date of continuous snow cover. (v0.1)

Day of year when snow depth is above or equal threshold for at least window consecutive days.

Parameters
  • snd (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold snow thickness.

  • window (integer, optional) – Minimum number of days with snow depth above or equal to threshold.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._snow.CONTINUOUS_SNOW_COVER_START object>
class finch.processes.virtual.indicators.cool_night_index_Indicator_Process

cool_night_index Cool Night Index. (v0.1)

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

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • lat (application/x-netcdf, application/x-ogc-dods) –

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

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.COOL_NIGHT_INDEX object>
class finch.processes.virtual.indicators.cooling_degree_days_Indicator_Process

cooling_degree_days Cooling degree days. (v0.1)

Sum of degree days above the temperature threshold at which spaces are cooled.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Temperature threshold above which air is cooled.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.COOLING_DEGREE_DAYS object>
class finch.processes.virtual.indicators.corn_heat_units_Indicator_Process

corn_heat_units Corn heat units. (v0.1)

Temperature-based index used to estimate the development of corn crops. Formula adapted from Bootsma et al. [1999].

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh_tasmin (string, optional) – The minimum temperature threshold needed for corn growth.

  • thresh_tasmax (string, optional) – The maximum temperature threshold needed for corn growth.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._conversion.CORN_HEAT_UNITS object>
class finch.processes.virtual.indicators.cwd_Indicator_Process

cwd Consecutive wet days. (v0.1)

Returns the maximum number of consecutive wet days.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • thresh (string, optional) – Threshold precipitation on which to base evaluation.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.CWD object>
class finch.processes.virtual.indicators.days_over_precip_doy_thresh_Indicator_Process

days_over_precip_doy_thresh Number of wet days with daily precipitation over a given percentile. (v0.1)

Number of days over period where the precipitation is above a threshold defining wet days and above a given percentile for that day.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • pr_per (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Precipitation value over which a day is considered wet.

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.DAYS_OVER_PRECIP_DOY_THRESH object>
class finch.processes.virtual.indicators.days_over_precip_thresh_Indicator_Process

days_over_precip_thresh Number of wet days with daily precipitation over a given percentile. (v0.1)

Number of days over period where the precipitation is above a threshold defining wet days and above a given percentile for that day.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • pr_per (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Precipitation value over which a day is considered wet.

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.DAYS_OVER_PRECIP_THRESH object>
class finch.processes.virtual.indicators.days_with_snow_Indicator_Process

days_with_snow Days with snowfall (v0.1)

Return the number of days where snowfall is within low and high thresholds.

Parameters
  • prsn (application/x-netcdf, application/x-ogc-dods) –

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

  • low (string, optional) – Minimum threshold solid precipitation flux.

  • high (string, optional) – Maximum threshold solid precipitation flux.

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency defining the periods as defined in https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#resampling.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.DAYS_WITH_SNOW object>
class finch.processes.virtual.indicators.degree_days_exceedance_date_Indicator_Process

degree_days_exceedance_date Degree-days exceedance date. (v0.1)

Day of year when the sum of degree days exceeds a threshold. Degree days are computed above or below a given temperature threshold.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base degree-days evaluation.

  • sum_thresh (string, optional) – Threshold of the degree days sum.

  • op ({'lt', 'ge', '>', 'gt', 'le', '<', '>=', '<='}, optional) – If equivalent to ‘>’, degree days are computed as tas - thresh and if equivalent to ‘<’, they are computed as thresh - tas.

  • after_date (string, optional) – Date at which to start the cumulative sum. In “mm-dd” format, defaults to the start of the sampling period.

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency. If after_date is given, freq should be annual.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.DEGREE_DAYS_EXCEEDANCE_DATE object>
class finch.processes.virtual.indicators.df_Indicator_Process

df Griffiths drought factor based on the soil moisture deficit. (v0.1)

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 Finkele et al. [2006].

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • smd (application/x-netcdf, application/x-ogc-dods) –

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

  • limiting_func ({'discrete', 'xlim'}, optional) – How to limit the values of the drought factor. If “xlim” (default), use equation (14) in Finkele et al. [2006]. If “discrete”, use equation Eq (13) in Finkele et al. [2006], but with the lower limit of each category bound adjusted to match the upper limit of the previous bound.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.DF object>
class finch.processes.virtual.indicators.dlyfrzthw_Indicator_Process

dlyfrzthw Statistics of consecutive diurnal temperature swing events. (v0.1)

A diurnal swing of max and min temperature event is when Tmax > thresh_tasmax and Tmin <= thresh_tasmin. This indice finds all days that constitute these events and computes statistics over the length and frequency of these events.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh_tasmin (string, optional) – The temperature threshold needed to trigger a freeze event.

  • thresh_tasmax (string, optional) – The temperature threshold needed to trigger a thaw event.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.DLYFRZTHW object>
class finch.processes.virtual.indicators.doy_qmax_Indicator_Process

doy_qmax Day of year of the maximum. (v0.1)

Parameters
  • da (application/x-netcdf, application/x-ogc-dods) –

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

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency defining the periods as defined in https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#resampling.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._streamflow.DOY_QMAX object>
class finch.processes.virtual.indicators.doy_qmin_Indicator_Process

doy_qmin Day of year of the minimum. (v0.1)

Parameters
  • da (application/x-netcdf, application/x-ogc-dods) –

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

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency defining the periods as defined in https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#resampling.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._streamflow.DOY_QMIN object>
class finch.processes.virtual.indicators.dry_days_Indicator_Process

dry_days Dry days. (v0.1)

The number of days with daily precipitation below threshold.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.DRY_DAYS object>
class finch.processes.virtual.indicators.dry_spell_frequency_Indicator_Process

dry_spell_frequency Return the number of dry periods of n days and more. (v0.1)

Periods during which the accumulated or maximal daily precipitation amount on a window of n days is under threshold.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • thresh (string, optional) – Precipitation amount under which a period is considered dry. The value against which the threshold is compared depends on op .

  • window (integer, optional) – Minimum length of the spells.

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

  • op ({'max', 'sum'}, optional) – Operation to perform on the window. Default is “sum”, which checks that the sum of accumulated precipitation over the whole window is less than the threshold. “max” checks that the maximal daily precipitation amount within the window is less than the threshold. This is the same as verifying that each individual day is below the threshold.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.DRY_SPELL_FREQUENCY object>
class finch.processes.virtual.indicators.dry_spell_total_length_Indicator_Process

dry_spell_total_length Total length of dry spells. (v0.1)

Total number of days in dry periods of a minimum length, during which the maximum or accumulated precipitation within a window of the same length is under a threshold.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • thresh (string, optional) – Accumulated precipitation value under which a period is considered dry.

  • window (integer, optional) – Number of days when the maximum or accumulated precipitation is under threshold.

  • op ({'max', 'sum'}, optional) – Reduce operation.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.DRY_SPELL_TOTAL_LENGTH object>
class finch.processes.virtual.indicators.dtr_Indicator_Process

dtr Mean of daily temperature range. (v0.1)

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

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.DTR object>
class finch.processes.virtual.indicators.dtrmax_Indicator_Process

dtrmax Maximum of daily temperature range. (v0.1)

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

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.DTRMAX object>
class finch.processes.virtual.indicators.dtrvar_Indicator_Process

dtrvar Mean absolute day-to-day variation in daily temperature range. (v0.1)

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

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.DTRVAR object>
class finch.processes.virtual.indicators.effective_growing_degree_days_Indicator_Process

effective_growing_degree_days Effective growing degree days. (v0.1)

Growing degree days based on a dynamic start and end of the growing season, as defined in [Bootsma and Gameda and D.W. McKenney, 2005].

Parameters
  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – The minimum temperature threshold.

  • method ({'bootsma', 'qian'}, optional) – The window method used to determine the temperature-based start date. For “bootsma”, the start date is defined as 10 days after the average temperature exceeds a threshold (5 degC). For “qian”, the start date is based on a weighted 5-day rolling average, based on qian_weighted_mean_average().

  • after_date (string, optional) – Date of the year after which to look for the first frost event. Should have the format ‘%m-%d’.

  • dim (string, optional) – Time dimension.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.EFFECTIVE_GROWING_DEGREE_DAYS object>
class finch.processes.virtual.indicators.etr_Indicator_Process

etr Extreme intra-period temperature range. (v0.1)

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

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.ETR object>
class finch.processes.virtual.indicators.ffdi_Indicator_Process

ffdi McArthur forest fire danger index (FFDI) Mark 5. (v0.1)

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

Parameters
  • drought_factor (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • hurs (application/x-netcdf, application/x-ogc-dods) –

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

  • sfcWind (application/x-netcdf, application/x-ogc-dods) –

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.FFDI object>
class finch.processes.virtual.indicators.fire_season_Indicator_Process

fire_season Fire season mask. (v0.1)

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

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • snd (application/x-netcdf, application/x-ogc-dods) –

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

  • method ({'LA08', 'WF93', 'GFWED'}, optional) – Which method to use. “LA08” and “GFWED” need the snow depth.

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – If given only the longest fire season for each period defined by this frequency, Every “seasons” are returned if None, including the short shoulder seasons.

  • temp_start_thresh (string, optional) – Minimal temperature needed to start the season.

  • temp_end_thresh (string, optional) – Maximal temperature needed to end the season.

  • temp_condition_days (integer, optional) – Number of days with temperature above or below the thresholds to trigger a start or an end of the fire season.

  • snow_condition_days (integer, optional) – Parameters for the fire season determination. See fire_season(). Temperature is in degC, snow in m. The snow_thresh parameters is also used when dry_start is set to “GFWED”.

  • snow_thresh (string, optional) – Minimal snow depth level to end a fire season, only used with method “LA08”.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.FIRE_SEASON object>
class finch.processes.virtual.indicators.first_day_above_Indicator_Process

first_day_above First day of temperatures superior to a threshold temperature. (v0.1)

Returns first day of period where a temperature is superior to a threshold over a given number of days, limited to a starting calendar date.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

  • after_date (string, optional) – Date of the year after which to look for the first event. Should have the format ‘%m-%d’.

  • window (integer, optional) – Minimum number of days with temperature above threshold needed for evaluation.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.FIRST_DAY_ABOVE object>
class finch.processes.virtual.indicators.first_day_below_Indicator_Process

first_day_below First day of temperatures inferior to a threshold temperature. (v0.1)

Returns first day of period where a temperature is inferior to a threshold over a given number of days, limited to a starting calendar date.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

  • after_date (string, optional) – Date of the year after which to look for the first frost event. Should have the format ‘%m-%d’.

  • window (integer, optional) – Minimum number of days with temperature below threshold needed for evaluation.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.FIRST_DAY_BELOW object>
class finch.processes.virtual.indicators.first_snowfall_Indicator_Process

first_snowfall First day with solid precipitation above a threshold. (v0.1)

Returns the first day of a period where the solid precipitation exceeds a threshold.

Parameters
  • prsn (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold precipitation flux on which to base evaluation.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.FIRST_SNOWFALL object>
class finch.processes.virtual.indicators.fit_Indicator_Process

fit Distribution parameters fitted over the time dimension. (v0.1)

Parameters
  • da (application/x-netcdf, application/x-ogc-dods) –

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

  • dist (string, optional) – Name of the univariate distribution, such as beta, expon, genextreme, gamma, gumbel_r, lognorm, norm (see scipy.stats for full list). If the PWM method is used, only the following distributions are currently supported: ‘expon’, ‘gamma’, ‘genextreme’, ‘genpareto’, ‘gumbel_r’, ‘pearson3’, ‘weibull_min’.

  • method ({'PWM', 'ML'}, optional) – Fitting method, either maximum likelihood (ML) or probability weighted moments (PWM), also called L-Moments. The PWM method is usually more robust to outliers.

  • dim (string, optional) – The dimension upon which to perform the indexing (default: “time”). Other arguments passed directly to _fitstart() and to the distribution’s fit.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._streamflow.FIT object>
class finch.processes.virtual.indicators.fraction_over_precip_doy_thresh_Indicator_Process

fraction_over_precip_doy_thresh Fraction of precipitation due to wet days with daily precipitation over a given percentile. (v0.1)

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

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • pr_per (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Precipitation value over which a day is considered wet.

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.FRACTION_OVER_PRECIP_DOY_THRESH object>
class finch.processes.virtual.indicators.fraction_over_precip_thresh_Indicator_Process

fraction_over_precip_thresh Fraction of precipitation due to wet days with daily precipitation over a given percentile. (v0.1)

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

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • pr_per (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Precipitation value over which a day is considered wet.

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.FRACTION_OVER_PRECIP_THRESH object>
class finch.processes.virtual.indicators.freezethaw_spell_frequency_Indicator_Process

freezethaw_spell_frequency Frequency of freeze-thaw spells (v0.1)

A diurnal swing of max and min temperature event is when Tmax > thresh_tasmax and Tmin <= thresh_tasmin. This indice finds all days that constitute these events and computes statistics over the length and frequency of these events.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh_tasmin (string, optional) – The temperature threshold needed to trigger a freeze event.

  • thresh_tasmax (string, optional) – The temperature threshold needed to trigger a thaw event.

  • window (integer, optional) – The minimal length of spells to be included in the statistics.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.FREEZETHAW_SPELL_FREQUENCY object>
class finch.processes.virtual.indicators.freezethaw_spell_max_length_Indicator_Process

freezethaw_spell_max_length Maximal length of freeze-thaw spells. (v0.1)

A diurnal swing of max and min temperature event is when Tmax > thresh_tasmax and Tmin <= thresh_tasmin. This indice finds all days that constitute these events and computes statistics over the length and frequency of these events.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh_tasmin (string, optional) – The temperature threshold needed to trigger a freeze event.

  • thresh_tasmax (string, optional) – The temperature threshold needed to trigger a thaw event.

  • window (integer, optional) – The minimal length of spells to be included in the statistics.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.FREEZETHAW_SPELL_MAX_LENGTH object>
class finch.processes.virtual.indicators.freezethaw_spell_mean_length_Indicator_Process

freezethaw_spell_mean_length Averge length of freeze-thaw spells. (v0.1)

A diurnal swing of max and min temperature event is when Tmax > thresh_tasmax and Tmin <= thresh_tasmin. This indice finds all days that constitute these events and computes statistics over the length and frequency of these events.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh_tasmin (string, optional) – The temperature threshold needed to trigger a freeze event.

  • thresh_tasmax (string, optional) – The temperature threshold needed to trigger a thaw event.

  • window (integer, optional) – The minimal length of spells to be included in the statistics.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.FREEZETHAW_SPELL_MEAN_LENGTH object>
class finch.processes.virtual.indicators.freezing_degree_days_Indicator_Process

freezing_degree_days Heating degree days. (v0.1)

Sum of degree days below the temperature threshold at which spaces are heated.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.FREEZING_DEGREE_DAYS object>
class finch.processes.virtual.indicators.freq_analysis_Indicator_Process

freq_analysis Flow values for given return periods. (v0.1)

Parameters
  • da (application/x-netcdf, application/x-ogc-dods) –

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

  • mode ({'max', 'min'}, optional) – Whether we are looking for a probability of exceedance (high) or a probability of non-exceedance (low).

  • t (integer, optional) – Return period. The period depends on the resolution of the input data. If the input array’s resolution is yearly, then the return period is in years.

  • dist (string, optional) – Name of the univariate distribution, such as beta, expon, genextreme, gamma, gumbel_r, lognorm, norm

  • window (integer, optional) – Averaging window length (days).

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency. If None, the frequency is assumed to be ‘YS’ unless the indexer is season=’DJF’, in which case freq would be set to AS-DEC.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._streamflow.FREQ_ANALYSIS object>
class finch.processes.virtual.indicators.freshet_start_Indicator_Process

freshet_start First day consistently exceeding threshold temperature. (v0.1)

Returns first day of period where a temperature threshold is exceeded over a given number of days.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

  • window (integer, optional) – Minimum number of days with temperature above threshold needed for evaluation.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.FRESHET_START object>
class finch.processes.virtual.indicators.frost_days_Indicator_Process

frost_days Frost days index. (v0.1)

Number of days where daily minimum temperatures are below a threshold temperature.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Freezing temperature.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.FROST_DAYS object>
class finch.processes.virtual.indicators.frost_free_season_end_Indicator_Process

frost_free_season_end End of the frost free season. (v0.1)

Day of the year of the start of a sequence of days with minimum temperatures consistently below a threshold, after a period with minimum temperatures consistently above the same threshold.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

  • mid_date (string, optional) – Date of the year after which to look for the end of the season. Should have the format ‘%m-%d’.

  • window (integer, optional) – Minimum number of days with temperature below threshold needed for evaluation.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.FROST_FREE_SEASON_END object>
class finch.processes.virtual.indicators.frost_free_season_length_Indicator_Process

frost_free_season_length Frost free season length. (v0.1)

The number of days between the first occurrence of at least N (def: 5) consecutive days with minimum daily temperature above a threshold (default: 0) and the first occurrence of at least N (def 5) consecutive days with minimum daily temperature below the same threshold. A mid-date can be given to limit the earliest day the end of season can take.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • window (integer, optional) – Minimum number of days with temperature above threshold to mark the beginning and end of frost free season.

  • mid_date (string, optional) – Date the must be included in the season. It is the earliest the end of the season can be. If None, there is no limit.

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.FROST_FREE_SEASON_LENGTH object>
class finch.processes.virtual.indicators.frost_free_season_start_Indicator_Process

frost_free_season_start Start of the frost free season. (v0.1)

Day of the year of the start of a sequence of days with minimum temperatures consistently above or equal to a threshold, after a period with minimum temperatures consistently above the same threshold.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

  • window (integer, optional) – Minimum number of days with temperature above threshold needed for evaluation.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.FROST_FREE_SEASON_START object>
class finch.processes.virtual.indicators.frost_season_length_Indicator_Process

frost_season_length Frost season length. (v0.1)

The number of days between the first occurrence of at least N (def: 5) consecutive days with minimum daily temperature under a threshold (default: 0) and the first occurrence of at least N (def 5) consecutive days with minimum daily temperature above the same threshold. A mid-date can be given to limit the earliest day the end of season can take.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • window (integer, optional) – Minimum number of days with temperature below threshold to mark the beginning and end of frost season.

  • mid_date (string, optional) – Date the must be included in the season. It is the earliest the end of the season can be. If None, there is no limit.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.FROST_SEASON_LENGTH object>
class finch.processes.virtual.indicators.growing_degree_days_Indicator_Process

growing_degree_days Growing degree-days over threshold temperature value. (v0.1)

The sum of degree-days over the threshold temperature.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.GROWING_DEGREE_DAYS object>
class finch.processes.virtual.indicators.growing_season_end_Indicator_Process

growing_season_end End of the growing season. (v0.1)

Day of the year of the start of a sequence of days with mean temperatures consistently below a threshold, after a period with mean temperatures consistently above the same threshold.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

  • mid_date (string, optional) – Date of the year after which to look for the end of the season. Should have the format ‘%m-%d’.

  • window (integer, optional) – Minimum number of days with temperature below threshold needed for evaluation.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.GROWING_SEASON_END object>
class finch.processes.virtual.indicators.growing_season_length_Indicator_Process

growing_season_length Growing season length. (v0.1)

The number of days between the first occurrence of at least six consecutive days with mean daily temperature over a threshold (default: 5) and the first occurrence of at least six consecutive days with mean daily temperature below the same threshold after a certain date. (Usually July 1st in the northern emisphere and January 1st in the southern hemisphere.)

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

  • window (integer, optional) – Minimum number of days with temperature above threshold to mark the beginning and end of growing season.

  • mid_date (string, optional) – Date of the year after which to look for the end of the season. Should have the format ‘%m-%d’.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.GROWING_SEASON_LENGTH object>
class finch.processes.virtual.indicators.growing_season_start_Indicator_Process

growing_season_start Start of the growing season. (v0.1)

Day of the year of the start of a sequence of days with mean temperatures consistently above or equal to a threshold, after a period with mean temperatures consistently above the same threshold.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

  • window (integer, optional) – Minimum number of days with temperature above threshold needed for evaluation.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.GROWING_SEASON_START object>
class finch.processes.virtual.indicators.heat_index_Indicator_Process

heat_index Heat index. (v0.1)

Perceived temperature after relative humidity is taken into account [Blazejczyk et al., 2012]. The index is only valid for temperatures above 20degC.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • hurs (application/x-netcdf, application/x-ogc-dods) –

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._conversion.HEAT_INDEX object>
class finch.processes.virtual.indicators.heat_wave_frequency_Indicator_Process

heat_wave_frequency Heat wave frequency. (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 exceed specific thresholds over a minimum number of days.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh_tasmin (string, optional) – The minimum temperature threshold needed to trigger a heatwave event.

  • thresh_tasmax (string, optional) – The maximum temperature threshold needed to trigger a heatwave event.

  • window (integer, optional) – Minimum number of days with temperatures above thresholds to qualify as a heatwave.

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

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.HEAT_WAVE_FREQUENCY object>
class finch.processes.virtual.indicators.heat_wave_index_Indicator_Process

heat_wave_index Heat wave index. (v0.1)

Number of days that are part of a heatwave, defined as five or more consecutive days over 25.

Parameters
  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to designate a heatwave.

  • window (integer, optional) – Minimum number of days with temperature above threshold to qualify as a heatwave.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.HEAT_WAVE_INDEX object>
class finch.processes.virtual.indicators.heat_wave_max_length_Indicator_Process

heat_wave_max_length Heat wave max length. (v0.1)

Maximum length 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, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh_tasmin (string, optional) – The minimum temperature threshold needed to trigger a heatwave event.

  • thresh_tasmax (string, optional) – The maximum temperature threshold needed to trigger a heatwave event.

  • window (integer, optional) – Minimum number of days with temperatures above thresholds to qualify as a heatwave.

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

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.HEAT_WAVE_MAX_LENGTH object>
class finch.processes.virtual.indicators.heat_wave_total_length_Indicator_Process

heat_wave_total_length Heat wave total length. (v0.1)

Total length 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. This the sum of all days in such events.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh_tasmin (string, optional) – The minimum temperature threshold needed to trigger a heatwave event.

  • thresh_tasmax (string, optional) – The maximum temperature threshold needed to trigger a heatwave event.

  • window (integer, optional) – Minimum number of days with temperatures above thresholds to qualify as a heatwave.

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

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.HEAT_WAVE_TOTAL_LENGTH object>
class finch.processes.virtual.indicators.heating_degree_days_Indicator_Process

heating_degree_days Heating degree days. (v0.1)

Sum of degree days below the temperature threshold at which spaces are heated.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.HEATING_DEGREE_DAYS object>
class finch.processes.virtual.indicators.high_precip_low_temp_Indicator_Process

high_precip_low_temp Number of days with precipitation above threshold and temperature below threshold. (v0.1)

Number of days when precipitation is greater or equal to some threshold, and temperatures are colder than some threshold. This can be used for example to identify days with the potential for freezing rain or icing conditions.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • pr_thresh (string, optional) – Precipitation threshold to exceed.

  • tas_thresh (string, optional) – Temperature threshold not to exceed.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.HIGH_PRECIP_LOW_TEMP object>
class finch.processes.virtual.indicators.hot_spell_frequency_Indicator_Process

hot_spell_frequency Hot spell frequency. (v0.1)

Number of hot spells over a given period. A hot spell is defined as an event where the maximum daily temperature exceeds a specific threshold over a minimum number of days.

Parameters
  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh_tasmax (string, optional) – The maximum temperature threshold needed to trigger a heatwave event.

  • window (integer, optional) – Minimum number of days with temperatures above thresholds to qualify as a heatwave.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.HOT_SPELL_FREQUENCY object>
class finch.processes.virtual.indicators.hot_spell_max_length_Indicator_Process

hot_spell_max_length Longest hot spell. (v0.1)

Longest spell of high temperatures over a given period.

Parameters
  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh_tasmax (string, optional) – The maximum temperature threshold needed to trigger a heatwave event.

  • window (integer, optional) – Minimum number of days with temperatures above thresholds to qualify as a heatwave.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.HOT_SPELL_MAX_LENGTH object>
class finch.processes.virtual.indicators.huglin_index_Indicator_Process

huglin_index Huglin Heliothermal Index. (v0.1)

Growing-degree days with a base of 10degC and adjusted for latitudes between 40degN and 50degN for April-September (Northern Hemisphere; October-March in Southern Hemisphere). Originally proposed in Huglin [1978]. Used as a heat-summation metric in viticulture agroclimatology.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • lat (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – The temperature threshold.

  • start_date (string, optional) – The hemisphere-based start date to consider (north = April, south = October).

  • end_date (string, optional) – The hemisphere-based start date to consider (north = October, south = April). This date is non-inclusive.

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency (default: “YS”; For Southern Hemisphere, should be “AS-JUL”).

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.HUGLIN_INDEX object>
class finch.processes.virtual.indicators.humidex_Indicator_Process

humidex Humidex index. (v0.1)

The humidex indicates how hot the air feels to an average person, accounting for the effect of humidity. It can be loosely interpreted as the equivalent perceived temperature when the air is dry.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • tdps (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Mean surface dew point temperaure. (Info)

  • hurs (application/x-netcdf, application/x-ogc-dods) –

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._conversion.HUMIDEX object>
class finch.processes.virtual.indicators.hurs_Indicator_Process

hurs Relative humidity from temperature, pressure and specific humidity. (v0.1)

Compute relative humidity from temperature and either dewpoint temperature or specific humidity and pressure through the saturation vapor pressure.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • huss (application/x-netcdf, application/x-ogc-dods) –

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

  • ps (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Air pressure at surface (Info)

  • ice_thresh (string, optional) – Threshold temperature under which to switch to equations in reference to ice instead of water. If None (default) everything is computed with reference to water. Does nothing if ‘method’ is “bohren98”.

  • method ({'sonntag90', 'tetens30', 'goffgratch46', 'bohren98', 'wmo08'}, optional) – Which method to use, see notes of this function and of saturation_vapor_pressure.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._conversion.HURS object>
class finch.processes.virtual.indicators.hurs_fromdewpoint_Indicator_Process

hurs_fromdewpoint Relative humidity from temperature and dewpoint temperature. (v0.1)

Compute relative humidity from temperature and either dewpoint temperature or specific humidity and pressure through the saturation vapor pressure.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • tdps (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Mean surface dew point temperaure. (Info)

  • ice_thresh (string, optional) – Threshold temperature under which to switch to equations in reference to ice instead of water. If None (default) everything is computed with reference to water. Does nothing if ‘method’ is “bohren98”.

  • method ({'sonntag90', 'tetens30', 'goffgratch46', 'bohren98', 'wmo08'}, optional) – Which method to use, see notes of this function and of saturation_vapor_pressure.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._conversion.HURS_FROMDEWPOINT object>
class finch.processes.virtual.indicators.huss_fromdewpoint_Indicator_Process

huss_fromdewpoint Specific humidity from dewpoint temperature and air pressure. (v0.1)

Specific humidity is the ratio between the mass of water vapour and the mass of moist air [World Meteorological Organization, 2008].

Parameters
  • tdps (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Mean surface dew point temperaure. (Info)

  • ps (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Air pressure at surface (Info)

  • method ({'goffgratch46', 'sonntag90', 'tetens30', 'wmo08'}, optional) – Method to compute the saturation vapor pressure.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._conversion.HUSS_FROMDEWPOINT object>
class finch.processes.virtual.indicators.ice_days_Indicator_Process

ice_days Number of ice/freezing days. (v0.1)

Number of days when daily maximum temperatures are below a threshold.

Parameters
  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Freezing temperature.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.ICE_DAYS object>
class finch.processes.virtual.indicators.jetstream_metric_woollings_Indicator_Process

jetstream_metric_woollings Strength and latitude of jetstream. (v0.1)

Identify latitude and strength of maximum smoothed zonal wind speed in the region from 15 to 75degN and -60 to 0degE, using the formula outlined in [Woollings et al., 2010].

Parameters
  • ua (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Eastward component of the wind velocity (in the atmosphere). (Info)

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._synoptic.JETSTREAM_METRIC_WOOLLINGS object>
class finch.processes.virtual.indicators.kbdi_Indicator_Process

kbdi Keetch-Byram drought index (KBDI) for soil moisture deficit. (v0.1)

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 Finkele et al. [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.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • pr_annual (application/x-netcdf, application/x-ogc-dods) –

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

  • kbdi0 (application/x-netcdf, application/x-ogc-dods) –

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.KBDI object>
class finch.processes.virtual.indicators.last_snowfall_Indicator_Process

last_snowfall Last day with solid precipitation above a threshold. (v0.1)

Returns the last day of a period where the solid precipitation exceeds a threshold.

Parameters
  • prsn (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold precipitation flux on which to base evaluation.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.LAST_SNOWFALL object>
class finch.processes.virtual.indicators.last_spring_frost_Indicator_Process

last_spring_frost Last day of temperatures inferior to a threshold temperature. (v0.1)

Returns last day of period where a temperature is inferior to a threshold over a given number of days and limited to a final calendar date.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

  • before_date (string, optional) – Date of the year before which to look for the final frost event. Should have the format ‘%m-%d’.

  • window (integer, optional) – Minimum number of days with temperature below threshold needed for evaluation.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.LAST_SPRING_FROST object>
class finch.processes.virtual.indicators.latitude_temperature_index_Indicator_Process

latitude_temperature_index Latitude-Temperature Index. (v0.1)

Mean temperature of the warmest month with a latitude-based scaling factor [Jackson and Cherry, 1988]. Used for categorizing wine-growing regions.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • lat (application/x-netcdf, application/x-ogc-dods) –

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

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.LATITUDE_TEMPERATURE_INDEX object>
class finch.processes.virtual.indicators.liquid_precip_ratio_Indicator_Process

liquid_precip_ratio Ratio of rainfall to total precipitation. (v0.1)

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

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature under which precipitation is assumed to be solid.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.LIQUID_PRECIP_RATIO object>
class finch.processes.virtual.indicators.liquidprcptot_Indicator_Process

liquidprcptot Accumulated liquid precipitation. (v0.1)

Resample the original daily mean precipitation flux and accumulate over each period. If a daily temperature is provided, the phase keyword can be used to sum precipitation of a given phase only. When the temperature is under the given threshold, precipitation is assumed to be snow, and liquid rain otherwise. This indice is agnostic to the type of daily temperature (tas, tasmax or tasmin) given.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold of tas over which the precipication is assumed to be liquid rain.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.LIQUIDPRCPTOT object>
class finch.processes.virtual.indicators.max_n_day_precipitation_amount_Indicator_Process

max_n_day_precipitation_amount Highest precipitation amount cumulated over a n-day moving window. (v0.1)

Calculate the n-day rolling sum of the original daily total precipitation series and determine the maximum value over each period.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • window (integer, optional) – Window size in days.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.MAX_N_DAY_PRECIPITATION_AMOUNT object>
class finch.processes.virtual.indicators.max_pr_intensity_Indicator_Process

max_pr_intensity Highest precipitation intensity over a n-hour moving window. (v0.1)

Calculate the n-hour rolling average of the original hourly total precipitation series and determine the maximum value over each period.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • window (integer, optional) – Window size in hours.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.MAX_PR_INTENSITY object>
class finch.processes.virtual.indicators.maximum_consecutive_warm_days_Indicator_Process

maximum_consecutive_warm_days Maximum number of consecutive days with tasmax above a threshold (summer days). (v0.1)

Return the maximum number of consecutive days within the period where the maximum temperature is above a certain threshold.

Parameters
  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.MAXIMUM_CONSECUTIVE_WARM_DAYS object>
class finch.processes.virtual.indicators.mean_radiant_temperature_Indicator_Process

mean_radiant_temperature Mean radiant temperature. (v0.1)

The mean radiant temperature is the incidence of radiation on the body from all directions.

Parameters
  • rsds (application/x-netcdf, application/x-ogc-dods) –

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

  • rsus (application/x-netcdf, application/x-ogc-dods) –

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

  • rlds (application/x-netcdf, application/x-ogc-dods) –

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

  • rlus (application/x-netcdf, application/x-ogc-dods) –

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

  • stat ({'sunlit', 'average', 'instant'}, optional) – Which statistic to apply. If “average”, the average of the cosine of the solar zenith angle is calculated. If “instant”, the instantaneous cosine of the solar zenith angle is calculated. If “sunlit”, the cosine of the solar zenith angle is calculated during the sunlit period of each interval. If “instant”, the instantaneous cosine of the solar zenith angle is calculated. This is necessary if mrt is not None.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._conversion.MEAN_RADIANT_TEMPERATURE object>
class finch.processes.virtual.indicators.melt_and_precip_max_Indicator_Process

melt_and_precip_max Maximum snow melt and precipitation. (v0.1)

The maximum snow melt plus precipitation over a given number of days expressed in snow water equivalent.

Parameters
  • snw (application/x-netcdf, application/x-ogc-dods) –

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

  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • window (integer, optional) – Number of days during which the water input is accumulated.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._snow.MELT_AND_PRECIP_MAX object>
class finch.processes.virtual.indicators.potential_evapotranspiration_Indicator_Process

potential_evapotranspiration Potential evapotranspiration. (v0.1)

The potential for water evaporation from soil and transpiration by plants if the water supply is sufficient, according to a given method.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • lat (application/x-netcdf, application/x-ogc-dods) –

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

  • hurs (application/x-netcdf, application/x-ogc-dods) –

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

  • rsds (application/x-netcdf, application/x-ogc-dods) –

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

  • rsus (application/x-netcdf, application/x-ogc-dods) –

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

  • rlds (application/x-netcdf, application/x-ogc-dods) –

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

  • rlus (application/x-netcdf, application/x-ogc-dods) –

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

  • sfcwind (application/x-netcdf, application/x-ogc-dods) –

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

  • method ({'thornthwaite48', 'baierrobertson65', 'mcguinnessbordne05', 'FAO_PM98', 'HG85', 'allen98', 'BR65', 'MB05', 'hargreaves85', 'TW48'}, optional) – Which method to use, see notes.

  • peta (integer, optional) – Used only with method MB05 as \(a\) for calculation of PET, see Notes section. Default value resulted from calibration of PET over the UK.

  • petb (integer, optional) – Used only with method MB05 as \(b\) for calculation of PET, see Notes section. Default value resulted from calibration of PET over the UK.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._conversion.POTENTIAL_EVAPOTRANSPIRATION object>
class finch.processes.virtual.indicators.prcptot_Indicator_Process

prcptot Accumulated total precipitation (solid and liquid) (v0.1)

Resample the original daily mean precipitation flux and accumulate over each period. If a daily temperature is provided, the phase keyword can be used to sum precipitation of a given phase only. When the temperature is under the given threshold, precipitation is assumed to be snow, and liquid rain otherwise. This indice is agnostic to the type of daily temperature (tas, tasmax or tasmin) given.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • thresh (string, optional) – Threshold of tas over which the precipication is assumed to be liquid rain.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.PRCPTOT object>
class finch.processes.virtual.indicators.prlp_Indicator_Process

prlp Rainfall approximation from total precipitation and temperature. (v0.1)

Liquid precipitation estimated from precipitation and temperature according to a given method. This is a convenience method based on snowfall_approximation(), see the latter for details.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature, used by method “binary”.

  • method ({'auer', 'binary', 'brown'}, optional) – Which method to use when approximating snowfall from total precipitation. See notes.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._conversion.PRLP object>
class finch.processes.virtual.indicators.prsn_Indicator_Process

prsn Snowfall approximation from total precipitation and temperature. (v0.1)

Solid precipitation estimated from precipitation and temperature according to a given method.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature, used by method “binary”.

  • method ({'auer', 'binary', 'brown'}, optional) – Which method to use when approximating snowfall from total precipitation. See notes.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._conversion.PRSN object>
class finch.processes.virtual.indicators.rain_frzgr_Indicator_Process

rain_frzgr Number of rain on frozen ground events. (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, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Precipitation threshold to consider a day as a rain event.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.RAIN_FRZGR object>
class finch.processes.virtual.indicators.rb_flashiness_index_Indicator_Process

rb_flashiness_index Richards-Baker flashiness index. (v0.1)

Measures oscillations in flow relative to total flow, quantifying the frequency and rapidity of short term changes in flow, based on Baker et al. [2004].

Parameters
  • q (application/x-netcdf, application/x-ogc-dods) –

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

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._streamflow.RB_FLASHINESS_INDEX object>
class finch.processes.virtual.indicators.rprctot_Indicator_Process

rprctot Proportion of accumulated precipitation arising from convective processes. (v0.1)

Return the proportion of total accumulated precipitation due to convection on days with total precipitation exceeding a specified threshold during the given period.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • prc (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Precipitation flux due to the convection schemes of the model (all phases). (Info)

  • thresh (string, optional) – Precipitation value over which a day is considered wet.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.RPRCTOT object>
class finch.processes.virtual.indicators.rx1day_Indicator_Process

rx1day Highest 1-day precipitation amount for a period (frequency). (v0.1)

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

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.RX1DAY object>
class finch.processes.virtual.indicators.sdii_Indicator_Process

sdii Average daily precipitation intensity. (v0.1)

Return the average precipitation over wet days.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • thresh (string, optional) – Precipitation value over which a day is considered wet.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.SDII object>
class finch.processes.virtual.indicators.sea_ice_area_Indicator_Process

sea_ice_area Total sea ice area. (v0.1)

Sea ice area measures the total sea ice covered area where sea ice concentration is above a threshold, usually set to 15%.

Parameters
  • siconc (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Sea ice concentration (area fraction). (Info)

  • areacello (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Cell area (over the ocean). (Info)

  • thresh (string, optional) – Minimum sea ice concentration for a grid cell to contribute to the sea ice extent.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.seaIce._seaice.SEA_ICE_AREA object>
class finch.processes.virtual.indicators.sea_ice_extent_Indicator_Process

sea_ice_extent Total sea ice extent. (v0.1)

Sea ice extent measures the ice-covered area, where a region is considered ice-covered if its sea ice concentration is above a threshold usually set to 15%.

Parameters
  • siconc (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Sea ice concentration (area fraction). (Info)

  • areacello (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Cell area (over the ocean). (Info)

  • thresh (string, optional) – Minimum sea ice concentration for a grid cell to contribute to the sea ice extent.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.seaIce._seaice.SEA_ICE_EXTENT object>
class finch.processes.virtual.indicators.snd_max_doy_Indicator_Process

snd_max_doy Maximum snow depth day of year. (v0.1)

Day of year when surface snow reaches its peak value. If snow depth is 0 over entire period, return NaN.

Parameters
  • snd (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._snow.SND_MAX_DOY object>
class finch.processes.virtual.indicators.snow_cover_duration_Indicator_Process

snow_cover_duration Number of days with snow depth above a threshold. (v0.1)

Number of days where surface snow depth is greater or equal to given threshold.

Parameters
  • snd (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold snow thickness.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._snow.SNOW_COVER_DURATION object>
class finch.processes.virtual.indicators.snow_depth_Indicator_Process

snow_depth Mean of daily average snow depth. (v0.1)

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

Parameters
  • snd (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._snow.SNOW_DEPTH object>
class finch.processes.virtual.indicators.snow_melt_we_max_Indicator_Process

snow_melt_we_max Maximum snow melt. (v0.1)

The maximum snow melt over a given number of days expressed in snow water equivalent.

Parameters
  • snw (application/x-netcdf, application/x-ogc-dods) –

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

  • window (integer, optional) – Number of days during which the melt is accumulated.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._snow.SNOW_MELT_WE_MAX object>
class finch.processes.virtual.indicators.snw_max_Indicator_Process

snw_max Maximum snow amount. (v0.1)

The maximum daily snow amount.

Parameters
  • snw (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._snow.SNW_MAX object>
class finch.processes.virtual.indicators.snw_max_doy_Indicator_Process

snw_max_doy Maximum snow amount day of year. (v0.1)

Day of year when surface snow amount reaches its peak value. If snow amount is 0 over entire period, return NaN.

Parameters
  • snw (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._snow.SNW_MAX_DOY object>
class finch.processes.virtual.indicators.solidprcptot_Indicator_Process

solidprcptot Accumulated solid precipitation. (v0.1)

Resample the original daily mean precipitation flux and accumulate over each period. If a daily temperature is provided, the phase keyword can be used to sum precipitation of a given phase only. When the temperature is under the given threshold, precipitation is assumed to be snow, and liquid rain otherwise. This indice is agnostic to the type of daily temperature (tas, tasmax or tasmin) given.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold of tas over which the precipication is assumed to be liquid rain.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.SOLIDPRCPTOT object>
class finch.processes.virtual.indicators.spei_Indicator_Process

spei Standardized Precipitation Evapotranspiration Index (SPEI) (v0.1)

Precipitation minus potential evapotranspiration data (PET) fitted to a statistical distribution (dist), transformed to a cdf, and inverted back to a gaussian normal pdf. The potential evapotranspiration is calculated with a given method (method).

Parameters
  • wb (application/x-netcdf, application/x-ogc-dods) –

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

  • wb_cal (application/x-netcdf, application/x-ogc-dods) –

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

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency. A monthly or daily frequency is expected.

  • window (integer, optional) – Averaging window length relative to the resampling frequency. For example, if freq=”MS”, i.e. a monthly resampling, the window is an integer number of months.

  • dist ({'gamma'}, optional) – Name of the univariate distribution. Only “gamma” is currently implemented. (see scipy.stats).

  • method ({'APP', 'ML'}, optional) – Name of the fitting method, such as ML (maximum likelihood), APP (approximate). The approximate method uses a deterministic function that doesn’t involve any optimization.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.SPEI object>
class finch.processes.virtual.indicators.spi_Indicator_Process

spi Standardized Precipitation Index (SPI) (v0.1)

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • pr_cal (application/x-netcdf, application/x-ogc-dods) –

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

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency. A monthly or daily frequency is expected.

  • window (integer, optional) – Averaging window length relative to the resampling frequency. For example, if freq=”MS”, i.e. a monthly resampling, the window is an integer number of months.

  • dist ({'gamma'}, optional) – Name of the univariate distribution, only gamma is currently implemented (see scipy.stats).

  • method ({'APP', 'ML'}, optional) – Name of the fitting method, such as ML (maximum likelihood), APP (approximate). The approximate method uses a deterministic function that doesn’t involve any optimization.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.SPI object>
class finch.processes.virtual.indicators.stats_Indicator_Process

stats Statistic of the daily flow on a given period. (v0.1)

Parameters
  • da (application/x-netcdf, application/x-ogc-dods) –

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

  • op ({'var', 'min', 'mean', 'argmax', 'std', 'sum', 'argmin', 'count', 'max'}, optional) – Reduce operation. Can either be a DataArray method or a function that can be applied to a DataArray.

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency defining the periods as defined in https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#resampling.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._streamflow.STATS object>
class finch.processes.virtual.indicators.tg10p_Indicator_Process

tg10p Number of days with daily mean temperature below the 10th percentile. (v0.1)

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

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • tas_per (application/x-netcdf, application/x-ogc-dods) –

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

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'<', 'le', '<=', 'lt'}, optional) – Comparison operation. Default: “<”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TG10P object>
class finch.processes.virtual.indicators.tg90p_Indicator_Process

tg90p Number of days with daily mean temperature over the 90th percentile. (v0.1)

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

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • tas_per (application/x-netcdf, application/x-ogc-dods) –

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

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TG90P object>
class finch.processes.virtual.indicators.tg_Indicator_Process

tg Average temperature from minimum and maximum temperatures. (v0.1)

We assume a symmetrical distribution for the temperature and retrieve the average value as Tg = (Tx + Tn) / 2

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._conversion.TG object>
class finch.processes.virtual.indicators.tg_days_above_Indicator_Process

tg_days_above Number of days with tas above a threshold. (v0.1)

Number of days where daily mean temperature exceeds a threshold.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TG_DAYS_ABOVE object>
class finch.processes.virtual.indicators.tg_days_below_Indicator_Process

tg_days_below Number of days with tas below a threshold. (v0.1)

Number of days where daily mean temperature is below a threshold.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TG_DAYS_BELOW object>
class finch.processes.virtual.indicators.tg_max_Indicator_Process

tg_max Highest mean temperature. (v0.1)

The maximum of daily mean temperature.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TG_MAX object>
class finch.processes.virtual.indicators.tg_mean_Indicator_Process

tg_mean Mean of daily average temperature. (v0.1)

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

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TG_MEAN object>
class finch.processes.virtual.indicators.tg_min_Indicator_Process

tg_min Lowest mean temperature. (v0.1)

Minimum of daily mean temperature.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TG_MIN object>
class finch.processes.virtual.indicators.thawing_degree_days_Indicator_Process

thawing_degree_days Growing degree-days over threshold temperature value. (v0.1)

The sum of degree-days over the threshold temperature.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.THAWING_DEGREE_DAYS object>
class finch.processes.virtual.indicators.tn10p_Indicator_Process

tn10p Number of days with daily minimum temperature below the 10th percentile. (v0.1)

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

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmin_per (application/x-netcdf, application/x-ogc-dods) –

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

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'<', 'le', '<=', 'lt'}, optional) – Comparison operation. Default: “<”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TN10P object>
class finch.processes.virtual.indicators.tn90p_Indicator_Process

tn90p Number of days with daily minimum temperature over the 90th percentile. (v0.1)

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

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmin_per (application/x-netcdf, application/x-ogc-dods) –

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

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TN90P object>
class finch.processes.virtual.indicators.tn_days_above_Indicator_Process

tn_days_above Number of days with tasmin above a threshold (number of tropical nights). (v0.1)

Number of days where daily minimum temperature exceeds a threshold.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TN_DAYS_ABOVE object>
class finch.processes.virtual.indicators.tn_days_below_Indicator_Process

tn_days_below Number of days with tasmin below a threshold. (v0.1)

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

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TN_DAYS_BELOW object>
class finch.processes.virtual.indicators.tn_max_Indicator_Process

tn_max Highest minimum temperature. (v0.1)

The maximum of daily minimum temperature.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TN_MAX object>
class finch.processes.virtual.indicators.tn_mean_Indicator_Process

tn_mean Mean minimum temperature. (v0.1)

Mean of daily minimum temperature.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TN_MEAN object>
class finch.processes.virtual.indicators.tn_min_Indicator_Process

tn_min Lowest minimum temperature. (v0.1)

Minimum of daily minimum temperature.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TN_MIN object>
class finch.processes.virtual.indicators.tropical_nights_Indicator_Process

tropical_nights Number of days with tasmin above a threshold (number of tropical nights). (v0.1)

Number of days where daily minimum temperature exceeds a threshold.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

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

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TROPICAL_NIGHTS object>
class finch.processes.virtual.indicators.tx10p_Indicator_Process

tx10p Number of days with daily maximum temperature below the 10th percentile. (v0.1)

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

Parameters
  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax_per (application/x-netcdf, application/x-ogc-dods) –

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

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'<', 'le', '<=', 'lt'}, optional) – Comparison operation. Default: “<”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TX10P object>
class finch.processes.virtual.indicators.tx90p_Indicator_Process

tx90p Number of days with daily maximum temperature over the 90th percentile. (v0.1)

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

Parameters
  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax_per (application/x-netcdf, application/x-ogc-dods) –

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

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TX90P object>
class finch.processes.virtual.indicators.tx_days_above_Indicator_Process

tx_days_above Number of days with tasmax above a threshold (number of summer days). (v0.1)

Number of days where daily maximum temperature exceeds a threshold.

Parameters
  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TX_DAYS_ABOVE object>
class finch.processes.virtual.indicators.tx_days_below_Indicator_Process

tx_days_below Number of days with tmax below a threshold. (v0.1)

Number of days where daily maximum temperature is below a threshold.

Parameters
  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold temperature on which to base evaluation.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TX_DAYS_BELOW object>
class finch.processes.virtual.indicators.tx_max_Indicator_Process

tx_max Highest max temperature. (v0.1)

The maximum value of daily maximum temperature.

Parameters
  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TX_MAX object>
class finch.processes.virtual.indicators.tx_mean_Indicator_Process

tx_mean Mean max temperature. (v0.1)

The mean of daily maximum temperature.

Parameters
  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TX_MEAN object>
class finch.processes.virtual.indicators.tx_min_Indicator_Process

tx_min Lowest max temperature. (v0.1)

The minimum of daily maximum temperature.

Parameters
  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TX_MIN object>
class finch.processes.virtual.indicators.tx_tn_days_above_Indicator_Process

tx_tn_days_above Number of days with both hot maximum and minimum daily temperatures. (v0.1)

The number of days per period with tasmin above a threshold and tasmax above another threshold.

Parameters
  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh_tasmin (string, optional) – Threshold temperature for tasmin on which to base evaluation.

  • thresh_tasmax (string, optional) – Threshold temperature for tasmax on which to base evaluation.

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

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.TX_TN_DAYS_ABOVE object>
class finch.processes.virtual.indicators.utci_Indicator_Process

utci Universal thermal climate index. (v0.1)

The UTCI is the equivalent temperature for the environment derived from a reference environment and is used to evaluate heat stress in outdoor spaces.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • hurs (application/x-netcdf, application/x-ogc-dods) –

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

  • sfcWind (application/x-netcdf, application/x-ogc-dods) –

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

  • mrt (application/x-netcdf, application/x-ogc-dods) –

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

  • rsds (application/x-netcdf, application/x-ogc-dods) –

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

  • rsus (application/x-netcdf, application/x-ogc-dods) –

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

  • rlds (application/x-netcdf, application/x-ogc-dods) –

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

  • rlus (application/x-netcdf, application/x-ogc-dods) –

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

  • stat ({'sunlit', 'average', 'instant'}, optional) – Which statistic to apply. If “average”, the average of the cosine of the solar zenith angle is calculated. If “instant”, the instantaneous cosine of the solar zenith angle is calculated. If “sunlit”, the cosine of the solar zenith angle is calculated during the sunlit period of each interval. If “instant”, the instantaneous cosine of the solar zenith angle is calculated. This is necessary if mrt is not None.

  • mask_invalid (boolean, optional) – If True (default), UTCI values are NaN where any of the inputs are outside their validity ranges : -50°C < tas < 50°C, -30°C < tas - mrt < 30°C and 0.5 m/s < sfcWind < 17.0 m/s.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._conversion.UTCI object>
class finch.processes.virtual.indicators.warm_and_dry_days_Indicator_Process

warm_and_dry_days warm and dry days (v0.1)

Returns the total number of days when “warm” and “Dry” conditions coincide.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • tas_per (application/x-netcdf, application/x-ogc-dods) –

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

  • pr_per (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.WARM_AND_DRY_DAYS object>
class finch.processes.virtual.indicators.warm_and_wet_days_Indicator_Process

warm_and_wet_days warm and wet days (v0.1)

Returns the total number of days when “warm” and “wet” conditions coincide.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • tas_per (application/x-netcdf, application/x-ogc-dods) –

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

  • pr_per (application/x-netcdf, application/x-ogc-dods) –

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

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.WARM_AND_WET_DAYS object>
class finch.processes.virtual.indicators.warm_spell_duration_index_Indicator_Process

warm_spell_duration_index Warm spell duration index. (v0.1)

Number of days inside spells of a minimum number of consecutive days when the daily maximum temperature is above the 90th percentile. The 90th percentile should be computed for a 5-day moving window, centered on each calendar day in the 1961-1990 period.

Parameters
  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax_per (application/x-netcdf, application/x-ogc-dods) –

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

  • window (integer, optional) – Minimum number of days with temperature above threshold to qualify as a warm spell.

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._temperature.WARM_SPELL_DURATION_INDEX object>
class finch.processes.virtual.indicators.water_budget_Indicator_Process

water_budget Precipitation minus potential evapotranspiration. (v0.1)

Precipitation minus potential evapotranspiration as a measure of an approximated surface water budget, where the potential evapotranspiration can be calculated with a given method.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • evspsblpot (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • lat (application/x-netcdf, application/x-ogc-dods) –

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

  • hurs (application/x-netcdf, application/x-ogc-dods) –

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

  • rsds (application/x-netcdf, application/x-ogc-dods) –

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

  • rsus (application/x-netcdf, application/x-ogc-dods) –

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

  • rlds (application/x-netcdf, application/x-ogc-dods) –

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

  • rlus (application/x-netcdf, application/x-ogc-dods) –

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

  • sfcwind (application/x-netcdf, application/x-ogc-dods) –

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._conversion.WATER_BUDGET object>
class finch.processes.virtual.indicators.water_budget_from_tas_Indicator_Process

water_budget_from_tas Precipitation minus potential evapotranspiration. (v0.1)

Precipitation minus potential evapotranspiration as a measure of an approximated surface water budget, where the potential evapotranspiration can be calculated with a given method.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • evspsblpot (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmin (application/x-netcdf, application/x-ogc-dods) –

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

  • tasmax (application/x-netcdf, application/x-ogc-dods) –

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

  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • lat (application/x-netcdf, application/x-ogc-dods) –

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

  • hurs (application/x-netcdf, application/x-ogc-dods) –

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

  • rsds (application/x-netcdf, application/x-ogc-dods) –

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

  • rsus (application/x-netcdf, application/x-ogc-dods) –

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

  • rlds (application/x-netcdf, application/x-ogc-dods) –

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

  • rlus (application/x-netcdf, application/x-ogc-dods) –

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

  • sfcwind (application/x-netcdf, application/x-ogc-dods) –

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

  • method (string, optional) – Method to use to calculate the potential evapotranspiration.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._conversion.WATER_BUDGET_FROM_TAS object>
class finch.processes.virtual.indicators.wet_prcptot_Indicator_Process

wet_prcptot Accumulated total precipitation (solid and liquid) during wet days (v0.1)

The total accumulated precipitation from days where precipitation exceeds a given amount. A threshold is provided in order to allow the option of reducing the impact of days with trace precipitation amounts on period totals.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • thresh (string, optional) – Threshold over which precipitation starts being cumulated.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.WET_PRCPTOT object>
class finch.processes.virtual.indicators.wetdays_Indicator_Process

wetdays Wet days. (v0.1)

Return the total number of days during period with precipitation over threshold.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • thresh (string, optional) – Precipitation value over which a day is considered wet.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.WETDAYS object>
class finch.processes.virtual.indicators.wetdays_prop_Indicator_Process

wetdays_prop Proportion of wet days. (v0.1)

Return the proportion of days during period with precipitation over threshold.

Parameters
  • pr (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface precipitation flux (all phases). (Info)

  • thresh (string, optional) – Precipitation value over which a day is considered wet.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._precip.WETDAYS_PROP object>
class finch.processes.virtual.indicators.wind_chill_Indicator_Process

wind_chill Wind chill index. (v0.1)

The Wind Chill Index is an estimation of how cold the weather feels to the average person. It is computed from the air temperature and the 10-m wind. As defined by the Environment and Climate Change Canada (Mekis, Vincent, Shephard, and Zhang [2015]), two equations exist, the conventional one and one for slow winds (usually < 5 km/h), see Notes.

Parameters
  • tas (application/x-netcdf, application/x-ogc-dods) –

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

  • sfcWind (application/x-netcdf, application/x-ogc-dods) –

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

  • method ({'CAN', 'US'}, optional) – If “CAN” (default), a “slow wind” equation is used where winds are slower than 5 km/h, see Notes.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._conversion.WIND_CHILL object>
class finch.processes.virtual.indicators.wind_speed_from_vector_Indicator_Process

wind_speed_from_vector Wind speed and direction from the eastward and northward wind components. (v0.1)

Computes the magnitude and angle of the wind vector from its northward and eastward components, following the meteorological convention that sets calm wind to a direction of 0deg and northerly wind to 360deg.

Parameters
  • uas (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Eastward component of the wind velocity (at the surface). (Info)

  • vas (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Northward component of the wind velocity (at the surface). (Info)

  • calm_wind_thresh (string, optional) – The threshold under which winds are considered “calm” and for which the direction is set to 0. On the Beaufort scale, calm winds are defined as < 0.5 m/s.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._conversion.WIND_SPEED_FROM_VECTOR object>
class finch.processes.virtual.indicators.wind_vector_from_speed_Indicator_Process

wind_vector_from_speed Eastward and northward wind components from the wind speed and direction. (v0.1)

Compute the eastward and northward wind components from the wind speed and direction.

Parameters
  • sfcWind (application/x-netcdf, application/x-ogc-dods) –

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

  • sfcWindfromdir (application/x-netcdf, application/x-ogc-dods) –

    NetCDF Files or archive (tar/zip) containing netCDF files. Surface wind direction of provenance. (Info)

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._conversion.WIND_VECTOR_FROM_SPEED object>
class finch.processes.virtual.indicators.windy_days_Indicator_Process

windy_days Windy days. (v0.1)

The number of days with average near-surface wind speed above threshold.

Parameters
  • sfcWind (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold average near-surface wind speed on which to base evaluation.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.atmos._wind.WINDY_DAYS object>
class finch.processes.virtual.indicators.winter_storm_Indicator_Process

winter_storm Days with snowfall over threshold. (v0.1)

Number of days with snowfall accumulation greater or equal to threshold.

Parameters
  • snd (application/x-netcdf, application/x-ogc-dods) –

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

  • thresh (string, optional) – Threshold on snowfall accumulation require to label an event a winter storm.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • variable ({'None'}, optional) – Name of the variable in the input files.

  • output_name (string, optional) – Filename of the output (no extension).

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

  • ref (application/metalink+xml; version=4.0) – Metalink file storing all references to output files.

xci = <xclim.indicators.land._snow.WINTER_STORM object>

Ensemble Processes

class finch.processes.virtual.ensemble.cdd_Ensemble_Bbox_Process

ensemble_bbox_cdd Maximum number of consecutive dry days. (v0.1)

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

Parameters
  • lat0 (float) – Minimum latitude.

  • lat1 (float) – Maximum latitude.

  • lon0 (float) – Minimum longitude.

  • lon1 (float) – Maximum longitude.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold precipitation on which to base evaluation.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.CDD object>
class finch.processes.virtual.ensemble.cdd_Ensemble_GridPoint_Process

ensemble_grid_point_cdd Maximum number of consecutive dry days. (v0.1)

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

Parameters
  • lat (string) – Latitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • lon (string) – Longitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold precipitation on which to base evaluation.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.CDD object>
class finch.processes.virtual.ensemble.cdd_Ensemble_Polygon_Process

ensemble_polygon_cdd Maximum number of consecutive dry days. (v0.1)

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

Parameters
  • shape (application/geo+json, application/x-zipped-shp) – Polygon contour, as a geojson string or as a zipped ShapeFile.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold precipitation on which to base evaluation.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.CDD object>
class finch.processes.virtual.ensemble.cold_and_dry_days_Ensemble_Bbox_Process

ensemble_bbox_cold_and_dry_days Cold and dry days (v0.1)

Returns the total number of days when “Cold” and “Dry” conditions coincide.

Parameters
  • lat0 (float) – Minimum latitude.

  • lat1 (float) – Maximum latitude.

  • lon0 (float) – Minimum longitude.

  • lon1 (float) – Maximum longitude.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • perc_tas (integer, optional) – Which percentile to compute and use as threshold for variable tas.

  • perc_pr (integer, optional) – Which percentile to compute and use as threshold for variable pr.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.COLD_AND_DRY_DAYS object>
class finch.processes.virtual.ensemble.cold_and_dry_days_Ensemble_GridPoint_Process

ensemble_grid_point_cold_and_dry_days Cold and dry days (v0.1)

Returns the total number of days when “Cold” and “Dry” conditions coincide.

Parameters
  • lat (string) – Latitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • lon (string) – Longitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • perc_tas (integer, optional) – Which percentile to compute and use as threshold for variable tas.

  • perc_pr (integer, optional) – Which percentile to compute and use as threshold for variable pr.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.COLD_AND_DRY_DAYS object>
class finch.processes.virtual.ensemble.cold_and_dry_days_Ensemble_Polygon_Process

ensemble_polygon_cold_and_dry_days Cold and dry days (v0.1)

Returns the total number of days when “Cold” and “Dry” conditions coincide.

Parameters
  • shape (application/geo+json, application/x-zipped-shp) – Polygon contour, as a geojson string or as a zipped ShapeFile.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • perc_tas (integer, optional) – Which percentile to compute and use as threshold for variable tas.

  • perc_pr (integer, optional) – Which percentile to compute and use as threshold for variable pr.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.COLD_AND_DRY_DAYS object>
class finch.processes.virtual.ensemble.cold_and_wet_days_Ensemble_Bbox_Process

ensemble_bbox_cold_and_wet_days cold and wet days (v0.1)

Returns the total number of days when “cold” and “wet” conditions coincide.

Parameters
  • lat0 (float) – Minimum latitude.

  • lat1 (float) – Maximum latitude.

  • lon0 (float) – Minimum longitude.

  • lon1 (float) – Maximum longitude.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • perc_tas (integer, optional) – Which percentile to compute and use as threshold for variable tas.

  • perc_pr (integer, optional) – Which percentile to compute and use as threshold for variable pr.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.COLD_AND_WET_DAYS object>
class finch.processes.virtual.ensemble.cold_and_wet_days_Ensemble_GridPoint_Process

ensemble_grid_point_cold_and_wet_days cold and wet days (v0.1)

Returns the total number of days when “cold” and “wet” conditions coincide.

Parameters
  • lat (string) – Latitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • lon (string) – Longitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • perc_tas (integer, optional) – Which percentile to compute and use as threshold for variable tas.

  • perc_pr (integer, optional) – Which percentile to compute and use as threshold for variable pr.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.COLD_AND_WET_DAYS object>
class finch.processes.virtual.ensemble.cold_and_wet_days_Ensemble_Polygon_Process

ensemble_polygon_cold_and_wet_days cold and wet days (v0.1)

Returns the total number of days when “cold” and “wet” conditions coincide.

Parameters
  • shape (application/geo+json, application/x-zipped-shp) – Polygon contour, as a geojson string or as a zipped ShapeFile.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • perc_tas (integer, optional) – Which percentile to compute and use as threshold for variable tas.

  • perc_pr (integer, optional) – Which percentile to compute and use as threshold for variable pr.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.COLD_AND_WET_DAYS object>
class finch.processes.virtual.ensemble.cold_spell_days_Ensemble_Bbox_Process

ensemble_bbox_cold_spell_days Cold spell days. (v0.1)

The number of days that are part of cold spell events, defined as a sequence of consecutive days with mean daily temperature below a threshold in degC.

Parameters
  • lat0 (float) – Minimum latitude.

  • lat1 (float) – Maximum latitude.

  • lon0 (float) – Minimum longitude.

  • lon1 (float) – Maximum longitude.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold temperature below which a cold spell begins.

  • window (integer, optional) – Minimum number of days with temperature below threshold to qualify as a cold spell.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.COLD_SPELL_DAYS object>
class finch.processes.virtual.ensemble.cold_spell_days_Ensemble_GridPoint_Process

ensemble_grid_point_cold_spell_days Cold spell days. (v0.1)

The number of days that are part of cold spell events, defined as a sequence of consecutive days with mean daily temperature below a threshold in degC.

Parameters
  • lat (string) – Latitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • lon (string) – Longitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold temperature below which a cold spell begins.

  • window (integer, optional) – Minimum number of days with temperature below threshold to qualify as a cold spell.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.COLD_SPELL_DAYS object>
class finch.processes.virtual.ensemble.cold_spell_days_Ensemble_Polygon_Process

ensemble_polygon_cold_spell_days Cold spell days. (v0.1)

The number of days that are part of cold spell events, defined as a sequence of consecutive days with mean daily temperature below a threshold in degC.

Parameters
  • shape (application/geo+json, application/x-zipped-shp) – Polygon contour, as a geojson string or as a zipped ShapeFile.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold temperature below which a cold spell begins.

  • window (integer, optional) – Minimum number of days with temperature below threshold to qualify as a cold spell.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.COLD_SPELL_DAYS object>
class finch.processes.virtual.ensemble.cold_spell_duration_index_Ensemble_Bbox_Process

ensemble_bbox_cold_spell_duration_index Cold spell duration index. (v0.1)

Number of days with at least window consecutive days when the daily minimum temperature is below the tasmin_per percentiles.

Parameters
  • lat0 (float) – Minimum latitude.

  • lat1 (float) – Maximum latitude.

  • lon0 (float) – Minimum longitude.

  • lon1 (float) – Maximum longitude.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • perc_tasmin (integer, optional) – Which percentile to compute and use as threshold for variable tasmin.

  • window (integer, optional) – Minimum number of days with temperature below threshold to qualify as a cold spell.

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'<', 'le', '<=', 'lt'}, optional) – Comparison operation. Default: “<”.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.COLD_SPELL_DURATION_INDEX object>
class finch.processes.virtual.ensemble.cold_spell_duration_index_Ensemble_GridPoint_Process

ensemble_grid_point_cold_spell_duration_index Cold spell duration index. (v0.1)

Number of days with at least window consecutive days when the daily minimum temperature is below the tasmin_per percentiles.

Parameters
  • lat (string) – Latitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • lon (string) – Longitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • perc_tasmin (integer, optional) – Which percentile to compute and use as threshold for variable tasmin.

  • window (integer, optional) – Minimum number of days with temperature below threshold to qualify as a cold spell.

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'<', 'le', '<=', 'lt'}, optional) – Comparison operation. Default: “<”.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.COLD_SPELL_DURATION_INDEX object>
class finch.processes.virtual.ensemble.cold_spell_duration_index_Ensemble_Polygon_Process

ensemble_polygon_cold_spell_duration_index Cold spell duration index. (v0.1)

Number of days with at least window consecutive days when the daily minimum temperature is below the tasmin_per percentiles.

Parameters
  • shape (application/geo+json, application/x-zipped-shp) – Polygon contour, as a geojson string or as a zipped ShapeFile.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • perc_tasmin (integer, optional) – Which percentile to compute and use as threshold for variable tasmin.

  • window (integer, optional) – Minimum number of days with temperature below threshold to qualify as a cold spell.

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'<', 'le', '<=', 'lt'}, optional) – Comparison operation. Default: “<”.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.COLD_SPELL_DURATION_INDEX object>
class finch.processes.virtual.ensemble.cold_spell_frequency_Ensemble_Bbox_Process

ensemble_bbox_cold_spell_frequency Cold spell frequency. (v0.1)

The number of cold spell events, defined as a sequence of consecutive days with mean daily temperature below a threshold.

Parameters
  • lat0 (float) – Minimum latitude.

  • lat1 (float) – Maximum latitude.

  • lon0 (float) – Minimum longitude.

  • lon1 (float) – Maximum longitude.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold temperature below which a cold spell begins.

  • window (integer, optional) – Minimum number of days with temperature below threshold to qualify as a cold spell.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.COLD_SPELL_FREQUENCY object>
class finch.processes.virtual.ensemble.cold_spell_frequency_Ensemble_GridPoint_Process

ensemble_grid_point_cold_spell_frequency Cold spell frequency. (v0.1)

The number of cold spell events, defined as a sequence of consecutive days with mean daily temperature below a threshold.

Parameters
  • lat (string) – Latitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • lon (string) – Longitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold temperature below which a cold spell begins.

  • window (integer, optional) – Minimum number of days with temperature below threshold to qualify as a cold spell.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.COLD_SPELL_FREQUENCY object>
class finch.processes.virtual.ensemble.cold_spell_frequency_Ensemble_Polygon_Process

ensemble_polygon_cold_spell_frequency Cold spell frequency. (v0.1)

The number of cold spell events, defined as a sequence of consecutive days with mean daily temperature below a threshold.

Parameters
  • shape (application/geo+json, application/x-zipped-shp) – Polygon contour, as a geojson string or as a zipped ShapeFile.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold temperature below which a cold spell begins.

  • window (integer, optional) – Minimum number of days with temperature below threshold to qualify as a cold spell.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.COLD_SPELL_FREQUENCY object>
class finch.processes.virtual.ensemble.consecutive_frost_days_Ensemble_Bbox_Process

ensemble_bbox_consecutive_frost_days Maximum number of consecutive frost days (Tn < 0). (v0.1)

The maximum number of consecutive days within the period where the temperature is under a certain threshold (default: 0degC). WARNING: The default freq value is valid for the northern hemisphere.

Parameters
  • lat0 (float) – Minimum latitude.

  • lat1 (float) – Maximum latitude.

  • lon0 (float) – Minimum longitude.

  • lon1 (float) – Maximum longitude.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold temperature.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.CONSECUTIVE_FROST_DAYS object>
class finch.processes.virtual.ensemble.consecutive_frost_days_Ensemble_GridPoint_Process

ensemble_grid_point_consecutive_frost_days Maximum number of consecutive frost days (Tn < 0). (v0.1)

The maximum number of consecutive days within the period where the temperature is under a certain threshold (default: 0degC). WARNING: The default freq value is valid for the northern hemisphere.

Parameters
  • lat (string) – Latitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • lon (string) – Longitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold temperature.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.CONSECUTIVE_FROST_DAYS object>
class finch.processes.virtual.ensemble.consecutive_frost_days_Ensemble_Polygon_Process

ensemble_polygon_consecutive_frost_days Maximum number of consecutive frost days (Tn < 0). (v0.1)

The maximum number of consecutive days within the period where the temperature is under a certain threshold (default: 0degC). WARNING: The default freq value is valid for the northern hemisphere.

Parameters
  • shape (application/geo+json, application/x-zipped-shp) – Polygon contour, as a geojson string or as a zipped ShapeFile.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold temperature.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.CONSECUTIVE_FROST_DAYS object>
class finch.processes.virtual.ensemble.consecutive_frost_free_days_Ensemble_Bbox_Process

ensemble_bbox_consecutive_frost_free_days Maximum number of consecutive frost free days (Tn >= 0). (v0.1)

Return the maximum number of consecutive days within the period where the minimum temperature is above or equal to a certain threshold.

Parameters
  • lat0 (float) – Minimum latitude.

  • lat1 (float) – Maximum latitude.

  • lon0 (float) – Minimum longitude.

  • lon1 (float) – Maximum longitude.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold temperature.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.CONSECUTIVE_FROST_FREE_DAYS object>
class finch.processes.virtual.ensemble.consecutive_frost_free_days_Ensemble_GridPoint_Process

ensemble_grid_point_consecutive_frost_free_days Maximum number of consecutive frost free days (Tn >= 0). (v0.1)

Return the maximum number of consecutive days within the period where the minimum temperature is above or equal to a certain threshold.

Parameters
  • lat (string) – Latitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • lon (string) – Longitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold temperature.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.CONSECUTIVE_FROST_FREE_DAYS object>
class finch.processes.virtual.ensemble.consecutive_frost_free_days_Ensemble_Polygon_Process

ensemble_polygon_consecutive_frost_free_days Maximum number of consecutive frost free days (Tn >= 0). (v0.1)

Return the maximum number of consecutive days within the period where the minimum temperature is above or equal to a certain threshold.

Parameters
  • shape (application/geo+json, application/x-zipped-shp) – Polygon contour, as a geojson string or as a zipped ShapeFile.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold temperature.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.CONSECUTIVE_FROST_FREE_DAYS object>
class finch.processes.virtual.ensemble.cooling_degree_days_Ensemble_Bbox_Process

ensemble_bbox_cooling_degree_days Cooling degree days. (v0.1)

Sum of degree days above the temperature threshold at which spaces are cooled.

Parameters
  • lat0 (float) – Minimum latitude.

  • lat1 (float) – Maximum latitude.

  • lon0 (float) – Minimum longitude.

  • lon1 (float) – Maximum longitude.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Temperature threshold above which air is cooled.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.COOLING_DEGREE_DAYS object>
class finch.processes.virtual.ensemble.cooling_degree_days_Ensemble_GridPoint_Process

ensemble_grid_point_cooling_degree_days Cooling degree days. (v0.1)

Sum of degree days above the temperature threshold at which spaces are cooled.

Parameters
  • lat (string) – Latitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • lon (string) – Longitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Temperature threshold above which air is cooled.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.COOLING_DEGREE_DAYS object>
class finch.processes.virtual.ensemble.cooling_degree_days_Ensemble_Polygon_Process

ensemble_polygon_cooling_degree_days Cooling degree days. (v0.1)

Sum of degree days above the temperature threshold at which spaces are cooled.

Parameters
  • shape (application/geo+json, application/x-zipped-shp) – Polygon contour, as a geojson string or as a zipped ShapeFile.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Temperature threshold above which air is cooled.

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

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.COOLING_DEGREE_DAYS object>
class finch.processes.virtual.ensemble.corn_heat_units_Ensemble_Bbox_Process

ensemble_bbox_corn_heat_units Corn heat units. (v0.1)

Temperature-based index used to estimate the development of corn crops. Formula adapted from Bootsma et al. [1999].

Parameters
  • lat0 (float) – Minimum latitude.

  • lat1 (float) – Maximum latitude.

  • lon0 (float) – Minimum longitude.

  • lon1 (float) – Maximum longitude.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh_tasmin (string, optional) – The minimum temperature threshold needed for corn growth.

  • thresh_tasmax (string, optional) – The maximum temperature threshold needed for corn growth.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._conversion.CORN_HEAT_UNITS object>
class finch.processes.virtual.ensemble.corn_heat_units_Ensemble_GridPoint_Process

ensemble_grid_point_corn_heat_units Corn heat units. (v0.1)

Temperature-based index used to estimate the development of corn crops. Formula adapted from Bootsma et al. [1999].

Parameters
  • lat (string) – Latitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • lon (string) – Longitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh_tasmin (string, optional) – The minimum temperature threshold needed for corn growth.

  • thresh_tasmax (string, optional) – The maximum temperature threshold needed for corn growth.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._conversion.CORN_HEAT_UNITS object>
class finch.processes.virtual.ensemble.corn_heat_units_Ensemble_Polygon_Process

ensemble_polygon_corn_heat_units Corn heat units. (v0.1)

Temperature-based index used to estimate the development of corn crops. Formula adapted from Bootsma et al. [1999].

Parameters
  • shape (application/geo+json, application/x-zipped-shp) – Polygon contour, as a geojson string or as a zipped ShapeFile.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh_tasmin (string, optional) – The minimum temperature threshold needed for corn growth.

  • thresh_tasmax (string, optional) – The maximum temperature threshold needed for corn growth.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._conversion.CORN_HEAT_UNITS object>
class finch.processes.virtual.ensemble.cwd_Ensemble_Bbox_Process

ensemble_bbox_cwd Consecutive wet days. (v0.1)

Returns the maximum number of consecutive wet days.

Parameters
  • lat0 (float) – Minimum latitude.

  • lat1 (float) – Maximum latitude.

  • lon0 (float) – Minimum longitude.

  • lon1 (float) – Maximum longitude.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold precipitation on which to base evaluation.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.CWD object>
class finch.processes.virtual.ensemble.cwd_Ensemble_GridPoint_Process

ensemble_grid_point_cwd Consecutive wet days. (v0.1)

Returns the maximum number of consecutive wet days.

Parameters
  • lat (string) – Latitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • lon (string) – Longitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold precipitation on which to base evaluation.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.CWD object>
class finch.processes.virtual.ensemble.cwd_Ensemble_Polygon_Process

ensemble_polygon_cwd Consecutive wet days. (v0.1)

Returns the maximum number of consecutive wet days.

Parameters
  • shape (application/geo+json, application/x-zipped-shp) – Polygon contour, as a geojson string or as a zipped ShapeFile.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold precipitation on which to base evaluation.

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

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.CWD object>
class finch.processes.virtual.ensemble.days_over_precip_doy_thresh_Ensemble_Bbox_Process

ensemble_bbox_days_over_precip_doy_thresh Number of wet days with daily precipitation over a given percentile. (v0.1)

Number of days over period where the precipitation is above a threshold defining wet days and above a given percentile for that day.

Parameters
  • lat0 (float) – Minimum latitude.

  • lat1 (float) – Maximum latitude.

  • lon0 (float) – Minimum longitude.

  • lon1 (float) – Maximum longitude.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • perc_pr (integer, optional) – Which percentile to compute and use as threshold for variable pr.

  • thresh (string, optional) – Precipitation value over which a day is considered wet.

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.DAYS_OVER_PRECIP_DOY_THRESH object>
class finch.processes.virtual.ensemble.days_over_precip_doy_thresh_Ensemble_GridPoint_Process

ensemble_grid_point_days_over_precip_doy_thresh Number of wet days with daily precipitation over a given percentile. (v0.1)

Number of days over period where the precipitation is above a threshold defining wet days and above a given percentile for that day.

Parameters
  • lat (string) – Latitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • lon (string) – Longitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • perc_pr (integer, optional) – Which percentile to compute and use as threshold for variable pr.

  • thresh (string, optional) – Precipitation value over which a day is considered wet.

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.DAYS_OVER_PRECIP_DOY_THRESH object>
class finch.processes.virtual.ensemble.days_over_precip_doy_thresh_Ensemble_Polygon_Process

ensemble_polygon_days_over_precip_doy_thresh Number of wet days with daily precipitation over a given percentile. (v0.1)

Number of days over period where the precipitation is above a threshold defining wet days and above a given percentile for that day.

Parameters
  • shape (application/geo+json, application/x-zipped-shp) – Polygon contour, as a geojson string or as a zipped ShapeFile.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • perc_pr (integer, optional) – Which percentile to compute and use as threshold for variable pr.

  • thresh (string, optional) – Precipitation value over which a day is considered wet.

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.DAYS_OVER_PRECIP_DOY_THRESH object>
class finch.processes.virtual.ensemble.days_over_precip_thresh_Ensemble_Bbox_Process

ensemble_bbox_days_over_precip_thresh Number of wet days with daily precipitation over a given percentile. (v0.1)

Number of days over period where the precipitation is above a threshold defining wet days and above a given percentile for that day.

Parameters
  • lat0 (float) – Minimum latitude.

  • lat1 (float) – Maximum latitude.

  • lon0 (float) – Minimum longitude.

  • lon1 (float) – Maximum longitude.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • perc_pr (integer, optional) – Which percentile to compute and use as threshold for variable pr.

  • thresh (string, optional) – Precipitation value over which a day is considered wet.

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.DAYS_OVER_PRECIP_THRESH object>
class finch.processes.virtual.ensemble.days_over_precip_thresh_Ensemble_GridPoint_Process

ensemble_grid_point_days_over_precip_thresh Number of wet days with daily precipitation over a given percentile. (v0.1)

Number of days over period where the precipitation is above a threshold defining wet days and above a given percentile for that day.

Parameters
  • lat (string) – Latitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • lon (string) – Longitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • perc_pr (integer, optional) – Which percentile to compute and use as threshold for variable pr.

  • thresh (string, optional) – Precipitation value over which a day is considered wet.

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.DAYS_OVER_PRECIP_THRESH object>
class finch.processes.virtual.ensemble.days_over_precip_thresh_Ensemble_Polygon_Process

ensemble_polygon_days_over_precip_thresh Number of wet days with daily precipitation over a given percentile. (v0.1)

Number of days over period where the precipitation is above a threshold defining wet days and above a given percentile for that day.

Parameters
  • shape (application/geo+json, application/x-zipped-shp) – Polygon contour, as a geojson string or as a zipped ShapeFile.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • perc_pr (integer, optional) – Which percentile to compute and use as threshold for variable pr.

  • thresh (string, optional) – Precipitation value over which a day is considered wet.

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

  • bootstrap (boolean, optional) – Flag to run bootstrapping of percentiles. Used by percentile_bootstrap decorator. Bootstrapping is only useful when the percentiles are computed on a part of the studied sample. This period, common to percentiles and the sample must be bootstrapped to avoid inhomogeneities with the rest of the time series. Keep bootstrap to False when there is no common period, it would give wrong results plus, bootstrapping is computationally expensive.

  • op ({'>', '>=', 'ge', 'gt'}, optional) – Comparison operation. Default: “>”.

  • month ({'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', ...}, optional) – Months of the year over which to compute indicator.

  • season ({'DJF', 'MAM', 'JJA', 'SON'}, optional) – Climatological season over which to compute indicator.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._precip.DAYS_OVER_PRECIP_THRESH object>
class finch.processes.virtual.ensemble.degree_days_exceedance_date_Ensemble_Bbox_Process

ensemble_bbox_degree_days_exceedance_date Degree-days exceedance date. (v0.1)

Day of year when the sum of degree days exceeds a threshold. Degree days are computed above or below a given temperature threshold.

Parameters
  • lat0 (float) – Minimum latitude.

  • lat1 (float) – Maximum latitude.

  • lon0 (float) – Minimum longitude.

  • lon1 (float) – Maximum longitude.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold temperature on which to base degree-days evaluation.

  • sum_thresh (string, optional) – Threshold of the degree days sum.

  • op ({'lt', 'ge', '>', 'gt', 'le', '<', '>=', '<='}, optional) – If equivalent to ‘>’, degree days are computed as tas - thresh and if equivalent to ‘<’, they are computed as thresh - tas.

  • after_date (string, optional) – Date at which to start the cumulative sum. In “mm-dd” format, defaults to the start of the sampling period.

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency. If after_date is given, freq should be annual.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.DEGREE_DAYS_EXCEEDANCE_DATE object>
class finch.processes.virtual.ensemble.degree_days_exceedance_date_Ensemble_GridPoint_Process

ensemble_grid_point_degree_days_exceedance_date Degree-days exceedance date. (v0.1)

Day of year when the sum of degree days exceeds a threshold. Degree days are computed above or below a given temperature threshold.

Parameters
  • lat (string) – Latitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • lon (string) – Longitude coordinate. Accepts a comma separated list of floats for multiple grid cells.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold temperature on which to base degree-days evaluation.

  • sum_thresh (string, optional) – Threshold of the degree days sum.

  • op ({'lt', 'ge', '>', 'gt', 'le', '<', '>=', '<='}, optional) – If equivalent to ‘>’, degree days are computed as tas - thresh and if equivalent to ‘<’, they are computed as thresh - tas.

  • after_date (string, optional) – Date at which to start the cumulative sum. In “mm-dd” format, defaults to the start of the sampling period.

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency. If after_date is given, freq should be annual.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.DEGREE_DAYS_EXCEEDANCE_DATE object>
class finch.processes.virtual.ensemble.degree_days_exceedance_date_Ensemble_Polygon_Process

ensemble_polygon_degree_days_exceedance_date Degree-days exceedance date. (v0.1)

Day of year when the sum of degree days exceeds a threshold. Degree days are computed above or below a given temperature threshold.

Parameters
  • shape (application/geo+json, application/x-zipped-shp) – Polygon contour, as a geojson string or as a zipped ShapeFile.

  • start_date (string, optional) – Initial date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to first day in file.

  • end_date (string, optional) – Final date for temporal subsetting. Can be expressed as year (%Y), year-month (%Y-%m) or year-month-day(%Y-%m-%d). Defaults to last day in file.

  • ensemble_percentiles (string, optional) – Ensemble percentiles to calculate for input climate simulations. Accepts a comma separated list of integers.

  • average (boolean, optional) – Whether to average over spatial dimensions or not. Averaging is done before the ensemble percentiles.

  • dataset ({'candcs-u5', 'bccaqv2', 'candcs-u6'}, optional) – Name of the dataset from which to get netcdf files for inputs.

  • scenario ({'ssp126', 'ssp585', 'rcp45', 'rcp26', 'rcp85', 'ssp245'}, optional) – Emission scenario (RCPs or SSPs, depending on the dataset)

  • models ({'all', 'BNU-ESM', 'CCSM4', 'CESM1-CAM5', 'CNRM-CM5', 'CSIRO-Mk3-6-0', 'CanESM2', 'FGOALS-g2', 'GFDL-CM3', 'GFDL-ESM2G', ...}, optional) – When calculating the ensemble, include only these models. Allowed values depend on the dataset chosen. By default, all models are used (‘all’), taking the first realization of each. Special sub-lists are also available :candcs-u5: [‘24models’, ‘pcic12’], bccaqv2: [‘24models’, ‘pcic12’], candcs-u6: [‘26models’]

  • thresh (string, optional) – Threshold temperature on which to base degree-days evaluation.

  • sum_thresh (string, optional) – Threshold of the degree days sum.

  • op ({'lt', 'ge', '>', 'gt', 'le', '<', '>=', '<='}, optional) – If equivalent to ‘>’, degree days are computed as tas - thresh and if equivalent to ‘<’, they are computed as thresh - tas.

  • after_date (string, optional) – Date at which to start the cumulative sum. In “mm-dd” format, defaults to the start of the sampling period.

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency. If after_date is given, freq should be annual.

  • check_missing ({'any', 'wmo', 'pct', 'at_least_n', 'skip', 'from_context'}, optional) – Method used to determine which aggregations should be considered missing.

  • missing_options (application/json, optional) – JSON representation of dictionary of missing method parameters.

  • cf_compliance ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs have non-CF-compliant attributes.

  • data_validation ({'log', 'warn', 'raise'}, optional) – Whether to log, warn or raise when inputs fail data validation checks.

  • output_name (string, optional) – Prefix of the output filename, defaults to the dataset name and the identifier of the process.

  • output_format ({'netcdf', 'csv'}, optional) – Choose in which format you want to receive the result. CSV actually means a zip file of two csv files.

  • csv_precision (integer, optional) – Only valid if output_format is CSV. If not set, all decimal places of a 64 bit floating precision number are printed. If negative, rounds before the decimal point.

Returns

  • output (application/x-netcdf, application/zip) – The format depends on the ‘output_format’ input parameter.

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

xci = <xclim.indicators.atmos._temperature.DEGREE_DAYS_EXCEEDANCE_DATE object>
class finch.processes.virtual.ensemble.dlyfrzthw_Ensemble_Bbox_Process

ensemble_bbox_dlyfrzthw Statistics of consecutive diurnal temperature swing events. (v0.1)

A diurnal swing of max and min temperature event is when Tmax > thresh_tasmax and Tmin <= thresh_tasmin. This indice finds all days that constitute these events and computes statistics over the length and frequency of these events.

Parameters
  • lat0 (float) – Minimum latitude.

  • lat1 (float) – Maximum latitude.

  • lon0 (float) – Minimum longitude.

  • lon1 (float) – Maximum longitude.

  • start_date (string,