Skip to content

Commit 350f220

Browse files
davidhasselldavidhassell
committed
regrid docs
1 parent 023debb commit 350f220

File tree

3 files changed

+35
-35
lines changed

3 files changed

+35
-35
lines changed

‎cf/field.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13718,7 +13718,7 @@ def regrids(
1371813718

1371913719
Ignored if *dst* is a `RegridOperator`.
1372013720

13721-
.. versionadded:: 3.17.0
13721+
.. versionadded:: NEXTRELEASE
1372213722

1372313723
dst_z: optional
1372413724
If `None`, the default, then the regridding is 2-d in
@@ -13732,7 +13732,7 @@ def regrids(
1373213732

1373313733
Ignored if *dst* is a `RegridOperator`.
1373413734

13735-
.. versionadded:: 3.17.0
13735+
.. versionadded:: NEXTRELEASE
1373613736

1373713737
z: optional
1373813738
The *z* parameter is a convenience that may be used to
@@ -13746,11 +13746,11 @@ def regrids(
1374613746
*Example:*
1374713747
``z='Z'`` is equivalent to ``src_z='Z', dst_z='Z'``.
1374813748

13749-
.. versionadded:: 3.17.0
13749+
.. versionadded:: NEXTRELEASE
1375013750

1375113751
{{ln_z: `bool` or `None`, optional}}
1375213752

13753-
.. versionadded:: 3.17.0
13753+
.. versionadded:: NEXTRELEASE
1375413754

1375513755
{{verbose: `int` or `str` or `None`, optional}}
1375613756

@@ -14017,7 +14017,7 @@ def regridc(
1401714017

1401814018
Ignored if *dst* is a `RegridOperator`.
1401914019

14020-
.. versionadded:: 3.17.0
14020+
.. versionadded:: NEXTRELEASE
1402114021

1402214022
dst_z: optional
1402314023
If not `None` then *dst_z* specifies the identity of a
@@ -14027,7 +14027,7 @@ def regridc(
1402714027

1402814028
Ignored if *dst* is a `RegridOperator`.
1402914029

14030-
.. versionadded:: 3.17.0
14030+
.. versionadded:: NEXTRELEASE
1403114031

1403214032
z: optional
1403314033
The *z* parameter is a convenience that may be used to
@@ -14039,11 +14039,11 @@ def regridc(
1403914039
*Example:*
1404014040
``z='Z'`` is equivalent to ``src_z='Z', dst_z='Z'``.
1404114041

14042-
.. versionadded:: 3.17.0
14042+
.. versionadded:: NEXTRELEASE
1404314043

1404414044
{{ln_z: `bool` or `None`, optional}}
1404514045

14046-
.. versionadded:: 3.17.0
14046+
.. versionadded:: NEXTRELEASE
1404714047

1404814048
{{inplace: `bool`, optional}}
1404914049

‎cf/regrid/regrid.py‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ def regrid(
290290
See `cf.Field.regrids` (for spherical regridding) or
291291
`cf.Field.regridc` (for Cartesian regridding) for details.
292292
293-
.. versionadded:: 3.17.0
293+
.. versionadded:: NEXTRELEASE
294294
295295
dst_z: optional
296296
The identity of the destination grid vertical coordinates
@@ -301,7 +301,7 @@ def regrid(
301301
See `cf.Field.regrids` (for spherical regridding) or
302302
`cf.Field.regridc` (for Cartesian regridding) for details.
303303
304-
.. versionadded:: 3.17.0
304+
.. versionadded:: NEXTRELEASE
305305
306306
z: optional
307307
The *z* parameter is a convenience that may be used to
@@ -311,7 +311,7 @@ def regrid(
311311
See `cf.Field.regrids` (for spherical regridding) or
312312
`cf.Field.regridc` (for Cartesian regridding) for details.
313313
314-
.. versionadded:: 3.17.0
314+
.. versionadded:: NEXTRELEASE
315315
316316
ln_z: `bool` or `None`, optional
317317
Whether or not the weights are to be calculated with the
@@ -320,7 +320,7 @@ def regrid(
320320
See `cf.Field.regrids` (for spherical regridding) or
321321
`cf.Field.regridc` (for Cartesian regridding) for details.
322322
323-
.. versionadded:: 3.17.0
323+
.. versionadded:: NEXTRELEASE
324324
325325
:Returns:
326326
@@ -773,7 +773,7 @@ def spherical_coords_to_domain(
773773
``d.coordinate(dst_z)``, where ``d`` is the `Domain`
774774
returned by this function.
775775
776-
.. versionadded:: 3.17.0
776+
.. versionadded:: NEXTRELEASE
777777
778778
domain_class: `Domain` class
779779
The domain class used to create the new `Domain` instance.
@@ -962,7 +962,7 @@ def Cartesian_coords_to_domain(dst, dst_z=None, domain_class=None):
962962
``d.coordinate(dst_z)``, where ``d`` is the `Domain`
963963
returned by this function.
964964
965-
.. versionadded:: 3.17.0
965+
.. versionadded:: NEXTRELEASE
966966
967967
domain_class: `Domain` class
968968
The domain class used to create the new `Domain` instance.
@@ -1026,7 +1026,7 @@ def get_grid(
10261026
See `cf.Field.regrids` (for spherical regridding) or
10271027
`cf.Field.regridc` (for Cartesian regridding) for details.
10281028
1029-
.. versionadded:: 3.17.0
1029+
.. versionadded:: NEXTRELEASE
10301030
10311031
"""
10321032
if coord_sys == "spherical":
@@ -1106,13 +1106,13 @@ def spherical_grid(
11061106
3-d and is defined by the unique construct returned by
11071107
``f.coordinate(src_z)``
11081108
1109-
.. versionadded:: 3.17.0
1109+
.. versionadded:: NEXTRELEASE
11101110
11111111
ln_z: `bool` or `None`, optional
11121112
Whether or not the weights are to be calculated with the
11131113
natural logarithm of vertical coordinates.
11141114
1115-
.. versionadded:: 3.17.0
1115+
.. versionadded:: NEXTRELEASE
11161116
11171117
:Returns:
11181118
@@ -1453,13 +1453,13 @@ def Cartesian_grid(f, name=None, method=None, axes=None, z=None, ln_z=None):
14531453
If not `None` then *src_z* specifies the identity of a
14541454
vertical coordinate construct of the source grid.
14551455
1456-
.. versionadded:: 3.17.0
1456+
.. versionadded:: NEXTRELEASE
14571457
14581458
ln_z: `bool` or `None`, optional
14591459
Whether or not the weights are to be calculated with the
14601460
natural logarithm of vertical coordinates.
14611461
1462-
.. versionadded:: 3.17.0
1462+
.. versionadded:: NEXTRELEASE
14631463
14641464
:Returns:
14651465
@@ -2229,7 +2229,7 @@ def create_esmpy_mesh(grid, mask=None):
22292229
def create_esmpy_locstream(grid, mask=None):
22302230
"""Create an `esmpy.LocStream`.
22312231
2232-
.. versionadded:: 3.17.0
2232+
.. versionadded:: NEXTRELEASE
22332233
22342234
.. seealso:: `create_esmpy_grid`, `create_esmpy_mesh`
22352235
@@ -3037,7 +3037,7 @@ def get_mesh(f):
30373037
def get_dsg(f):
30383038
"""Get domain discrete sampling geometry information.
30393039
3040-
.. versionadded:: 3.17.0
3040+
.. versionadded:: NEXTRELEASE
30413041
30423042
:Parameters:
30433043
@@ -3103,7 +3103,7 @@ def has_coordinate_arrays(grid):
31033103
def set_grid_type(grid):
31043104
"""Set the ``type`` attribute of a `Grid` instance in-place.
31053105
3106-
.. versionadded:: 3.17.0
3106+
.. versionadded:: NEXTRELEASE
31073107
31083108
:Parameters:
31093109

‎cf/regrid/regridoperator.py‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -149,47 +149,47 @@ def __init__(
149149
The UGRID mesh element of the destination grid
150150
(e.g. ``'face'``).
151151
152-
.. versionadded:: 3.17.0
152+
.. versionadded:: NEXTRELEASE
153153
154154
src_featureType: `str`, optional
155155
The discrete sampling geometry (DSG) featureType of
156156
the source grid (e.g. ``'trajectory'``).
157157
158-
.. versionadded:: 3.17.0
158+
.. versionadded:: NEXTRELEASE
159159
160160
dst_featureType: `str`, optional
161161
The DSG featureType of the destination grid
162162
(e.g. ``'trajectory'``).
163163
164-
.. versionadded:: 3.17.0
164+
.. versionadded:: NEXTRELEASE
165165
166166
src_z: optional
167167
The identity of the source grid vertical coordinates
168168
used to calculate the weights. If `None` then no
169169
source grid vertical axis is identified.
170170
171-
.. versionadded:: 3.17.0
171+
.. versionadded:: NEXTRELEASE
172172
173173
dst_z: optional
174174
The identity of the destination grid vertical
175175
coordinates used to calculate the weights. If `None`
176176
then no destination grid vertical axis is identified.
177177
178-
.. versionadded:: 3.17.0
178+
.. versionadded:: NEXTRELEASE
179179
180180
ln_z: `bool`, optional
181181
Whether or not the weights were calculated with the
182182
natural logarithm of vertical coordinates.
183183
184-
.. versionadded:: 3.17.0
184+
.. versionadded:: NEXTRELEASE
185185
186186
dimensionality: `int`, optional
187187
The number of physical regridding dimensions. This may
188188
differ from the corresponding number of storage
189189
dimensions in the source or destination grids, if
190190
either has an unstructured mesh or a DSG featureType.
191191
192-
.. versionadded:: 3.17.0
192+
.. versionadded:: NEXTRELEASE
193193
194194
"""
195195
super().__init__()
@@ -254,7 +254,7 @@ def coord_sys(self):
254254
def dimensionality(self):
255255
"""The number of physical regridding dimensions.
256256
257-
.. versionadded:: 3.17.0
257+
.. versionadded:: NEXTRELEASE
258258
259259
"""
260260
return self._get_component("dimensionality")
@@ -291,7 +291,7 @@ def dst_cyclic(self):
291291
def dst_featureType(self):
292292
"""The DSG featureType of the destination grid.
293293
294-
.. versionadded:: 3.17.0
294+
.. versionadded:: NEXTRELEASE
295295
296296
"""
297297
return self._get_component("dst_featureType")
@@ -335,7 +335,7 @@ def dst_shape(self):
335335
def dst_z(self):
336336
"""The identity of the destination grid vertical coordinates.
337337
338-
.. versionadded:: 3.17.0
338+
.. versionadded:: NEXTRELEASE
339339
340340
"""
341341
return self._get_component("dst_z")
@@ -344,7 +344,7 @@ def dst_z(self):
344344
def ln_z(self):
345345
"""Whether or not vertical weights are based on ln(z).
346346
347-
.. versionadded:: 3.17.0
347+
.. versionadded:: NEXTRELEASE
348348
349349
"""
350350
return self._get_component("ln_z")
@@ -420,7 +420,7 @@ def src_cyclic(self):
420420
def src_featureType(self):
421421
"""The DSG featureType of the source grid.
422422
423-
.. versionadded:: 3.17.0
423+
.. versionadded:: NEXTRELEASE
424424
425425
"""
426426
return self._get_component("src_featureType")
@@ -464,7 +464,7 @@ def src_shape(self):
464464
def src_z(self):
465465
"""The identity of the source grid vertical coordinates.
466466
467-
.. versionadded:: 3.17.0
467+
.. versionadded:: NEXTRELEASE
468468
469469
"""
470470
return self._get_component("src_z")

0 commit comments

Comments
 (0)