xarray_from_broadcastable

PlasmaCalcs.tools.xarray_tools.xarray_dimensions.xarray_from_broadcastable(array, broadcastable, *, dims=None, squeeze=True)

return xarray from broadcastable values, using dims/coords/attrs from input.

array: xarray.DataArray or xarray.Dataset

read relevant dims, coords, and attrs from this array; copy to result.

broadcastable: array (possibly numpy array) or dict of arrays

result’s data comes from this array(s).

single array –> result.data = array.

dict of arrays –> result.data = array[v] for v in array. # [TODO] not yet implemented.

dims: None or list of str

list of dim names for broadcastable’s dims. len(dims) == broadcastable.ndim.

None –> use array.dims.

squeeze: bool

whether to squeeze away dims with size 1 in broadcastable.

True –> result.dims will only include dims with size > 1 in broadcastable.