Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history 
Co-authored-by: Martin Yeo <40734014+trexfeathers@users.noreply.github.com>
  • Loading branch information
@stephenworsley @trexfeathers
stephenworsley and trexfeathers authored Mar 22, 2023
1 parent eb1da3e commit b309b4a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
16 changes: 8 additions & 8 deletions esmf_regrid/experimental/unstructured_scheme.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -299,12 +299,12 @@ def regrid_unstructured_to_rectilinear(
resolution : int, optional
If present, represents the amount of latitude slices per cell
given to ESMF for calculation.
use_src_mask : :obj:`~numpy.typing.ArrayLike`, bool, default=False
use_src_mask : :obj:`~numpy.typing.ArrayLike` or bool, default=False
Either an array representing the cells in the source to ignore, or else
a boolean value. If True, this array is taken from the mask on the data
in ``src_mesh_cube``. If False, no mask will be taken and all points will
be used in weights calculation.
use_tgt_mask : :obj:`~numpy.typing.ArrayLike`, bool, default=False
use_tgt_mask : :obj:`~numpy.typing.ArrayLike` or bool, default=False
Either an array representing the cells in the target to ignore, or else
a boolean value. If True, this array is taken from the mask on the data
in ``target_grid_cube``. If False, no mask will be taken and all points
Expand Down Expand Up @@ -374,12 +374,12 @@ def __init__(
given to ESMF for calculation. If resolution is set, target_grid_cube
must have strictly increasing bounds (bounds may be transposed plus or
minus 360 degrees to make the bounds strictly increasing).
use_src_mask : :obj:`~numpy.typing.ArrayLike`, bool, default=False
use_src_mask : :obj:`~numpy.typing.ArrayLike` or bool, default=False
Either an array representing the cells in the source to ignore, or else
a boolean value. If True, this array is taken from the mask on the data
in ``src_mesh_cube``. If False, no mask will be taken and all points will
be used in weights calculation.
use_tgt_mask : :obj:`~numpy.typing.ArrayLike`, bool, default=False
use_tgt_mask : :obj:`~numpy.typing.ArrayLike` or bool, default=False
Either an array representing the cells in the target to ignore, or else
a boolean value. If True, this array is taken from the mask on the data
in ``target_grid_cube``. If False, no mask will be taken and all points
Expand Down Expand Up @@ -672,12 +672,12 @@ def regrid_rectilinear_to_unstructured(
resolution : int, optional
If present, represents the amount of latitude slices per cell
given to ESMF for calculation.
use_src_mask : :obj:`~numpy.typing.ArrayLike`, bool, default=False
use_src_mask : :obj:`~numpy.typing.ArrayLike` or bool, default=False
Either an array representing the cells in the source to ignore, or else
a boolean value. If True, this array is taken from the mask on the data
in ``src_mesh_cube``. If False, no mask will be taken and all points will
be used in weights calculation.
use_tgt_mask : :obj:`~numpy.typing.ArrayLike`, bool, default=False
use_tgt_mask : :obj:`~numpy.typing.ArrayLike` or bool, default=False
Either an array representing the cells in the target to ignore, or else
a boolean value. If True, this array is taken from the mask on the data
in ``target_grid_cube``. If False, no mask will be taken and all points
Expand Down Expand Up @@ -747,12 +747,12 @@ def __init__(
given to ESMF for calculation. If resolution is set, src_grid_cube
must have strictly increasing bounds (bounds may be transposed plus or
minus 360 degrees to make the bounds strictly increasing).
use_src_mask : :obj:`~numpy.typing.ArrayLike`, bool, default=False
use_src_mask : :obj:`~numpy.typing.ArrayLike` or bool, default=False
Either an array representing the cells in the source to ignore, or else
a boolean value. If True, this array is taken from the mask on the data
in ``src_grid_cube``. If False, no mask will be taken and all points will
be used in weights calculation.
use_tgt_mask : :obj:`~numpy.typing.ArrayLike`, bool, default=False
use_tgt_mask : :obj:`~numpy.typing.ArrayLike` or bool, default=False
Either an array representing the cells in the target to ignore, or else
a boolean value. If True, this array is taken from the mask on the data
in ``target_mesh_cube``. If False, no mask will be taken and all points
Expand Down
8 changes: 4 additions & 4 deletions esmf_regrid/schemes.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -472,10 +472,10 @@ def regridder(self, src_grid, tgt_grid, use_src_mask=None, use_tgt_mask=None):
The :class:`~iris.cube.Cube` defining the source grid.
tgt_grid : :class:`iris.cube.Cube`
The :class:`~iris.cube.Cube` defining the target grid.
use_src_mask : :obj:`~numpy.typing.ArrayLike`, bool, optional
use_src_mask : :obj:`~numpy.typing.ArrayLike` or bool, optional
Array describing which elements :mod:`ESMF` will ignore on the src_grid.
If True, the mask will be derived from src_grid.
use_tgt_mask : :obj:`~numpy.typing.ArrayLike`, bool, optional
use_tgt_mask : :obj:`~numpy.typing.ArrayLike` or bool, optional
Array describing which elements :mod:`ESMF` will ignore on the tgt_grid.
If True, the mask will be derived from tgt_grid.
Expand Down Expand Up @@ -521,12 +521,12 @@ def __init__(
exceeds ``mdtol``. ``mdtol=0`` means no missing data is tolerated while
``mdtol=1`` will mean the resulting element will be masked if and only
if all the contributing elements of data are masked.
use_src_mask : :obj:`~numpy.typing.ArrayLike`, bool, default=False
use_src_mask : :obj:`~numpy.typing.ArrayLike` or bool, default=False
Either an array representing the cells in the source to ignore, or else
a boolean value. If True, this array is taken from the mask on the data
in ``src_grid``. If False, no mask will be taken and all points will
be used in weights calculation.
use_tgt_mask : :obj:`~numpy.typing.ArrayLike`, bool, default=False
use_tgt_mask : :obj:`~numpy.typing.ArrayLike` or bool, default=False
Either an array representing the cells in the source to ignore, or else
a boolean value. If True, this array is taken from the mask on the data
in ``tgt_grid``. If False, no mask will be taken and all points will
Expand Down

0 comments on commit b309b4a

Please sign in to comment.