climpred.preprocessing.shared.rename_to_climpred_dims

climpred.preprocessing.shared.rename_to_climpred_dims#

climpred.preprocessing.shared.rename_to_climpred_dims(xro: DataArray | Dataset) → DataArray | Dataset[source]#

Rename existing dimension to CLIMPRED_ENSEMBLE_DIMS.

This function attempts to autocorrect dimension names to climpred standards. e.g., ensemble_member becomes member and lead_time becomes lead, and time gets renamed to lead.

Parameters:

  • xro (xr.Dataset) – input from DCPP via intake-esm

  • containing dimension names like `dcpp_init_year`, `time`, `member_id`.

Returns:

climpred compatible with dimensions – member, init, lead.

Contents