Skip to content

Commit

Permalink
more docstring changes
Browse files Browse the repository at this point in the history
  • Loading branch information
HGWright committed Nov 2, 2023
1 parent e9de3a2 commit f20a62a
Showing 1 changed file with 3 additions and 17 deletions.
20 changes: 3 additions & 17 deletions esmf_regrid/experimental/unstructured_scheme.py
Original file line number Diff line number Diff line change
Expand Up @@ -370,23 +370,9 @@ def regrid_unstructured_to_unstructured(
Return a new :class:`~iris.cube.Cube` with :attr:`~iris.cube.Cube.data`
values calculated using weights generated by :mod:`esmpy` to give the weighted
mean of :attr:`~iris.cube.Cube.data` values from ``src_cube`` regridded onto the
horizontal mesh of ``mesh_cube``. The dimensions on the :class:`~iris.cube.Cube` associated
with the grid will be replaced by a dimension associated with the
:attr:`~iris.cube.Cube.mesh`.
That dimension will be the first of the grid dimensions, whether
it is associated with the ``x`` or ``y`` coordinate. Since two dimensions are
being replaced by one, coordinates associated with dimensions after
the grid will become associated with dimensions one lower.
This function requires that the horizontal dimension of ``mesh_cube`` is
described by a 2D mesh with data located on the faces of that mesh
for conservative regridding and located on either faces or nodes for
bilinear regridding.
This function allows the horizontal grid of ``grid_cube`` to be either
rectilinear or curvilinear (i.e. expressed in terms of two orthogonal
1D coordinates or via a pair of 2D coordinates).
This function also requires that the :class:`~iris.coords.Coord`\\ s describing the
horizontal grid have :attr:`~iris.coords.Coord.bounds`.
mean of :attr:`~iris.cube.Cube.data` values from ``src_mesh_cube`` regridded onto the
horizontal mesh of ``tgt_mesh_cube``. The resulting cube will have the same
``mesh_dim`` as ``src_mesh_cube``.
Parameters
----------
Expand Down

0 comments on commit f20a62a

Please sign in to comment.