uxarray.UxDataset.from_xarray

uxarray.UxDataset.from_xarray#

classmethod UxDataset.from_xarray(ds, uxgrid=None, ugrid_dims=None)#

Converts a xarray.Dataset into a uxarray.UxDataset, paired with either a user-defined or parsed Grid

Parameters:

  • ds (xr.Dataset) – An Xarray dataset containing data residing on an unstructured grid

  • uxgrid (Grid, optional) – Grid object representing an unstructured grid. If a grid is not provided, the source ds will be parsed to see if a Grid can be constructed.

  • ugrid_dims (dict, optional) – A dictionary mapping dataset dimensions to UGRID dimensions.

Returns:

A ux.UxDataset with data from the xr.Dataset` paired with a ``ux.Grid

Return type:

cls

Contents