Skip to content

Commit

Permalink
Remove mention of indices in example
Browse files Browse the repository at this point in the history
  • Loading branch information
Huite committed Aug 6, 2024
1 parent d128d95 commit ec6ca85
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions examples/overlap_regridder.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,13 +109,14 @@ def create_grid(bounds, nx, ny):
# inserted during the ``.regrid`` call and compiled by `Numba`_ for performance.
#
# A valid reduction method must be compileable by Numba, and takes exactly three
# arguments: ``values``, ``indices``, ``weights``.
# arguments: ``values``, ``weights``, ``workspace``.
#
# * ``values``: is the array containing the (float) source values.
# * ``weights``: contains the (float) overlap between the target face and the
# source faces. The size of ``weights`` is equal to the size of ``values``.
# * ``work``: used as a temporary workspace of floats. The size of ``work`` is
# equal to the size of ``values``.
# * ``workspace``: used as a temporary workspace of floats. The size of ``work`` is
# equal to the size of ``values``. (Make sure to zero it beforehand if that's
# important to your reduction!)
#
# Xugrid regridder reduction functions are implemented in such a way. For a
# example, an area weighted sum could be implemented as follows:
Expand Down

0 comments on commit ec6ca85

Please sign in to comment.