climpred.classes.PredictionEnsemble

climpred.classes.PredictionEnsemble#

class climpred.classes.PredictionEnsemble(initialized: DataArray | Dataset)[source]#

The main object PredictionEnsemble.

This is the super of both PerfectModelEnsemble and HindcastEnsemble. This cannot be called directly by a user, but should house functions that both ensemble types can use.

Associated xarray.Dataset are stored in:

  • PredictionEnsemble._datasets["initialized"]

  • PredictionEnsemble._datasets["uninitialized"]

  • PredictionEnsemble._datasets["control"] in PerfectModelEnsemble

  • PredictionEnsemble._datasets[observations"] in HindcastEnsemble

__init__(initialized: DataArray | Dataset)[source]#

Create a PredictionEnsemble object.

Methods

__init__(initialized)

Create a PredictionEnsemble object.

equals(other)

Check if PredictionEnsemble is equal to other.

get_initialized()

Return the xarray.Dataset for the initialized ensemble.

get_uninitialized()

Return the xarray.Dataset for the uninitialized ensemble.

identical(other)

Check if PredictionEnsemble is identical to other.

plot([variable, ax, show_members, cmap, x])

Plot datasets from PredictionEnsemble.

remove_seasonality([seasonality])

Remove seasonal cycle from PredictionEnsemble.

smooth([smooth_kws, how])

Smooth in space and/or aggregate in time in PredictionEnsemble.

Attributes

chunks

Return chunks of PredictionEnsemble.

chunksizes

Return chunksizes of PredictionEnsemble.

coords

Return coordinates of PredictionEnsemble.

data_vars

Return data variables of PredictionEnsemble.

dims

Return dimension of PredictionEnsemble.

mathType

alias of Union[int, float, ndarray, DataArray, Dataset]

nbytes

Bytes sizes of all PredictionEnsemble._datasets.

sizes

Return sizes of PredictionEnsemble.