xarray_dimensions

File Purpose: tools related to xarray dimensions

Functions

is_iterable_dim(value, *[, min_length])	returns whether value represents multiple values (of a dimension).
join_along_dimension(dimension, arrays[, ...])	returns xr.concat(arrays, dimension).
take_along_dimension(dimension, array[, at, ...])	returns something like: [array.sel({dimension: val}) for val in `at`]
take_along_dimensions(array, dimensions, *)	returns result of taking array along each of these dimensions, in order.
xarray_assign(array[, coords, attrs, name, ...])	array.assign_coords(coords).assign_attrs(attrs).rename(name)
xarray_broadcastable_array(array, dims)	return broadcastable version of array, standardizing dims to the list provided.
xarray_broadcastable_from_dataset(dataset[, ...])	return dict of broadcastable versions of data_var(s) from dataset, standardizing data vars' dims.
xarray_closeness(array[, dim])	computes "closeness" along each dim: (array.isel(dim=0)/array).std()
xarray_coarsened(array, dim, window_len[, ...])	construct a coarsened version of array, where dim is coarsened by window_len,
xarray_drop_unused_dims(dataset[, only])	dataset.drop_dims(dims which do not appear in any of the data_vars).
xarray_drop_vars(dataset, names, *[, ...])	dataset.drop_vars(names, errors=errors), then drop any unused dims.
xarray_ensure_dims(array, coords, *[, ...])	return array but ensure these coords are dimensions.
xarray_from_broadcastable(array, ...[, ...])	return xarray from broadcastable values, using dims/coords/attrs from input.
xarray_popped(ds, var)	returns (ds[var], copy of ds without var)
xarray_promote_dim(array, coord, *coords_as_args)	Promote this coord (or these coords) to be a dimension, if it isn't already.
xarray_rename(array[, names])	return array.rename(names, **more_names), but skip any names not found in array.coords.
xarray_squeeze(array[, dim, keep, drop])	return array but drop redundant dims.
xarray_squeeze_close(array[, dim, tol, ...])	return array but drop redundant dims, with an tolerance when checking equality.