datatree.DataTree.reset_index

Attention

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

datatree.DataTree.reset_index#

DataTree.reset_index(dims_or_levels: Hashable | Sequence[Hashable], *, drop: bool = False) → Self[source]#

Reset the specified index(es) or multi-index level(s).

This legacy method is specific to pandas (multi-)indexes and 1-dimensional “dimension” coordinates. See the more generic drop_indexes() and set_xindex() method to respectively drop and set pandas or custom indexes for arbitrary coordinates.

Parameters:

  • dims_or_levels (Hashable or Sequence of Hashable) – Name(s) of the dimension(s) and/or multi-index level(s) that will be reset.

  • drop (bool, default: False) – If True, remove the specified indexes and/or multi-index levels instead of extracting them as new coordinates (default: False).

Returns:

obj (Dataset) – Another dataset, with this dataset’s data but replaced coordinates.

See also

Dataset.set_index, Dataset.set_xindex, Dataset.drop_indexes