Ctrl+K

climpred.preprocessing.shared.load_hindcast

Contents

climpred.preprocessing.shared.load_hindcast#

climpred.preprocessing.shared.load_hindcast(inits=range(1961, 1965), members=range(1, 3), preprocess: ~typing.Callable | None = None, lead_offset: int = 1, parallel: bool = True, engine: str | None = None, get_path: ~typing.Callable = <function get_path>, **get_path_kwargs: ~typing.Any) → DataArray | Dataset[source]#

Concat multi-member, multi-initialization hindcast experiment.

Into one xarray.Dataset compatible with climpred.

Parameters:

  • inits (list, array) – List of initializations to be loaded. Defaults to range(1961, 1965).

  • members (list, array) – List of initializations to be loaded. Defaults to range(1, 3).

  • preprocess (Callable) – preprocess function accepting and returning xarray.Dataset only. To be passed to xarray.open_dataset(). Defaults to None.

  • parallel (bool) – passed to xr.open_mfdataset. Defaults to True.

  • engine (str) – passed to xr.open_mfdataset. Defaults to None.

  • get_path (callable) – get_path function specific to modelling center output format. Defaults to get_path().

  • **get_path_kwargs (dict) – parameters passed to **get_path.

Returns:

climpred compatible dataset with dims – member, init, lead.

Contents