COrrect ot 'north-south' | change parameter name from 'direction' to 'component'

Author: yvonnefroehlich

pygmt/datasets/earth_deflection.py

@@ -1,5 +1,5 @@
 """
-Function to download the IGPP Earth east-west and south-north deflection datasets from
+Function to download the IGPP Earth east-west and north-south deflection datasets from
 the GMT data server, and load as :class:`xarray.DataArray`.
 
 The grids are available in various resolutions.
@@ -20,18 +20,18 @@ def load_earth_deflection(
     ] = "01d",
     region: Sequence[float] | str | None = None,
     registration: Literal["gridline", "pixel", None] = None,
-    direction: Literal["east_west", "south_north"] = "east_west",
+    direction: Literal["east", "north"] = "east",
 ) -> xr.DataArray:
     r"""
-    Load the IGPP Earth east-west and south-north deflection datasets in various
+    Load the IGPP Earth east-west and north-south deflection datasets in various
     resolutions.
 
     .. list-table::
        :widths: 50 50
        :header-rows: 1
 
        * - IGPP Earth east-west deflection
-         - IGPP Earth south-north deflection
+         - IGPP Earth north-south deflection
        * - .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_earth_edefl.jpg
          - .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_earth_ndefl.jpg
 
@@ -71,8 +71,8 @@ def load_earth_deflection(
         ``"gridline"`` for gridline registration. Default is ``None``, means
         ``"gridline"`` for all resolutions except ``"01m"`` which is ``"pixel"`` only.
     direction
-        By default, the east-west deflection (``direction="east_west"``) is returned,
-        ``direction="south_north"`` to return the south-north deflection.
+        By default, the east-west deflection (``direction="east"``) is returned,
+        ``direction="north"`` to return the north-south deflection.
 
     Returns
     -------
@@ -97,16 +97,16 @@ def load_earth_deflection(
     >>> # load the default grid for east-west deflection (gridline-registered
     >>> # 1 arc-degree grid)
     >>> grid = load_earth_deflection()
-    >>> # load the default grid for south-north deflection
-    >>> grid = load_earth_deflection(direction="ndefl")
+    >>> # load the default grid for north-south deflection
+    >>> grid = load_earth_deflection(component="ndefl")
     >>> # load the 30 arc-minutes grid with "gridline" registration
     >>> grid = load_earth_deflection(resolution="30m", registration="gridline")
     >>> # load high-resolution (5 arc-minutes) grid for a specific region
     >>> grid = load_earth_deflection(
     ...     resolution="05m", region=[120, 160, 30, 60], registration="gridline"
     ... )
     """
-    prefix = "earth_ndefl" if direction == "south_north" else "earth_edefl"
+    prefix = "earth_ndefl" if direction == "north" else "earth_edefl"
     grid = _load_remote_dataset(
         name=prefix,
         prefix=prefix,

pygmt/datasets/load_remote_dataset.py

@@ -296,7 +296,7 @@ class GMTRemoteDataset(NamedTuple):
         },
     ),
     "earth_ndefl": GMTRemoteDataset(
-        description="IGPP Earth south-north deflection",
+        description="IGPP Earth north-south deflection",
         units="micro-radians",
         extra_attributes={"horizontal_datum": "WGS84"},
         resolutions={

pygmt/tests/test_datasets_earth_deflection.py

@@ -57,12 +57,12 @@ def test_earth_edefl_01m_default_registration():
 
 def test_earth_ndefl_01d():
     """
-    Test some properties of the Earth south-north deflection 01d data.
+    Test some properties of the Earth north-south deflection 01d data.
     """
-    data = load_earth_deflection(resolution="01d", direction="south_north")
+    data = load_earth_deflection(resolution="01d", component="north")
     assert data.name == "z"
     assert data.attrs["long_name"] == "ndefl (microradians)"
-    assert data.attrs["description"] == "IGPP Earth south-north deflection"
+    assert data.attrs["description"] == "IGPP Earth north-south deflection"
     assert data.attrs["units"] == "micro-radians"
     assert data.attrs["horizontal_datum"] == "WGS84"
     assert data.shape == (181, 361)
@@ -75,10 +75,10 @@ def test_earth_ndefl_01d():
 
 def test_earth_ndefl_01d_with_region():
     """
-    Test loading low-resolution Earth south-north deflection with "region".
+    Test loading low-resolution Earth north-south deflection with "region".
     """
     data = load_earth_deflection(
-        resolution="01d", region=[-10, 10, -5, 5], direction="south_north"
+        resolution="01d", region=[-10, 10, -5, 5], component="north"
     )
     assert data.shape == (11, 21)
     assert data.gmt.registration == 0
@@ -94,7 +94,7 @@ def test_earth_ndefl_01m_default_registration():
     registration.
     """
     data = load_earth_deflection(
-        resolution="01m", region=[-10, -9, 3, 5], direction="south_north"
+        resolution="01m", region=[-10, -9, 3, 5], component="north"
     )
     assert data.shape == (120, 60)
     assert data.gmt.registration == 1