PlasmaCalcs.tools.xarray_tools.xarray_dimensions.is_iterable_dim

PlasmaCalcs.tools.xarray_tools.xarray_dimensions.is_iterable_dim(value, *, min_length=None)

returns whether value represents multiple values (of a dimension).

if value.ndim exists,

return False if ndim==0,

else True if ndim > 0,

else raise DimensionalityError.

# else, return whether iter(value) succeeds. # <– no longer used; use is_scalar from xr.

else, return (not xr.core.utils.is_scalar(value))

min_length: None or int

if provided, before returning True, require that len(value) >= min_length.