Merge branch 'main' into static-earth-relief/grdcontour

Author: seisman

pygmt/clib/session.py

@@ -99,9 +99,9 @@ class Session:
     Examples
     --------
 
-    >>> from pygmt.datasets import load_earth_relief
+    >>> from pygmt.helpers.testing import load_static_earth_relief
     >>> from pygmt.helpers import GMTTempFile
-    >>> grid = load_earth_relief()
+    >>> grid = load_static_earth_relief()
     >>> type(grid)
     <class 'xarray.core.dataarray.DataArray'>
     >>> # Create a session and destroy it automatically when exiting the "with"
@@ -117,7 +117,7 @@ class Session:
     ...             # Read the contents of the temp file before it's deleted.
     ...             print(fout.read().strip())
     ...
-    -180 180 -90 90 -8182 5651.5 1 1 360 180 1 1
+    -55 -47 -24 -10 190 981 1 1 8 14 1 1
     """
 
     # The minimum version of GMT required
@@ -1295,17 +1295,17 @@ def virtualfile_from_grid(self, grid):
         Examples
         --------
 
-        >>> from pygmt.datasets import load_earth_relief
+        >>> from pygmt.helpers.testing import load_static_earth_relief
         >>> from pygmt.helpers import GMTTempFile
-        >>> data = load_earth_relief(resolution="01d")
+        >>> data = load_static_earth_relief()
         >>> print(data.shape)
-        (180, 360)
+        (14, 8)
         >>> print(data.lon.values.min(), data.lon.values.max())
-        -179.5 179.5
+        -54.5 -47.5
         >>> print(data.lat.values.min(), data.lat.values.max())
-        -89.5 89.5
+        -23.5 -10.5
         >>> print(data.values.min(), data.values.max())
-        -8182.0 5651.5
+        190.0 981.0
         >>> with Session() as ses:
         ...     with ses.virtualfile_from_grid(data) as fin:
         ...         # Send the output to a file so that we can read it
@@ -1314,7 +1314,7 @@ def virtualfile_from_grid(self, grid):
         ...             ses.call_module("grdinfo", args)
         ...             print(fout.read().strip())
         ...
-        -180 180 -90 90 -8182 5651.5 1 1 360 180 1 1
+        -55 -47 -24 -10 190 981 1 1 8 14 1 1
         >>> # The output is: w e s n z0 z1 dx dy n_columns n_rows reg gtype
         """
         _gtype = {0: "GMT_GRID_IS_CARTESIAN", 1: "GMT_GRID_IS_GEO"}[grid.gmt.gtype]

pygmt/src/grdsample.py

@@ -73,6 +73,20 @@ def grdsample(grid, **kwargs):
         - :class:`xarray.DataArray` if ``outgrid`` is not set
         - None if ``outgrid`` is set (grid output will be stored in file set by
           ``outgrid``)
+
+    Example
+    -------
+    >>> import pygmt  # doctest: +SKIP
+    >>> # Load a grid of @earth_relief_30m data, with an x-range of 10 to 30,
+    >>> # and a y-range of 15 to 25
+    >>> grid = pygmt.datasets.load_earth_relief(
+    ...     resolution="30m", region=[10, 30, 15, 25]
+    ... )  # doctest: +SKIP
+    >>> # Create a new grid from an input grid, change the registration,
+    >>> # and set both x- and y-spacing to 0.5 degrees
+    >>> new_grid = pygmt.grdsample(
+    ...     grid=grid, translate=True, spacing=[0.5, 0.5]
+    ... )  # doctest: +SKIP
     """
     with GMTTempFile(suffix=".nc") as tmpfile:
         with Session() as lib: