HindcastEnsemble.compute_metric(refname=None, metric='pearson_r', comparison='e2r', max_dof=False)[source]

Compares the initialized ensemble to a given reference.

This will automatically run the comparison against all shared variables between the initialized ensemble and reference.

  • refname (str) – Name of reference to compare to. If None, compare to all references.
  • metric (str, default 'pearson_r') – Metric to apply in the comparison.
  • comparison (str, default 'e2r') – How to compare to the reference. (‘e2r’ for ensemble mean to reference. ‘m2r’ for each individual member to reference)
  • max_dof (bool, default False) – If True, maximize the degrees of freedom for each lag calculation.

Dataset of comparison results (if comparing to one reference), or dictionary of Datasets with keys corresponding to reference name.