PlasmaCalcs.tools.xarray_tools.xarray_indexing.xarray_varmax

PlasmaCalcs.tools.xarray_tools.xarray_indexing.xarray_varmax(ds, *, promote_dims_if_needed=True)

return (array of) var name(s) for var with maximum values in ds.

equivalent: xarray_cmax(ds.to_dataarray(), ‘variable’)

ds: xarray.Dataset

dataset to find maximum value in.

promote_dims_if_needed: bool

whether to promote non-dimension coords to dimensions.

if False, raise DimensionKeyError if any relevant coord is not already a dimension.