🍾 Xarray is now 10 years old! 🎉

xarray.Variable.concat

xarray.Variable.concat#

classmethod Variable.concat(variables, dim='concat_dim', positions=None, shortcut=False, combine_attrs='override')[source]#

Concatenate variables along a new or existing dimension.

Parameters:
  • variables (iterable of Variable) – Arrays to stack together. Each variable is expected to have matching dimensions and shape except for along the stacked dimension.

  • dim (str or DataArray, optional) – Name of the dimension to stack 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. Where to insert the new dimension is determined by the first variable.

  • positions (None or list of array-like, optional) – List of integer arrays which specifies the integer positions to which to assign each dataset along the concatenated dimension. If not supplied, objects are concatenated in the provided order.

  • shortcut (bool, optional) – This option is used internally to speed-up groupby operations. If shortcut is True, some checks of internal consistency between arrays to concatenate are skipped.

  • combine_attrs ({"drop", "identical", "no_conflicts", "drop_conflicts", "override"}, default: "override") – String indicating how to combine attrs of the objects being merged:

    • “drop”: empty attrs on returned Dataset.

    • “identical”: all attrs must be the same on every object.

    • “no_conflicts”: attrs from all objects are combined, any that have the same name must also have the same value.

    • “drop_conflicts”: attrs from all objects are combined, any that have the same name but different values are dropped.

    • “override”: skip comparing and copy attrs from the first dataset to the result.

Returns:

stacked (Variable) – Concatenated Variable formed by stacking all the supplied variables along the given dimension.