Indicators Processes

Processes for indicators

class finch.processes.virtual.indicators.base_flow_index_Indicator_Process

Bases: XclimIndicatorBase

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

Bases: XclimIndicatorBase

biologically_effective_degree_days Biologically effective degree days (v0.1)

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

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.

  • method ({'gladstones', 'jones', 'icclim'}, optional) – The formula to use for the calculation. The “gladstones” integrates a daily temperature range and latitude coefficient. End_date should be “11-01”. The “icclim” method ignores daily temperature range and latitude coefficient. End date should be “10-01”. The “jones” method integrates axial tilt, latitude, and day-of-year on coefficient. End_date should be “11-01”.

  • 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

Bases: XclimIndicatorBase

blowing_snow Blowing snow days (v0.1)

The number of days with snowfall, snow depth, and windspeed over given thresholds for a period of days.

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

Bases: XclimIndicatorBase

calm_days Calm days (v0.1)

Number of days with 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

Bases: XclimIndicatorBase

cdd Maximum consecutive dry days (v0.1)

The longest number of consecutive days where daily precipitation below a given 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.

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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

Bases: XclimIndicatorBase

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 ({'None', 'WF93', 'GFWED', 'LA08'}, 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 ({'None', 'GFWED', 'CFS'}, 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

Bases: XclimIndicatorBase

cold_and_dry_days Cold and dry days (v0.1)

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

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

Bases: XclimIndicatorBase

cold_and_wet_days Cold and wet days (v0.1)

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

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

Bases: XclimIndicatorBase

cold_spell_days Cold spell days (v0.1)

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

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.

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

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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

Bases: XclimIndicatorBase

cold_spell_duration_index Cold Spell Duration Index (CSDI) (v0.1)

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

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.

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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

Bases: XclimIndicatorBase

cold_spell_frequency Cold spell frequency (v0.1)

The number of cold spell events. A cold spell is defined as a minimum number of consecutive days with mean daily temperature below a given 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.

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

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run

  • 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

Bases: XclimIndicatorBase

consecutive_frost_days Consecutive frost days (v0.1)

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

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.

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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

Bases: XclimIndicatorBase

consecutive_frost_free_days Maximum consecutive frost free days (v0.1)

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

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.

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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.cool_night_index_Indicator_Process

Bases: XclimIndicatorBase

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)

  • 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

Bases: XclimIndicatorBase

cooling_degree_days Cooling degree days (v0.1)

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

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

Bases: XclimIndicatorBase

corn_heat_units Corn heat units (v0.1)

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

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

Bases: XclimIndicatorBase

cwd Maximum consecutive wet days (v0.1)

The longest number of consecutive days where daily precipitation is at or above a given 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.

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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

Bases: XclimIndicatorBase

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

Number of days in a period where precipitation is above a given daily percentile and a fixed 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)

  • 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

Bases: XclimIndicatorBase

days_over_precip_thresh Number of days with precipitation above a given percentile (v0.1)

Number of days in a period where precipitation is above a given percentile, calculated over a given period and a fixed 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)

  • 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

Bases: XclimIndicatorBase

days_with_snow Days with snowfall (v0.1)

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

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

Bases: XclimIndicatorBase

degree_days_exceedance_date Degree day exceedance date (v0.1)

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

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', 'le', 'gt', '<', '>=', '<=', '>'}, 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

Bases: XclimIndicatorBase

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.discharge_distribution_fit_Indicator_Process

Bases: XclimIndicatorBase

discharge_distribution_fit Distribution parameters fitted over the time dimension. (v0.1)

Parameters:

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

    NetCDF Files or archive (tar/zip) containing netCDF files. The amount of water, in all phases, flowing in the river channel and flood plain. (Info)

  • dist (string, optional) – Name of the univariate distribution, such as beta, expon, genextreme, gamma, gumbel_r, lognorm, norm (see :py:mod: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 ({'APP', 'ML', 'PWM'}, optional) – Fitting method, either maximum likelihood (ML), probability weighted moments (PWM), also called L-Moments, or approximate method (APP). 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.streamflow.DISCHARGE_DISTRIBUTION_FIT object>
class finch.processes.virtual.indicators.discharge_stats_Indicator_Process

Bases: XclimIndicatorBase

discharge_stats Statistic of the daily values for a given period. (v0.1)

Parameters:

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

    NetCDF Files or archive (tar/zip) containing netCDF files. The amount of water, in all phases, flowing in the river channel and flood plain. (Info)

  • op ({'var', 'argmax', 'mean', 'count', 'std', 'argmin', 'min', 'sum', '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.streamflow.DISCHARGE_STATS object>
class finch.processes.virtual.indicators.dlyfrzthw_Indicator_Process

Bases: XclimIndicatorBase

dlyfrzthw Daily freeze-thaw cycles (v0.1)

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

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.

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

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

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

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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

Bases: XclimIndicatorBase

doy_qmax Day of year of the maximum streamflow (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

Bases: XclimIndicatorBase

doy_qmin Day of year of the minimum streamflow (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

Bases: XclimIndicatorBase

dry_days Number of dry days (v0.1)

The number of days with daily precipitation under a given 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.

  • 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._precip.DRY_DAYS object>
class finch.processes.virtual.indicators.dry_spell_frequency_Indicator_Process

Bases: XclimIndicatorBase

dry_spell_frequency Dry spell frequency (v0.1)

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

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.

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • op ({'sum', 'max'}, 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

Bases: XclimIndicatorBase

dry_spell_total_length Dry spell total length (v0.1)

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

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 ({'sum', 'max'}, optional) – Reduce operation.

  • freq ({'YS', 'MS', 'QS-DEC', 'AS-JUL'}, optional) – Resampling frequency. Indexing parameters to compute the indicator on a temporal subset of the data. It accepts the same arguments as xclim.indices.generic.select_time(). Indexing is done after finding the dry days, but before finding the spells.

  • resample_before_rl (boolean, optional) – Resample before rl

  • 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.dryness_index_Indicator_Process

Bases: XclimIndicatorBase

dryness_index Dryness index (v0.1)

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

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)

  • wo (string, optional) – The initial soil water reserve accessible to root systems [length]. Default: 200 mm.

  • 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.DRYNESS_INDEX object>
class finch.processes.virtual.indicators.dtr_Indicator_Process

Bases: XclimIndicatorBase

dtr Mean of daily temperature range (v0.1)

The average difference between the daily maximum and minimum temperatures.

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

Bases: XclimIndicatorBase

dtrmax Maximum of daily temperature range (v0.1)

The maximum difference between the daily maximum and minimum temperatures.

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

Bases: XclimIndicatorBase

dtrvar Variability of daily temperature range (v0.1)

The average 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

Bases: XclimIndicatorBase

effective_growing_degree_days Effective growing degree days (v0.1)

Considers daily minimum and maximum temperature with a given base threshold between dynamically-determined growing season start and end dates. The bootsma method uses a 10-day mean temperature above a given threshold to identify a start date, while the qian method uses a weighted mean temperature above a given threshold over 5 days to determine the start date. The end date of the growing season is the date of first fall frost (Tn < 0degC) occurring after a given date (typically, July 1). Metric originally published in Bootsma et al. (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. For “qian”, the start date is based on a weighted 5-day rolling average, based on :py:func`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

Bases: XclimIndicatorBase

etr Extreme temperature range (v0.1)

The maximum of the maximum temperature minus the minimum of the 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.ETR object>
class finch.processes.virtual.indicators.ffdi_Indicator_Process

Bases: XclimIndicatorBase

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

Bases: XclimIndicatorBase

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 ({'WF93', 'GFWED', 'LA08'}, 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. Must be scalar.

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

  • 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”. Must be scalar.

  • 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_tg_above_Indicator_Process

Bases: XclimIndicatorBase

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

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

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.

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

  • 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_TG_ABOVE object>
class finch.processes.virtual.indicators.first_day_tg_below_Indicator_Process

Bases: XclimIndicatorBase

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

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

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.

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

  • 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 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_TG_BELOW object>
class finch.processes.virtual.indicators.first_day_tn_above_Indicator_Process

Bases: XclimIndicatorBase

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

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

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.

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

  • 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_TN_ABOVE object>
class finch.processes.virtual.indicators.first_day_tn_below_Indicator_Process

Bases: XclimIndicatorBase

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

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

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.

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

  • 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 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_TN_BELOW object>
class finch.processes.virtual.indicators.first_day_tx_above_Indicator_Process

Bases: XclimIndicatorBase

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

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

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.

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

  • 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_TX_ABOVE object>
class finch.processes.virtual.indicators.first_day_tx_below_Indicator_Process

Bases: XclimIndicatorBase

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

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

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.

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

  • 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 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_TX_BELOW object>
class finch.processes.virtual.indicators.first_snowfall_Indicator_Process

Bases: XclimIndicatorBase

first_snowfall First day where solid precipitation flux exceeded a given threshold (v0.1)

The first day where the solid precipitation flux exceeded a given threshold during a time period.

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.fraction_over_precip_doy_thresh_Indicator_Process

Bases: XclimIndicatorBase

fraction_over_precip_doy_thresh (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

Bases: XclimIndicatorBase

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

Bases: XclimIndicatorBase

freezethaw_spell_frequency Freeze-thaw spell frequency (v0.1)

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

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.

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

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

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

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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

Bases: XclimIndicatorBase

freezethaw_spell_max_length Maximal length of freeze-thaw spells (v0.1)

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

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.

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

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

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

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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

Bases: XclimIndicatorBase

freezethaw_spell_mean_length Freeze-thaw spell mean length (v0.1)

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

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.

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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

Bases: XclimIndicatorBase

freezing_degree_days Freezing degree days (v0.1)

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

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

Bases: XclimIndicatorBase

freq_analysis Return level from frequency analysis (v0.1)

Frequency analysis on the basis of a given mode and distribution.

Parameters:

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

    NetCDF Files or archive (tar/zip) containing netCDF files. The amount of water, in all phases, flowing in the river channel and flood plain. (Info)

  • mode ({'min', 'max'}, 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, e.g. 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.streamflow.FREQ_ANALYSIS object>
class finch.processes.virtual.indicators.freshet_start_Indicator_Process

Bases: XclimIndicatorBase

freshet_start Day of year of spring freshet start (v0.1)

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

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.

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

  • 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.FRESHET_START object>
class finch.processes.virtual.indicators.frost_days_Indicator_Process

Bases: XclimIndicatorBase

frost_days Frost days (v0.1)

Number of days where the daily minimum temperature is below a given 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) – 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

Bases: XclimIndicatorBase

frost_free_season_end Frost free season end (v0.1)

First day when the temperature is below a given threshold for a given number of consecutive days after a median 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.

  • 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

Bases: XclimIndicatorBase

frost_free_season_length Frost free season length (v0.1)

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

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.

  • 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.FROST_FREE_SEASON_LENGTH object>
class finch.processes.virtual.indicators.frost_free_season_start_Indicator_Process

Bases: XclimIndicatorBase

frost_free_season_start Frost free season start (v0.1)

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

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

Bases: XclimIndicatorBase

frost_season_length Frost season length (v0.1)

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

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.

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

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

  • 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.FROST_SEASON_LENGTH object>
class finch.processes.virtual.indicators.growing_degree_days_Indicator_Process

Bases: XclimIndicatorBase

growing_degree_days Growing degree days (v0.1)

The cumulative degree days for days when the average temperature is above a given 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.GROWING_DEGREE_DAYS object>
class finch.processes.virtual.indicators.growing_season_end_Indicator_Process

Bases: XclimIndicatorBase

growing_season_end Growing season end (v0.1)

The first day when the temperature is below a certain threshold for a certain number of consecutive days after a given 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.

  • 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

Bases: XclimIndicatorBase

growing_season_length Growing season length (v0.1)

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

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.

  • 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.GROWING_SEASON_LENGTH object>
class finch.processes.virtual.indicators.growing_season_start_Indicator_Process

Bases: XclimIndicatorBase

growing_season_start Growing season start (v0.1)

The first day when the temperature exceeds a certain threshold for a given number of consecutive 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.GROWING_SEASON_START object>
class finch.processes.virtual.indicators.heat_index_Indicator_Process

Bases: XclimIndicatorBase

heat_index Heat index (v0.1)

The heat index is an estimate of the temperature felt by a person in the shade when relative humidity is taken into account.

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

Bases: XclimIndicatorBase

heat_wave_frequency Heat wave frequency (v0.1)

Number of heat waves. A heat wave occurs when daily minimum and maximum temperatures exceed given thresholds for a 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: “>”.

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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

Bases: XclimIndicatorBase

heat_wave_index Heat wave index (v0.1)

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

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.

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

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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

Bases: XclimIndicatorBase

heat_wave_max_length Heat wave maximum length (v0.1)

Total duration of heat waves. A heat wave occurs when daily minimum and maximum temperatures exceed given thresholds for a 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: “>”.

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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

Bases: XclimIndicatorBase

heat_wave_total_length Heat wave total length (v0.1)

Maximum length of heat waves. A heat wave occurs when daily minimum and maximum temperatures exceed given thresholds for a 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: “>”.

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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

Bases: XclimIndicatorBase

heating_degree_days Heating degree days (v0.1)

The cumulative degree days for days when the mean daily temperature is below a given threshold and buildings must be 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

Bases: XclimIndicatorBase

high_precip_low_temp Days with precipitation and cold temperature (v0.1)

Number of days with precipitation above a given threshold and temperature below a given 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)

  • 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

Bases: XclimIndicatorBase

hot_spell_frequency Hot spell frequency (v0.1)

Number of hot spells events within a given period. A hot spell occurs when the daily maximum temperatureexceeds a given threshold for 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.

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

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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

Bases: XclimIndicatorBase

hot_spell_max_length Hot spell maximum length (v0.1)

Maximum length of hot spells events within a given period. A hot spell occurs when the daily maximum temperature exceeds a given threshold for 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.

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

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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

Bases: XclimIndicatorBase

huglin_index Huglin heliothermal index (v0.1)

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

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.

  • method ({'jones', 'smoothed', 'icclim'}, optional) – The formula to use for the latitude coefficient calculation.

  • 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

Bases: XclimIndicatorBase

humidex Humidex (v0.1)

The humidex describes the temperature felt by a person when relative humidity is taken into account. It can be interpreted as the equivalent temperature felt 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 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.HUMIDEX object>
class finch.processes.virtual.indicators.hurs_Indicator_Process

Bases: XclimIndicatorBase

hurs Relative humidity from temperature, specific humidity, and pressure (v0.1)

Calculation of relative humidity from temperature, specific humidity, and pressure using the saturation vapour 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 ({'bohren98', 'wmo08', 'tetens30', 'goffgratch46', 'sonntag90'}, 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

Bases: XclimIndicatorBase

hurs_fromdewpoint Relative humidity from temperature and dewpoint temperature (v0.1)

Calculation of relative humidity from temperature and dew point using the saturation vapour 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 temperature. (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 ({'bohren98', 'wmo08', 'tetens30', 'goffgratch46', 'sonntag90'}, 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

Bases: XclimIndicatorBase

huss_fromdewpoint Specific humidity from dew point temperature and pressure (v0.1)

Calculation of the specific humidity from dew point temperature and pressure using the saturation vapour pressure.

Parameters:

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

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

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

    NetCDF Files or archive (tar/zip) containing netCDF files. Air pressure at surface (Info)

  • method ({'tetens30', 'wmo08', 'goffgratch46', 'sonntag90'}, optional) – Method to compute the saturation vapour 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.hxmax_days_above_Indicator_Process

Bases: XclimIndicatorBase

hxmax_days_above Calculate the number of times some condition is met. (v0.1)

First, the threshold is transformed to the same standard_name and units as the input data. Then the thresholding is performed as condition(data, threshold), i.e. if condition is <, then this counts the number of times data < threshold. Finally, count the number of occurrences when condition is met.

Parameters:

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

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

  • threshold (string, optional) – Threshold.

  • 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.

  • op ({'!=', 'lt', 'ne', 'ge', 'le', 'gt', 'eq', '<', '>=', '<=', ...}, optional) – Logical operator. e.g. arr > thresh.

  • 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.humidex.HXMAX_DAYS_ABOVE object>
class finch.processes.virtual.indicators.ice_days_Indicator_Process

Bases: XclimIndicatorBase

ice_days Ice days (v0.1)

Number of days where the daily maximum temperature is below 0degC

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

Bases: XclimIndicatorBase

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]. Wind is smoothened using a Lanczos filter approach.

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

Bases: XclimIndicatorBase

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

Bases: XclimIndicatorBase

last_snowfall Last day where solid precipitation flux exceeded a given threshold (v0.1)

The last day where the solid precipitation flux exceeded a given threshold during a time period.

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

Bases: XclimIndicatorBase

last_spring_frost Last spring frost (v0.1)

The last day when minimum temperature is below a given threshold for a certain number of days, limited by a final 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.

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

  • 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

Bases: XclimIndicatorBase

latitude_temperature_index Latitude temperature index (v0.1)

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

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

Bases: XclimIndicatorBase

liquid_precip_ratio Fraction of liquid 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 given 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

Bases: XclimIndicatorBase

liquidprcptot Total accumulated liquid precipitation. (v0.1)

Total accumulated liquid precipitation. Precipitation is considered liquid when the average daily temperature is above 0degC.

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.longwave_upwelling_radiation_from_net_downwelling_Indicator_Process

Bases: XclimIndicatorBase

longwave_upwelling_radiation_from_net_downwelling Upwelling longwave radiation (v0.1)

Parameters:

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

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

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

    NetCDF Files or archive (tar/zip) containing netCDF files. Incoming longwave radiation. (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.LONGWAVE_UPWELLING_RADIATION_FROM_NET_DOWNWELLING object>
class finch.processes.virtual.indicators.max_n_day_precipitation_amount_Indicator_Process

Bases: XclimIndicatorBase

max_n_day_precipitation_amount maximum n-day total precipitation (v0.1)

Maximum of the moving sum of daily precipitation for a 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)

  • 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

Bases: XclimIndicatorBase

max_pr_intensity Maximum precipitation intensity over time window (v0.1)

Maximum precipitation intensity over a given rolling time window.

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

Bases: XclimIndicatorBase

maximum_consecutive_warm_days Maximum consecutive warm days (v0.1)

Maximum number of consecutive days where the maximum daily temperature exceeds 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.

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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

Bases: XclimIndicatorBase

mean_radiant_temperature Mean radiant temperature (v0.1)

The average temperature of solar and thermal radiation incident on the body’s exterior.

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 ({'average', 'sunlit', '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

Bases: XclimIndicatorBase

melt_and_precip_max Water equivalent maximum from precipitation and snow melt (v0.1)

Maximum water input from precipitation flux and snow melt over a given window of days.

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

Bases: XclimIndicatorBase

potential_evapotranspiration Potential evapotranspiration (v0.1)

The potential for water evaporation from soil and transpiration by plants if the water supply is sufficient, calculated with 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. Surface wind speed. (Info)

  • method ({'FAO_PM98', 'MB05', 'allen98', 'hargreaves85', 'HG85', 'TW48', 'BR65', 'thornthwaite48', 'baierrobertson65', 'mcguinnessbordne05'}, 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

Bases: XclimIndicatorBase

prcptot Total accumulated precipitation (solid and liquid) (v0.1)

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

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

Bases: XclimIndicatorBase

prlp Rainfall approximation (v0.1)

Liquid precipitation estimated from total precipitation and temperature with a given method and temperature 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) – Freezing point temperature. Non-scalar values are not allowed with method ‘brown’.

  • method ({'binary', 'brown', 'auer'}, 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

Bases: XclimIndicatorBase

prsn Snowfall approximation (v0.1)

Solid precipitation estimated from total precipitation and temperature with a given method and temperature 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) – Freezing point temperature. Non-scalar values are not allowed with method “brown”.

  • method ({'binary', 'brown', 'auer'}, 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

Bases: XclimIndicatorBase

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

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

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

Bases: XclimIndicatorBase

rb_flashiness_index Richards-Baker Flashiness Index (v0.1)

Measurement of flow oscillations relative to average flow, quantifying the frequency and speed of flow changes.

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

Bases: XclimIndicatorBase

rprctot Proportion of accumulated precipitation arising from convective processes (v0.1)

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

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.

  • 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.RPRCTOT object>
class finch.processes.virtual.indicators.rx1day_Indicator_Process

Bases: XclimIndicatorBase

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

Maximum total daily precipitation for a 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)

  • 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

Bases: XclimIndicatorBase

sdii Simple Daily Intensity Index (v0.1)

Average precipitation for days with daily precipitation above a given 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.

  • 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.SDII object>
class finch.processes.virtual.indicators.sea_ice_area_Indicator_Process

Bases: XclimIndicatorBase

sea_ice_area Sea ice area (v0.1)

A measure of total ocean surface covered by sea ice.

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

Bases: XclimIndicatorBase

sea_ice_extent Sea ice extent (v0.1)

A measure of the extent of all areas where sea ice concentration exceeds a threshold.

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.shortwave_upwelling_radiation_from_net_downwelling_Indicator_Process

Bases: XclimIndicatorBase

shortwave_upwelling_radiation_from_net_downwelling Upwelling shortwave radiation (v0.1)

Parameters:

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

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

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

    NetCDF Files or archive (tar/zip) containing netCDF files. Incoming shortwave radiation. (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.SHORTWAVE_UPWELLING_RADIATION_FROM_NET_DOWNWELLING object>
class finch.processes.virtual.indicators.snd_max_doy_Indicator_Process

Bases: XclimIndicatorBase

snd_max_doy Day of year of maximum snow depth (v0.1)

Day of the year when snow depth reaches its maximum value.

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.snd_season_end_Indicator_Process

Bases: XclimIndicatorBase

snd_season_end End date of continuous snow depth cover (v0.1)

The first date on which snow depth is below a given threshold for a given number of 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.SND_SEASON_END object>
class finch.processes.virtual.indicators.snd_season_length_Indicator_Process

Bases: XclimIndicatorBase

snd_season_length Snow cover duration (depth) (v0.1)

Number of days when the snow depth is greater than or equal to a 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.

  • 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.land._snow.SND_SEASON_LENGTH object>
class finch.processes.virtual.indicators.snd_season_start_Indicator_Process

Bases: XclimIndicatorBase

snd_season_start Start date of continuous snow depth cover (v0.1)

The first date on which snow depth is greater than or equal to a given threshold for a given number of 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.SND_SEASON_START object>
class finch.processes.virtual.indicators.snd_to_snw_Indicator_Process

Bases: XclimIndicatorBase

snd_to_snw Surface snow amount (v0.1)

Parameters:

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

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

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

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

  • const (string, optional) – Constant snow density [kg/m^3] const is only used if snr is 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.SND_TO_SNW object>
class finch.processes.virtual.indicators.snow_depth_Indicator_Process

Bases: XclimIndicatorBase

snow_depth Mean snow depth (v0.1)

Mean of daily snow depth.

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

Bases: XclimIndicatorBase

snow_melt_we_max Maximum snow melt (v0.1)

The water equivalent of the maximum snow melt.

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

Bases: XclimIndicatorBase

snw_max Maximum snow amount (v0.1)

The maximum snow amount equivalent on the surface.

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

Bases: XclimIndicatorBase

snw_max_doy Day of year of maximum snow amount (v0.1)

The day of year when snow amount equivalent on the surface reaches its maximum.

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.snw_season_end_Indicator_Process

Bases: XclimIndicatorBase

snw_season_end End date of continuous snow amount cover (v0.1)

The first date on which snow amount is below a given threshold for a given number of consecutive days.

Parameters:

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

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

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

  • window (integer, optional) – Minimum number of days with snow water 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.SNW_SEASON_END object>
class finch.processes.virtual.indicators.snw_season_length_Indicator_Process

Bases: XclimIndicatorBase

snw_season_length Snow cover duration (amount) (v0.1)

Number of days when the snow amount is greater than or equal to a given threshold.

Parameters:

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

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

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

  • 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.land._snow.SNW_SEASON_LENGTH object>
class finch.processes.virtual.indicators.snw_season_start_Indicator_Process

Bases: XclimIndicatorBase

snw_season_start Start date of continuous snow amount cover (v0.1)

The first date on which snow amount is greater than or equal to a given threshold for a given number of consecutive days.

Parameters:

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

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

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

  • window (integer, optional) – Minimum number of days with snow water 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.SNW_SEASON_START object>
class finch.processes.virtual.indicators.snw_to_snd_Indicator_Process

Bases: XclimIndicatorBase

snw_to_snd Surface snow depth (v0.1)

Parameters:

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

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

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

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

  • const (string, optional) – Constant snow density [kg/m^3] const is only used if snr is 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.SNW_TO_SND object>
class finch.processes.virtual.indicators.solidprcptot_Indicator_Process

Bases: XclimIndicatorBase

solidprcptot Total accumulated solid precipitation. (v0.1)

Total accumulated solid precipitation. Precipitation is considered solid when the average daily temperature is at or below 0degC.

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

Bases: XclimIndicatorBase

spei Standardized Precipitation Evapotranspiration Index (SPEI) (v0.1)

Water budget (precipitation - evapotranspiration) over a moving window, normalized such that the SPEI averages to 0 for the calibration data. The window unit X is the minimal time period defined by the resampling frequency.

Parameters:

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

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

  • wb_cal (string, optional) – Daily water budget used for calibration.

  • 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', 'fisk'}, optional) – Name of the univariate distribution. (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. Available methods vary with the distribution: ‘gamma’:{‘APP’, ‘ML’}, ‘fisk’:{‘ML’}

  • 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

Bases: XclimIndicatorBase

spi Standardized Precipitation Index (SPI) (v0.1)

Precipitation over a moving window, normalized such that SPI averages to 0 for the calibration data. The window unit X is the minimal time period defined by the resampling frequency.

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 (string, optional) – Daily precipitation used for calibration. Usually this is a temporal subset of pr over some reference period.

  • 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', 'fisk'}, optional) – Name of the univariate distribution. (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.tg10p_Indicator_Process

Bases: XclimIndicatorBase

tg10p Days with mean temperature below the 10th percentile (v0.1)

Number of days with 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

Bases: XclimIndicatorBase

tg90p Days with mean temperature above the 90th percentile (v0.1)

Number of days with mean temperature above 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

Bases: XclimIndicatorBase

tg Mean temperature (v0.1)

The average daily temperature assuming a symmetrical temperature distribution (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

Bases: XclimIndicatorBase

tg_days_above Number of days with mean temperature above a given threshold (v0.1)

The number of days with mean temperature above a given 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.

  • 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.TG_DAYS_ABOVE object>
class finch.processes.virtual.indicators.tg_days_below_Indicator_Process

Bases: XclimIndicatorBase

tg_days_below Number of days with mean temperature below a given threshold (v0.1)

The number of days with mean temperature below a given 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.

  • 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.TG_DAYS_BELOW object>
class finch.processes.virtual.indicators.tg_max_Indicator_Process

Bases: XclimIndicatorBase

tg_max Maximum of mean temperature (v0.1)

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

Bases: XclimIndicatorBase

tg_mean Mean temperature (v0.1)

Mean 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_MEAN object>
class finch.processes.virtual.indicators.tg_min_Indicator_Process

Bases: XclimIndicatorBase

tg_min Minimum of 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

Bases: XclimIndicatorBase

thawing_degree_days Thawing degree days (v0.1)

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

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

Bases: XclimIndicatorBase

tn10p Days with minimum temperature below the 10th percentile (v0.1)

Number of days with 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

Bases: XclimIndicatorBase

tn90p Days with minimum temperature above the 90th percentile (v0.1)

Number of days with minimum temperature above 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

Bases: XclimIndicatorBase

tn_days_above Number of days with minimum temperature above a given threshold (v0.1)

The number of days with minimum temperature above a given 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.TN_DAYS_ABOVE object>
class finch.processes.virtual.indicators.tn_days_below_Indicator_Process

Bases: XclimIndicatorBase

tn_days_below Number of days with minimum temperature below a given threshold (v0.1)

The number of days with minimum temperature below a given 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 ({'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.TN_DAYS_BELOW object>
class finch.processes.virtual.indicators.tn_max_Indicator_Process

Bases: XclimIndicatorBase

tn_max Maximum of minimum temperature (v0.1)

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

Bases: XclimIndicatorBase

tn_mean Mean of 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

Bases: XclimIndicatorBase

tn_min 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

Bases: XclimIndicatorBase

tropical_nights Tropical nights (v0.1)

Number of days where minimum temperature is above a given 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

Bases: XclimIndicatorBase

tx10p Days with maximum temperature below the 10th percentile (v0.1)

Number of days with 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

Bases: XclimIndicatorBase

tx90p Days with maximum temperature above the 90th percentile (v0.1)

Number of days with maximum temperature above 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

Bases: XclimIndicatorBase

tx_days_above Number of days with maximum temperature above a given threshold (v0.1)

The number of days with maximum temperature above a given 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.

  • 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_DAYS_ABOVE object>
class finch.processes.virtual.indicators.tx_days_below_Indicator_Process

Bases: XclimIndicatorBase

tx_days_below Number of days with maximum temperature below a given threshold (v0.1)

The number of days with maximum temperature below a given 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.

  • 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.TX_DAYS_BELOW object>
class finch.processes.virtual.indicators.tx_max_Indicator_Process

Bases: XclimIndicatorBase

tx_max Maximum temperature (v0.1)

Maximum 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

Bases: XclimIndicatorBase

tx_mean Mean of maximum temperature (v0.1)

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

Bases: XclimIndicatorBase

tx_min Minimum of maximum temperature (v0.1)

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

Bases: XclimIndicatorBase

tx_tn_days_above Number of days with daily minimum and maximum temperatures exceeding thresholds (v0.1)

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

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

Bases: XclimIndicatorBase

utci Universal Thermal Climate Index (UTCI) (v0.1)

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 ({'average', 'sunlit', '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

Bases: XclimIndicatorBase

warm_and_dry_days Warm and dry days (v0.1)

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

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

Bases: XclimIndicatorBase

warm_and_wet_days Warm and wet days (v0.1)

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

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

Bases: XclimIndicatorBase

warm_spell_duration_index Warm spell duration index (v0.1)

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

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.

  • resample_before_rl (boolean, optional) – Determines if the resampling should take place before or after the run length encoding (or a similar algorithm) is applied to runs.

  • 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

Bases: XclimIndicatorBase

water_budget Water budget (v0.1)

Precipitation minus potential evapotranspiration as a measure of an approximated surface water budget.

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. 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._conversion.WATER_BUDGET object>
class finch.processes.virtual.indicators.water_budget_from_tas_Indicator_Process

Bases: XclimIndicatorBase

water_budget_from_tas Water budget (v0.1)

Precipitation minus potential evapotranspiration as a measure of an approximated surface water budget, where the potential evapotranspiration is 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. Surface wind speed. (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

Bases: XclimIndicatorBase

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

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

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

Bases: XclimIndicatorBase

wetdays Number of wet days (v0.1)

The number of days with daily precipitation at or above a given 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.

  • 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.WETDAYS object>
class finch.processes.virtual.indicators.wetdays_prop_Indicator_Process

Bases: XclimIndicatorBase

wetdays_prop Proportion of wet days (v0.1)

The proportion of days with daily precipitation at or above a given 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.

  • 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.WETDAYS_PROP object>
class finch.processes.virtual.indicators.wind_chill_Indicator_Process

Bases: XclimIndicatorBase

wind_chill Wind chill (v0.1)

Wind chill factor is an index that equates to how cold an average person feels. It is calculated from the temperature and the wind speed at 10 m. As defined by Environment and Climate Change Canada, a second formula is used for light winds. The standard formula is otherwise the same as used in the United States.

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

Bases: XclimIndicatorBase

wind_speed_from_vector Wind speed and direction from vector (v0.1)

Calculation of the magnitude and direction of the wind speed from the two components west-east and south-north.

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

Bases: XclimIndicatorBase

wind_vector_from_speed Wind vector from speed and direction (v0.1)

Calculation of the two components (west-east and north-south) of the wind from the magnitude of its speed and direction of origin.

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

Bases: XclimIndicatorBase

windy_days Windy days (v0.1)

Number of days with surface wind speed at or 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

Bases: XclimIndicatorBase

winter_storm Winter storm days (v0.1)

Number of days with snowfall accumulation greater or equal to threshold (default: 25 cm).

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>

References

[WHH10]

Tim Woollings, Abdel Hannachi, and Brian Hoskins. Variability of the North Atlantic eddy-driven jet stream. Quarterly Journal of the Royal Meteorological Society, 136(649):856–868, 2010. _eprint: https://onlinelibrary.wiley.com/doi/pdf/10.1002/qj.625. URL: https://onlinelibrary.wiley.com/doi/abs/10.1002/qj.625 (visited on 2022-07-29), doi:10.1002/qj.625.

[FFDI-FMBJ06] (1,2,3,4)

Klara Finkele, Graham A Mills, Grant Beard, and David A Jones. National gridded drought factors and comparison of two soil moisture deficit formulations used in prediction of forest fire danger index in australia. Australian Meteorological Magazine, 55(3):183–197, 2006.