climpred.classes.HindcastEnsemble

class climpred.classes.HindcastEnsemble(xobj)[source]

An object for climate prediction ensembles initialized by a data-like product.

HindcastEnsemble is a sub-class of PredictionEnsemble. It tracks all simulations/observations associated with the prediction ensemble for easy computation across multiple variables and products.

This object is built on xarray and thus requires the input object to be an xarray Dataset or DataArray.

__init__(xobj)[source]

Create a HindcastEnsemble object by inputting output from a prediction ensemble in xarray format.

Parameters:xobj (xarray object) – decadal prediction ensemble output.
reference

Dictionary of various reference observations/simulations to associate with the decadal prediction ensemble.

uninitialized

Dictionary of companion (or bootstrapped) uninitialized ensemble run.

Methods

__init__(xobj) Create a HindcastEnsemble object by inputting output from a prediction ensemble in xarray format.
add_reference(xobj, name) Add a reference product for comparison to the initialized ensemble.
add_uninitialized(xobj) Add a companion uninitialized ensemble for comparison to references.
compute_metric([refname, metric, …]) Compares the initialized ensemble to a given reference.
compute_persistence([refname, metric, max_dof]) Compute a simple persistence forecast for a reference.
compute_uninitialized([refname, metric, …]) Compares the uninitialized ensemble to a given reference.
get_initialized() Returns the xarray dataset for the initialized ensemble.
get_reference([name]) Returns the given reference(s).
get_uninitialized() Returns the xarray dataset for the uninitialized ensemble.
smooth([smooth_kws]) Smooth all entries of PredictionEnsemble in the same manner to be able to still calculate prediction skill afterwards.