Merge branch 'main' into coast/resolution

Author: seisman

.github/workflows/benchmarks.yml

@@ -34,7 +34,7 @@ jobs:
     steps:
       # Checkout current git repository
       - name: Checkout
-        uses: actions/[email protected].1
+        uses: actions/[email protected].2
         with:
           # fetch all history so that setuptools-scm works
           fetch-depth: 0

.github/workflows/cache_data.yaml

@@ -36,7 +36,7 @@ jobs:
     steps:
       # Checkout current git repository
       - name: Checkout
-        uses: actions/[email protected].1
+        uses: actions/[email protected].2
         with:
           # fetch all history so that setuptools-scm works
           fetch-depth: 0

.github/workflows/check-links.yml

@@ -23,12 +23,12 @@ jobs:
 
     steps:
     - name: Checkout the repository
-      uses: actions/[email protected].1
+      uses: actions/[email protected].2
       with:
         path: repository
 
     - name: Checkout the documentation
-      uses: actions/[email protected].1
+      uses: actions/[email protected].2
       with:
         ref: gh-pages
         path: documentation

.github/workflows/ci_docs.yml

@@ -69,7 +69,7 @@ jobs:
     steps:
       # Checkout current git repository
       - name: Checkout
-        uses: actions/[email protected].1
+        uses: actions/[email protected].2
         with:
           # fetch all history so that setuptools-scm works
           fetch-depth: 0
@@ -138,7 +138,7 @@ jobs:
         run: make -C doc clean all
 
       - name: Checkout the gh-pages branch
-        uses: actions/[email protected].1
+        uses: actions/[email protected].2
         with:
           ref: gh-pages
           # Checkout to this folder instead of the current one

.github/workflows/ci_doctests.yaml

@@ -35,7 +35,7 @@ jobs:
     steps:
       # Checkout current git repository
       - name: Checkout
-        uses: actions/[email protected].1
+        uses: actions/[email protected].2
         with:
           # fetch all history so that setuptools-scm works
           fetch-depth: 0

.github/workflows/ci_tests.yaml

@@ -103,7 +103,7 @@ jobs:
     steps:
       # Checkout current git repository
       - name: Checkout
-        uses: actions/[email protected].1
+        uses: actions/[email protected].2
         with:
           # fetch all history so that setuptools-scm works
           fetch-depth: 0

.github/workflows/ci_tests_dev.yaml

@@ -46,7 +46,7 @@ jobs:
     steps:
       # Checkout current git repository
       - name: Checkout
-        uses: actions/[email protected].1
+        uses: actions/[email protected].2
         with:
           # fetch all history so that setuptools-scm works
           fetch-depth: 0
@@ -96,7 +96,7 @@ jobs:
 
       # Checkout current GMT repository
       - name: Checkout the GMT source from ${{ matrix.gmt_git_ref }} branch
-        uses: actions/[email protected].1
+        uses: actions/[email protected].2
         with:
           repository: 'GenericMappingTools/gmt'
           ref: ${{ matrix.gmt_git_ref }}

.github/workflows/ci_tests_legacy.yaml

@@ -44,7 +44,7 @@ jobs:
     steps:
       # Checkout current git repository
       - name: Checkout
-        uses: actions/[email protected].1
+        uses: actions/[email protected].2
         with:
           # fetch all history so that setuptools-scm works
           fetch-depth: 0

.github/workflows/dvc-diff.yml

@@ -21,7 +21,7 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/[email protected].1
+      uses: actions/[email protected].2
       with:
         # fetch all history so that dvc diff works
         fetch-depth: 0

.github/workflows/format-command.yml

@@ -18,14 +18,14 @@ jobs:
           private-key: ${{ secrets.APP_PRIVATE_KEY }}
 
       # Checkout the pull request branch
-      - uses: actions/[email protected].1
+      - uses: actions/[email protected].2
         with:
           token: ${{ steps.generate-token.outputs.token }}
           repository: ${{ github.event.client_payload.pull_request.head.repo.full_name }}
           ref: ${{ github.event.client_payload.pull_request.head.ref }}
 
       # Setup Python environment
-      - uses: actions/setup-python@v5.2.0
+      - uses: actions/setup-python@v5.3.0
         with:
           python-version: '3.12'
 

.github/workflows/publish-to-pypi.yml

@@ -45,13 +45,13 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/[email protected].1
+      uses: actions/[email protected].2
       with:
         # fetch all history so that setuptools-scm works
         fetch-depth: 0
 
     - name: Set up Python
-      uses: actions/setup-python@v5.2.0
+      uses: actions/setup-python@v5.3.0
       with:
         python-version: '3.12'
 

.github/workflows/release-baseline-images.yml

@@ -23,7 +23,7 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/[email protected].1
+      uses: actions/[email protected].2
 
     - name: Setup data version control (DVC)
       uses: iterative/[email protected]

.github/workflows/style_checks.yaml

@@ -24,11 +24,11 @@ jobs:
     steps:
       # Checkout current git repository
       - name: Checkout
-        uses: actions/[email protected].1
+        uses: actions/[email protected].2
 
       # Setup Python
       - name: Set up Python
-        uses: actions/setup-python@v5.2.0
+        uses: actions/setup-python@v5.3.0
         with:
           python-version: '3.12'
 

.github/workflows/type_checks.yml

@@ -33,11 +33,11 @@ jobs:
     steps:
       # Checkout current git repository
       - name: Checkout
-        uses: actions/[email protected].1
+        uses: actions/[email protected].2
 
       # Setup Python
       - name: Set up Python
-        uses: actions/setup-python@v5.2.0
+        uses: actions/setup-python@v5.3.0
         with:
           python-version: '3.12'
 

pygmt/datasets/load_remote_dataset.py

@@ -2,38 +2,33 @@
 Internal function to load GMT remote datasets.
 """
 
-from __future__ import annotations
-
-from typing import TYPE_CHECKING, ClassVar, Literal, NamedTuple
+from collections.abc import Sequence
+from typing import Any, Literal, NamedTuple
 
+import xarray as xr
 from pygmt.clib import Session
 from pygmt.exceptions import GMTInvalidInput
 from pygmt.helpers import build_arg_list, kwargs_to_strings
 from pygmt.src import which
 
-if TYPE_CHECKING:
-    from collections.abc import Sequence
-
-    import xarray as xr
-
 
 class Resolution(NamedTuple):
     """
     Resolution code, the available grid registrations and whether it is tiled.
 
     Attributes
     ----------
-    code : str
+    code
         The resolution code. E.g., "01d", "30m", "01s".
-    registrations : list
+    registrations
         A list of the accepted registrations for a given resolution. Can be either
         "pixel" or "gridline".
-    tiled : bool
+    tiled
         States if the grid is tiled, which requires an argument for ``region``.
     """
 
     code: str
-    registrations: ClassVar[list] = ["gridline", "pixel"]
+    registrations: Sequence[str] = ["gridline", "pixel"]
     tiled: bool = False
 
 
@@ -43,20 +38,20 @@ class GMTRemoteDataset(NamedTuple):
 
     Attributes
     ----------
-    description : str
+    description
        The name assigned as an attribute to the DataArray.
-    units : str, None
+    units
         The units of the values in the DataArray.
-    resolutions : dict
+    resolutions
         Dictionary of available resolution as keys and Resolution objects as values.
-    extra_attributes : dict
+    extra_attributes
         A dictionary of extra or unique attributes of the dataset.
     """
 
     description: str
     units: str | None
     resolutions: dict[str, Resolution]
-    extra_attributes: dict
+    extra_attributes: dict[str, Any]
 
 
 datasets = {
@@ -389,9 +384,8 @@ def _load_remote_dataset(
         The grid resolution. The suffix ``d``, ``m``, and ``s`` stand for arc-degrees,
         arc-minutes, and arc-seconds, respectively.
     region
-        The subregion of the grid to load, in the form of a list
-        [*xmin*, *xmax*, *ymin*, *ymax*] or a string *xmin/xmax/ymin/ymax*.
-        Required for tiled grids.
+        The subregion of the grid to load, in the form of a sequence [*xmin*, *xmax*,
+        *ymin*, *ymax*] or an ISO country code. Required for tiled grids.
     registration
         Grid registration type. Either ``"pixel"`` for pixel registration or
         ``"gridline"`` for gridline registration. Default is ``None``, where
@@ -417,41 +411,39 @@ def _load_remote_dataset(
 
     # Check resolution
     if resolution not in dataset.resolutions:
-        raise GMTInvalidInput(
+        msg = (
             f"Invalid resolution '{resolution}' for {dataset.description} dataset. "
             f"Available resolutions are: {', '.join(dataset.resolutions)}."
         )
+        raise GMTInvalidInput(msg)
     resinfo = dataset.resolutions[resolution]
 
     # Check registration
-    if registration is None:
-        # Use gridline registration unless only pixel registration is available
-        registration = "gridline" if "gridline" in resinfo.registrations else "pixel"
-    elif registration in {"pixel", "gridline"}:
-        if registration not in resinfo.registrations:
-            raise GMTInvalidInput(
-                f"{registration} registration is not available for the "
-                f"{resolution} {dataset.description} dataset. Only "
-                f"{resinfo.registrations[0]} registration is available."
+    match registration:
+        case None:
+            # Use gridline registration unless only pixel registration is available
+            reg = "g" if "gridline" in resinfo.registrations else "p"
+        case x if x not in resinfo.registrations:
+            msg = (
+                f"Invalid grid registration '{registration}' for the {resolution} "
+                f"{dataset.description} dataset. 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."
             )
-    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."
-        )
+            raise GMTInvalidInput(msg)
+        case _:
+            reg = registration[0]
 
-    fname = f"@{prefix}_{resolution}_{registration[0]}"  # type: ignore[index]
     if resinfo.tiled and region is None:
-        raise GMTInvalidInput(
-            f"'region' is required for {dataset.description} resolution '{resolution}'."
+        msg = (
+            f"The 'region' parameter is required for {dataset.description} "
+            f"resolution '{resolution}'."
         )
+        raise GMTInvalidInput(msg)
 
+    fname = f"@{prefix}_{resolution}_{reg}"
     kind = "image" if name in {"earth_day", "earth_night"} else "grid"
-    kwdict = {
-        "R": region,  # region can be None
-        "T": "i" if kind == "image" else "g",
-    }
+    kwdict = {"R": region, "T": {"grid": "g", "image": "i"}[kind]}
     with Session() as lib:
         with lib.virtualfile_out(kind=kind) as voutgrd:
             lib.call_module(

pygmt/src/grd2xyz.py

@@ -2,7 +2,7 @@
 grd2xyz - Convert grid to data table
 """
 
-from typing import TYPE_CHECKING, Literal
+from typing import Literal
 
 import numpy as np
 import pandas as pd
@@ -17,9 +17,6 @@
     validate_output_table_type,
 )
 
-if TYPE_CHECKING:
-    from collections.abc import Hashable
-
 __doctest_skip__ = ["grd2xyz"]
 
 
@@ -152,11 +149,11 @@ def grd2xyz(
         )
 
     # Set the default column names for the pandas dataframe header.
-    column_names: list[Hashable] = ["x", "y", "z"]
+    column_names: list[str] = ["x", "y", "z"]
     # Let output pandas column names match input DataArray dimension names
     if output_type == "pandas" and isinstance(grid, xr.DataArray):
         # Reverse the dims because it is rows, columns ordered.
-        column_names = [grid.dims[1], grid.dims[0], grid.name]
+        column_names = [str(grid.dims[1]), str(grid.dims[0]), str(grid.name)]
 
     with Session() as lib:
         with (