Merge branch 'main' into pythonic-arguments/colorbar-frame

Author: willschlitzer

.github/workflows/ci_docs.yml

@@ -80,7 +80,7 @@ jobs:
 
       # Download cached remote files (artifacts) from GitHub
       - name: Download remote data from GitHub
-        uses: dawidd6/action-download-artifact@v2.24.3
+        uses: dawidd6/action-download-artifact@v2.25.0
         with:
           workflow: cache_data.yaml
           workflow_conclusion: success

.github/workflows/ci_tests.yaml

@@ -93,7 +93,7 @@ jobs:
           mamba install gmt=6.4.0 numpy=${{ matrix.numpy-version }} \
                         pandas xarray netCDF4 packaging \
                         ${{ matrix.optional-packages }} \
-                        build dvc fsspec==2022.11.0 make 'pytest>=6.0' \
+                        build dvc make 'pytest>=6.0' \
                         pytest-cov pytest-doctestplus pytest-mpl sphinx-gallery
 
       # Show installed pkg information for postmortem diagnostic
@@ -102,7 +102,7 @@ jobs:
 
       # Download cached remote files (artifacts) from GitHub
       - name: Download remote data from GitHub
-        uses: dawidd6/action-download-artifact@v2.24.3
+        uses: dawidd6/action-download-artifact@v2.25.0
         with:
           workflow: cache_data.yaml
           workflow_conclusion: success

.github/workflows/ci_tests_dev.yaml

@@ -71,7 +71,7 @@ jobs:
           fetch-depth: 0
 
       - name: Show job URL
-        uses: peter-evans/[email protected].0
+        uses: peter-evans/[email protected].1
         if: github.event_name == 'repository_dispatch' && (matrix.os == 'ubuntu-latest')
         with:
           token: ${{ steps.generate-token.outputs.token }}
@@ -101,7 +101,7 @@ jobs:
                         geopandas ghostscript libnetcdf hdf5 zlib curl pcre make
           pip install --pre --prefer-binary \
                         numpy pandas xarray netCDF4 packaging \
-                        build dvc fsspec==2022.11.0 ipython 'pytest>=6.0' pytest-cov \
+                        build dvc ipython 'pytest>=6.0' pytest-cov \
                         pytest-doctestplus pytest-mpl sphinx-gallery
 
       # Pull baseline image data from dvc remote (DAGsHub)
@@ -132,7 +132,7 @@ jobs:
 
       # Download cached remote files (artifacts) from GitHub
       - name: Download remote data from GitHub
-        uses: dawidd6/action-download-artifact@v2.24.3
+        uses: dawidd6/action-download-artifact@v2.25.0
         with:
           workflow: cache_data.yaml
           workflow_conclusion: success

.github/workflows/ci_tests_legacy.yaml

@@ -67,7 +67,7 @@ jobs:
           mamba install gmt=${{ matrix.gmt_version }} numpy \
                         pandas xarray netCDF4 packaging \
                         geopandas ipython \
-                        build dvc fsspec==2022.11.0 make 'pytest>=6.0' \
+                        build dvc make 'pytest>=6.0' \
                         pytest-cov pytest-doctestplus pytest-mpl sphinx-gallery
 
       # Show installed pkg information for postmortem diagnostic
@@ -76,7 +76,7 @@ jobs:
 
       # Download cached remote files (artifacts) from GitHub
       - name: Download remote data from GitHub
-        uses: dawidd6/action-download-artifact@v2.24.3
+        uses: dawidd6/action-download-artifact@v2.25.0
         with:
           workflow: cache_data.yaml
           workflow_conclusion: success

.github/workflows/dvc-diff.yml

@@ -87,15 +87,13 @@ jobs:
         # Mention git commit SHA in the report
         echo -e "Report last updated at commit ${{ github.event.pull_request.head.sha }}" >> report.md
 
-        # Format report to escape newlines before publishing as GitHub comment
-        report=$(cat report.md)
-        report="${report//'%'/'%25'}"
-        report="${report//$'\n'/'%0A'}"
-        report="${report//$'\r'/'%0D'}"
-        echo "report=$report" >> $GITHUB_OUTPUT
+        # Save the report content to the output parameter 'report'
+        echo 'report<<EOF' >> $GITHUB_OUTPUT
+        cat report.md >> $GITHUB_OUTPUT
+        echo 'EOF' >> $GITHUB_OUTPUT
 
     - name: Find comment with image diff report
-      uses: peter-evans/[email protected].0
+      uses: peter-evans/[email protected].1
       id: fc
       with:
         issue-number: ${{ github.event.pull_request.number }}
@@ -104,14 +102,14 @@ jobs:
 
     - name: Create comment with image diff report
       if: steps.fc.outputs.comment-id == ''
-      uses: peter-evans/[email protected].0
+      uses: peter-evans/[email protected].1
       with:
         issue-number: ${{ github.event.pull_request.number }}
         body: ${{ steps.image-diff.outputs.report }}
 
     - name: Update comment with new image diff report
       if: steps.fc.outputs.comment-id != ''
-      uses: peter-evans/[email protected].0
+      uses: peter-evans/[email protected].1
       with:
         comment-id: ${{ steps.fc.outputs.comment-id }}
         body: ${{ steps.image-diff.outputs.report }}

.github/workflows/format-command.yml

@@ -45,7 +45,7 @@ jobs:
           fi
 
       - name: Add reaction
-        uses: peter-evans/[email protected].0
+        uses: peter-evans/[email protected].1
         with:
           token: ${{ steps.generate-token.outputs.token }}
           repository: ${{ github.event.client_payload.github.payload.repository.full_name }}

AUTHORS.md

@@ -20,7 +20,7 @@ The following people have contributed code and/or documentation to the project
 * [Max Jones](https://github.com/maxrjones) | [0000-0003-0180-8928](https://orcid.org/0000-0003-0180-8928) | University of Hawai'i at Mānoa, USA
 * [Michael Grund](https://github.com/michaelgrund) | [0000-0001-8759-2018](https://orcid.org/0000-0001-8759-2018) | Innoplexia GmbH, Germany
 * [Tyler Newton](http://www.tnewton.com/) | [0000-0002-1560-6553](https://orcid.org/0000-0002-1560-6553) | University of Oregon, USA
-* [Wei Ji Leong](https://github.com/weiji14) | [0000-0003-2354-1988](https://orcid.org/0000-0003-2354-1988) | The Ohio State University, USA
+* [Wei Ji Leong](https://github.com/weiji14) | [0000-0003-2354-1988](https://orcid.org/0000-0003-2354-1988) | Development Seed, USA
 * [William Schlitzer](https://github.com/willschlitzer) | [0000-0002-5843-2282](https://orcid.org/0000-0002-5843-2282) | Unaffiliated
 * [Yohai Magen](https://github.com/yohaimagen) | [0000-0002-4892-4013](https://orcid.org/0000-0002-4892-4013) | Tel Aviv University, Israel
 * [Yvonne Fröhlich](https://github.com/yvonnefroehlich) | [0000-0002-8566-0619](https://orcid.org/0000-0002-8566-0619) | Karlsruhe Institute of Technology, Germany

CITATION.cff

@@ -14,7 +14,7 @@ authors:
   orcid: https://orcid.org/0000-0001-7967-1197
 - given-names: Wei Ji
   family-names: Leong
-  affiliation: The Ohio State University, USA
+  affiliation: Development Seed, USA
   orcid: https://orcid.org/0000-0003-2354-1988
 - given-names: Max
   family-names: Jones

doc/api/index.rst

@@ -227,13 +227,6 @@ and store them in GMT's user data directory.
     datasets.load_earth_vertical_gravity_gradient
     datasets.load_sample_data
 
-The following functions are deprecated since v0.6.0 and will be removed in v0.9.0.
-Use :func:`pygmt.datasets.load_sample_data` instead.
-
-.. autosummary::
-    :toctree: generated
-
-    datasets.load_mars_shape
 
 .. currentmodule:: pygmt
 

examples/gallery/symbols/bars.py

@@ -33,7 +33,6 @@
     sharex=True,
     margins=["0.5c", "0.75c"],
 ):
-
     pen = "1.5p"
     with fig.set_panel(panel=0):
         fill = "skyblue"

pygmt/datasets/__init__.py

@@ -13,4 +13,4 @@
 from pygmt.datasets.earth_vertical_gravity_gradient import (
     load_earth_vertical_gravity_gradient,
 )
-from pygmt.datasets.samples import list_sample_data, load_mars_shape, load_sample_data
+from pygmt.datasets.samples import list_sample_data, load_sample_data

pygmt/datasets/earth_magnetic_anomaly.py

@@ -115,8 +115,8 @@ def load_earth_magnetic_anomaly(
     }
     if data_source not in magnetic_anomaly_sources:
         raise GMTInvalidInput(
-            f"Invalid earth magnetic anomaly 'data_source' {data_source}, "
-            "valid values are 'emag2', 'emag2_4km', and 'wdmam'."
+            f"Invalid earth magnetic anomaly data source '{data_source}'. "
+            "Valid values are 'emag2', 'emag2_4km', and 'wdmam'."
         )
     dataset_prefix = magnetic_anomaly_sources[data_source]
     if data_source == "wdmam":

pygmt/datasets/earth_mask.py

@@ -57,6 +57,19 @@ def load_earth_mask(resolution="01d", region=None, registration=None):
         - 3: Islands in lakes in the land areas
         - 4: Smaller lakes in islands that are found within lakes
           inside the land area
+
+    Examples
+    --------
+
+    >>> from pygmt.datasets import load_earth_mask
+    >>> # load the default grid (gridline-registered 1 arc-degree grid)
+    >>> grid = load_earth_mask()
+    >>> # location (120°E, 50°N) is in land area (1)
+    >>> grid.sel(lon=120, lat=50).values
+    array(1, dtype=int8)
+    >>> # location (170°E, 50°N) is in oceanic area (0)
+    >>> grid.sel(lon=170, lat=50).values
+    array(0, dtype=int8)
     """
     grid = _load_remote_dataset(
         dataset_name="earth_mask",

pygmt/datasets/earth_relief.py

@@ -129,17 +129,17 @@ def load_earth_relief(
     }
     if data_source not in earth_relief_sources:
         raise GMTInvalidInput(
-            f"Invalid earth relief 'data_source' {data_source}, "
-            "valid values are 'igpp', 'gebco', 'gebcosi' and 'synbath'."
+            f"Invalid earth relief data source '{data_source}'. "
+            "Valid values are 'igpp', 'gebco', 'gebcosi' and 'synbath'."
         )
     # Choose earth relief data prefix
     if use_srtm and resolution in land_only_srtm_resolutions:
         if data_source == "igpp":
             dataset_prefix = "srtm_relief_"
         else:
             raise GMTInvalidInput(
-                f"The {data_source} option is not available if 'use_srtm=True'."
-                " Set data_source to 'igpp'."
+                f"Option 'use_srtm=True' doesn't work with data source '{data_source}'."
+                " Please set 'data_source' to 'igpp'."
             )
     else:
         dataset_prefix = earth_relief_sources[data_source]

pygmt/datasets/earth_vertical_gravity_gradient.py

@@ -59,6 +59,23 @@ def load_earth_vertical_gravity_gradient(
     The :class:`xarray.DataArray` grid doesn't support slice operation, for
     Earth vertical gravity gradient grids with resolutions of 5 arc-minutes or
     higher, which are stored as smaller tiles.
+
+    Examples
+    --------
+
+    >>> from pygmt.datasets import load_earth_vertical_gravity_gradient
+    >>> # load the default grid (gridline-registered 1 arc-degree grid)
+    >>> grid = load_earth_vertical_gravity_gradient()
+    >>> # load the 30 arc-minutes grid with "gridline" registration
+    >>> grid = load_earth_vertical_gravity_gradient(
+    ...     resolution="30m", registration="gridline"
+    ... )
+    >>> # load high-resolution (5 arc-minutes) grid for a specific region
+    >>> grid = load_earth_vertical_gravity_gradient(
+    ...     resolution="05m",
+    ...     region=[120, 160, 30, 60],
+    ...     registration="gridline",
+    ... )
     """
     grid = _load_remote_dataset(
         dataset_name="earth_vgg",

pygmt/datasets/load_remote_dataset.py

@@ -22,7 +22,7 @@ class Resolution(NamedTuple):
 
     tiled : bool
         States if the given resolution is tiled, which requires an
-        argument for ``region``."
+        argument for ``region``.
     """
 
     registrations: list
@@ -270,45 +270,42 @@ def _load_remote_dataset(
     The returned :class:`xarray.DataArray` doesn't support slice operation for
     tiled grids.
     """
-    # pylint: disable=too-many-branches
     dataset = datasets[dataset_name]
+
+    # check resolution
     if resolution not in dataset.resolutions.keys():
         raise GMTInvalidInput(f"Invalid resolution '{resolution}'.")
+
+    # check registration
     if registration is None:
-        # Check if "gridline" is an available registration for the resolution
-        if "gridline" in dataset.resolutions[resolution].registrations:
-            # Use default of gridline registration if available
-            registration = "gridline"
-        else:
+        # use gridline registration unless only pixel registration is available
+        registration = "gridline"
+        if "gridline" not in dataset.resolutions[resolution].registrations:
             registration = "pixel"
-    if registration in ("pixel", "gridline"):
-        reg = f"_{registration[0]}"
+    elif registration in ("pixel", "gridline"):
+        if registration not in dataset.resolutions[resolution].registrations:
+            raise GMTInvalidInput(
+                f"{registration} registration is not available for the "
+                f"{resolution} {dataset.title} dataset. Only "
+                f"{dataset.resolutions[resolution].registrations[0]}"
+                " registration is available."
+            )
     else:
         raise GMTInvalidInput(
             f"Invalid grid registration: '{registration}', should be either "
             "'pixel', 'gridline' or None. Default is None, where a "
             "gridline-registered grid is returned unless only the "
             "pixel-registered grid is available."
         )
-
-    if registration and (
-        registration not in dataset.resolutions[resolution].registrations
-    ):
-        raise GMTInvalidInput(
-            f"{registration} registration is not available for the "
-            f"{resolution} {dataset.title} dataset. Only "
-            f"{dataset.resolutions[resolution].registrations[0]}"
-            " registration is available."
-        )
+    reg = f"_{registration[0]}"
 
     # different ways to load tiled and non-tiled grids.
     # Known issue: tiled grids don't support slice operation
     # See https://github.com/GenericMappingTools/pygmt/issues/524
     if region is None:
         if dataset.resolutions[resolution].tiled:
             raise GMTInvalidInput(
-                f"'region' is required for {dataset.title}"
-                f"resolution '{resolution}'."
+                f"'region' is required for {dataset.title} resolution '{resolution}'."
             )
         fname = which(f"@{dataset_prefix}{resolution}{reg}", download="a")
         grid = load_dataarray(fname, engine="netcdf4")