climpred.preprocessing.shared.load_hindcast

climpred.preprocessing.shared.load_hindcast(inits=range(1961, 1965), members=range(1, 3), preprocess=None, lead_offset=1, parallel=True, engine=None, get_path=<function get_path>, **get_path_kwargs)[source]

Load multi-member, multi-initialization hindcast experiment into one xr.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 (function) – preprocess function accepting and returning xr.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.

  • note:: (.) – To load MPI-ESM grb files, pass engine=’pynio’.

  • 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.

Return type

xr.Dataset