datatree.DataTree.rename_dims

Attention

This repository has been archived. Please use xarray.DataTree instead.

datatree.DataTree.rename_dims#

DataTree.rename_dims(dims_dict: Mapping[Any, Hashable] | None = None, **dims: Hashable) Self[source]#

Returns a new object with renamed dimensions only.

Parameters:
  • dims_dict (dict-like, optional) – Dictionary whose keys are current dimension names and whose values are the desired names. The desired names must not be the name of an existing dimension or Variable in the Dataset.

  • **dims (optional) – Keyword form of dims_dict. One of dims_dict or dims must be provided.

Returns:

renamed (Dataset) – Dataset with renamed dimensions.

See also

Dataset.swap_dims, Dataset.rename, Dataset.rename_vars, DataArray.rename