datatree.DataTree.rename

Attention

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

datatree.DataTree.rename#

DataTree.rename(name_dict: Mapping[Any, Hashable] | None = None, **names: Hashable) Self[source]#

Returns a new object with renamed variables, coordinates and dimensions.

Parameters:
  • name_dict (dict-like, optional) – Dictionary whose keys are current variable, coordinate or dimension names and whose values are the desired names.

  • **names (optional) – Keyword form of name_dict. One of name_dict or names must be provided.

Returns:

renamed (Dataset) – Dataset with renamed variables, coordinates and dimensions.

See also

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