Metric Calculations API

Metric calculations used in RCMIP

pyrcmip.metric_calculations.calculate_transient_climate_response(assessed_ranges, res_calc, norm_period, evaluation_period, unit)

Calculate the transient climate response (TCR)

Parameters

  • assessed_ranges (pyrcmip.assessed_ranges.AssessedRanges) – Assessed ranges instance

  • res_calc (scmdata.ScmRun) – Results from which the TCR is to be derived

  • norm_period (list) – Years to use for normalising the data before calculating the TCR

  • evaluation_period (list) – Years to use when evaluating the TCR

  • unit (str) – Unit in which the TCR should be returned

Returns

TCR with other relevant model metadata

Return type

pd.DataFrame

Raises

NotImplementedError – The evaluation period is not the year 1920 i.e. the experiment does not match the CMIP6 specifications