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 verification data 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.
observations

Dictionary of verification data 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_observations(xobj, name) Add a verification data with which to verify the initialized ensemble.
HindcastEnsemble.add_reference
add_uninitialized(xobj) Add a companion uninitialized ensemble for comparison to verification data.
HindcastEnsemble.compute_metric
HindcastEnsemble.compute_persistence
HindcastEnsemble.compute_uninitialized
get_initialized() Returns the xarray dataset for the initialized ensemble.
get_observations([name]) Returns xarray Datasets of the observations/verification data.
HindcastEnsemble.get_reference
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.
verify([name, reference, metric, …]) Verifies the initialized ensemble against observations/verification data.