uxarray.Grid.encode_as

Contents

uxarray.Grid.encode_as#

Grid.encode_as(grid_type)#

Encodes the grid as a new xarray.Dataset per grid format supplied in the grid_type argument.

Parameters:

grid_type (str, required) – Grid type of output dataset. Currently supported options are “ugrid”, “exodus”, and “scrip”

Returns:

out_ds – The output xarray.Dataset that is encoded from the this grid.

Return type:

xarray.Dataset

Raises:

RuntimeError – If provided grid type or file type is unsupported.