|
7 | 7 | from pygmt.datasets.load_remote_dataset import _load_remote_dataset
|
8 | 8 | from pygmt.helpers import kwargs_to_strings
|
9 | 9 |
|
| 10 | +__doctest_skip__ = ["load_earth_free_air_anomaly"] |
| 11 | + |
10 | 12 |
|
11 | 13 | @kwargs_to_strings(region="sequence")
|
12 | 14 | def load_earth_free_air_anomaly(resolution="01d", region=None, registration=None):
|
@@ -57,6 +59,23 @@ def load_earth_free_air_anomaly(resolution="01d", region=None, registration=None
|
57 | 59 | The :class:`xarray.DataArray` grid doesn't support slice operation, for
|
58 | 60 | Earth free-air anomaly with resolutions of 5 arc-minutes or higher,
|
59 | 61 | which are stored as smaller tiles.
|
| 62 | +
|
| 63 | + Examples |
| 64 | + -------- |
| 65 | +
|
| 66 | + >>> from pygmt.datasets import load_earth_free_air_anomaly |
| 67 | + >>> # load the default grid (gridline-registered 1 arc-degree grid) |
| 68 | + >>> grid = load_earth_free_air_anomaly() |
| 69 | + >>> # load the 30 arc-minutes grid with "gridline" registration |
| 70 | + >>> grid = load_earth_free_air_anomaly( |
| 71 | + ... resolution="30m", registration="gridline" |
| 72 | + ... ) |
| 73 | + >>> # load high-resolution (5 arc-minutes) grid for a specific region |
| 74 | + >>> grid = load_earth_free_air_anomaly( |
| 75 | + ... resolution="05m", |
| 76 | + ... region=[120, 160, 30, 60], |
| 77 | + ... registration="gridline", |
| 78 | + ... ) |
60 | 79 | """
|
61 | 80 | grid = _load_remote_dataset(
|
62 | 81 | dataset_name="earth_free_air_anomaly",
|
|
0 commit comments