uxarray.concat

Contents

uxarray.concat#

uxarray.concat(objs, dim, **kwargs)#

concatenate uxarray objects along a new or existing dimension.

Parameters:
  • objs (iterable of UxDataArray or UxDataset) – uxarray objects to concatenate together. Each object is expected to consist of variables and coordinates with matching shapes except for along the concatenated dimension, and to have underlying grids which compare as equal. The first object’s uxgrid is attached to the result.

  • dim (Hashable or Variable or DataArray or pandas.Index) – Name of the dimension to concatenate along. This can either be a new dimension name, in which case it is added along axis=0, or an existing dimension name, in which case the location of the dimension is unchanged. If dimension is provided as a Variable, DataArray or Index, its name is used as the dimension to concatenate along and the values are added as a coordinate.

  • **kwargs (dict, optional) – All additional kwargs forwarded directly to xarray.concat().

Returns:

concatenated – Concatenated uxarray object with the same type as the input objects.

Return type:

type of objs