API Reference

This page documents the public API of XESMF.jl.

Public API

XESMF.Regridder — Method

Regridder(src_coordinates::Dict{String, <:AbstractArray},
          dst_coordinates::Dict{String, <:AbstractArray};
          method="conservative", periodic=false)

Return a Regridder from the xESMF Python package to regrid data from src_coordinates to dst_coordinates using the specified method.

The src_coordinates and dst_coordinates are dictionaries that contain information about the two grids.

xESMF exposes five different regridding algorithms from the ESMF library, specified with the method keyword argument:

"bilinear": ESMF.RegridMethod.BILINEAR
"conservative": ESMF.RegridMethod.CONSERVE
"conservative_normed": ESMF.RegridMethod.CONSERVE
"patch": ESMF.RegridMethod.PATCH
"nearest_s2d": ESMF.RegridMethod.NEAREST_STOD
"nearest_d2s": ESMF.RegridMethod.NEAREST_DTOS

where conservative_normed is just the conservative method with the normalization set to ESMF.NormType.FRACAREA instead of the default norm_type = ESMF.NormType.DSTAREA.

For more information, see the Python xESMF documentation at:

https://xesmf.readthedocs.io/en/latest/notebooks/Compare_algorithms.html

source

Internal API

XESMF.sparse_regridder_weights — Method

sparse_regridder_weights(FT, regridder)

Return the regridder weights as a sparse matrix.

source