xarray.Dataset.regridder.horizontal

Dataset.regridder.horizontal(data_var, output_grid, tool='xesmf', **options)

Apply horizontal regridding to data_var of the current xr.Dataset to output_grid.

Supported tools:

• xESMF (https://pangeo-xesmf.readthedocs.io/en/latest/)

  • Rectilinear and curvilinear grids

  • Find options at xcdat.regridder.xesmf.XESMFRegridder()

• Regrid2

  • Rectilinear grids

  • Find options at xcdat.regridder.regrid2.Regrid2Regridder()

Parameters

• data_var (str) – Name of the variable in the xr.Dataset to regrid.

• output_grid (xr.Dataset) – Dataset containing output grid.

• tool (str) – Name of the regridding tool.

• **options (Dict[str, Any]) – These options are passed to the tool being used for regridding. See specific regridder documentation for available options.

Returns

xr.Dataset – With the data_var variable on the grid defined in output_grid.

Raises

ValueError – If tool is not supported.

Examples

Create destination grid:

>>> output_grid = xcdat.create_uniform_grid(-90, 90, 4.0, -180, 180, 5.0)

Regrid variable using “xesmf”:

>>> ds.regridder.horizontal("ts", output_grid, tool="xesmf", method="bilinear")

Regrid variable using “regrid2”:

>>> ds.regridder.horizontal("ts", output_grid, tool="regrid2")

Use convenience methods:

>>> ds.regridder.horizontal_xesmf("ts", output_grid, method="bilinear")

>>> ds.regridder.horizontal_regrid2("ts", output_grid)