Merge branch 'main' into alias/function

seisman · seisman · commit 1fbdef02b648 · 2024-01-03T20:01:08.000+08:00
diff --git a/.github/workflows/benchmarks.yml b/.github/workflows/benchmarks.yml
@@ -61,7 +61,7 @@ jobs:
           echo $CONDA/bin >> $GITHUB_PATH
           conda install --solver=libmamba gmt=6.4.0 python=3.12 \
                         numpy pandas xarray netCDF4 packaging \
-                        geopandas pytest pytest-benchmark pytest-mpl
+                        geopandas pytest pytest-mpl
           python -m pip install -U pytest-codspeed setuptools
 
       # Download cached remote files (artifacts) from GitHub
diff --git a/.github/workflows/cache_data.yaml b/.github/workflows/cache_data.yaml
@@ -1,18 +1,21 @@
-# Cache GMT remote data files and uploads as artifacts
+# Cache GMT remote data files and upload as artifacts
 #
 # This workflow downloads data files needed by PyGMT tests/documentation from
 # the GMT data server and uploads as workflow artifacts which can be accessed
 # by other GitHub Actions workflows.
 #
 # It is scheduled to run every Sunday at 12:00 (UTC). If new remote files are
-# needed urgently, maintainers can manually uncomment the 'pull_request:' line
-# below to refresh the cache.
+# needed urgently, maintainers can update the workflow file or
+# 'pygmt/helpers/caching.py' file to refresh the cache.
 #
 name: Cache data
 
 on:
-  # Uncomment the 'pull_request' line below to manually re-cache data artifacts
-  # pull_request:
+  pull_request:
+    # Make any changes to the following files to refresh the cache
+    paths:
+      - 'pygmt/helpers/caching.py'
+      - '.github/workflows/cache_data.yaml'
   # Schedule runs on 12 noon every Sunday
   schedule:
     - cron: '0 12 * * 0'
@@ -61,7 +64,7 @@ jobs:
       # Download remote files
       - name: Download remote data
         run: |
-          python -c "from pygmt.helpers.testing import download_test_data; download_test_data()"
+          python -c "from pygmt.helpers.caching import cache_data; cache_data()"
 
       # Upload the downloaded files as artifacts to GitHub
       - name: Upload artifacts to GitHub
diff --git a/.github/workflows/ci_docs.yml b/.github/workflows/ci_docs.yml
@@ -72,7 +72,7 @@ jobs:
             channels:
               - conda-forge
               - nodefaults
-          cache-downloads: true
+          cache-downloads: false
           cache-environment: true
           create-args: >-
             python=3.12
diff --git a/.github/workflows/ci_tests.yaml b/.github/workflows/ci_tests.yaml
@@ -101,7 +101,7 @@ jobs:
             channels:
               - conda-forge
               - nodefaults
-          cache-downloads: true
+          cache-downloads: false
           cache-environment: true
           create-args: >-
             python=${{ matrix.python-version }}${{ matrix.optional-packages }}
diff --git a/.github/workflows/ci_tests_dev.yaml b/.github/workflows/ci_tests_dev.yaml
@@ -95,7 +95,7 @@ jobs:
             channels:
               - conda-forge
               - nodefaults
-          cache-downloads: true
+          cache-downloads: false
           cache-environment: true
           create-args: >-
             python=3.12
diff --git a/.github/workflows/ci_tests_legacy.yaml b/.github/workflows/ci_tests_legacy.yaml
@@ -59,7 +59,7 @@ jobs:
             channels:
               - conda-forge
               - nodefaults
-          cache-downloads: true
+          cache-downloads: false
           cache-environment: true
           create-args: >-
             python=3.9
diff --git a/examples/gallery/images/grdgradient_shading.py b/examples/gallery/images/grdgradient_shading.py
@@ -59,6 +59,6 @@
                 panel=True,
             )
 
-fig.colorbar(position="JBC+w10c/0.25c+h", frame="a2000f500+lElevation (m)")
+fig.colorbar(position="JBC+w10c/0.25c+h", frame="xa2000f500+lElevation (m)")
 
 fig.show()
diff --git a/examples/tutorials/basics/plot.py b/examples/tutorials/basics/plot.py
@@ -90,7 +90,7 @@
     style="cc",
     pen="black",
 )
-fig.colorbar(frame="af+lDepth (km)")
+fig.colorbar(frame="xaf+lDepth (km)")
 fig.show()
 
 # sphinx_gallery_thumbnail_number = 3
diff --git a/pygmt/helpers/caching.py b/pygmt/helpers/caching.py
@@ -0,0 +1,87 @@
+"""
+Functions for download remote data files as cache.
+"""
+from pygmt.src import which
+
+
+def cache_data():
+    """
+    Download GMT remote data files used in PyGMT tests and docs as cache files.
+    """
+    # List of datasets to download
+    datasets = [
+        # Earth relief grids
+        "@earth_gebco_01d_g",
+        "@earth_gebcosi_01d_g",
+        "@earth_gebcosi_15m_p",
+        "@earth_relief_01d_p",
+        "@earth_relief_01d_g",
+        "@earth_relief_30m_p",
+        "@earth_relief_30m_g",
+        "@earth_relief_10m_p",
+        "@earth_relief_10m_g",
+        "@earth_relief_05m_p",
+        "@earth_relief_05m_g",
+        "@earth_synbath_01d_g",
+        # List of tiles of 03s srtm data.
+        # Names like @N35E135.earth_relief_03s_g.nc are for internal use only.
+        # The naming scheme may change. DO NOT USE IT IN YOUR SCRIPTS.
+        "@N30W120.earth_relief_15s_p.nc",
+        "@N35E135.earth_relief_03s_g.nc",
+        "@N37W120.earth_relief_03s_g.nc",
+        "@N00W090.earth_relief_03m_p.nc",
+        "@N00E135.earth_relief_30s_g.nc",
+        "@N00W010.earth_relief_15s_p.nc",  # Specific grid for 15s test
+        "@N04W010.earth_relief_03s_g.nc",  # Specific grid for 03s test
+        # Earth synbath relief grid
+        "@S15W105.earth_synbath_30s_p.nc",
+        # Earth seafloor age grids
+        "@earth_age_01d_g",
+        "@N00W030.earth_age_01m_g.nc",  # Specific grid for 01m test
+        # Earth geoid grids
+        "@earth_geoid_01d_g",
+        "@N00W030.earth_geoid_01m_g.nc",  # Specific grid for 01m test
+        # Earth magnetic anomaly grids
+        "@earth_mag_01d_g",
+        "@S30W060.earth_mag_02m_p.nc",  # Specific grid for 02m test
+        "@earth_mag4km_01d_g",
+        "@S30W120.earth_mag4km_02m_p.nc",  # Specific grid for 02m test
+        # Earth mask grid
+        "@earth_mask_01d_g",
+        # Earth free-air anomaly grids
+        "@earth_faa_01d_g",
+        "@N00W030.earth_faa_01m_p.nc",  # Specific grid for 01m test
+        # Earth vertical gravity gradient grids
+        "@earth_vgg_01d_g",
+        "@N00W030.earth_vgg_01m_p.nc",  # Specific grid for 01m test
+        # Earth WDMAM grids
+        "@earth_wdmam_01d_g",
+        "@S90E000.earth_wdmam_03m_g.nc",  # Specific grid for 03m test
+        # Earth day/night grids
+        "@earth_day_01d_p",
+        # Other cache files
+        "@capitals.gmt",
+        "@circuit.png",
+        "@earth_relief_20m_holes.grd",
+        "@EGM96_to_36.txt",
+        "@MaunaLoa_CO2.txt",
+        "@RidgeTest.shp",
+        "@RidgeTest.shx",
+        "@RidgeTest.dbf",
+        "@RidgeTest.prj",
+        "@Table_5_11.txt",
+        "@Table_5_11_mean.xyz",
+        "@fractures_06.txt",
+        "@hotspots.txt",
+        "@ridge.txt",
+        "@mars370d.txt",
+        "@srtm_tiles.nc",  # needed for 03s and 01s relief data
+        "@static_earth_relief.nc",
+        "@ternary.txt",
+        "@test.dat.nc",
+        "@tut_bathy.nc",
+        "@tut_quakes.ngdc",
+        "@tut_ship.xyz",
+        "@usgs_quakes_22.txt",
+    ]
+    which(fname=datasets, download="a")
diff --git a/pygmt/helpers/testing.py b/pygmt/helpers/testing.py
@@ -142,89 +142,6 @@ def wrapper(*args, ext="png", request=None, **kwargs):
     return decorator
 
 
-def download_test_data():
-    """
-    Convenience function to download remote data files used in PyGMT tests and docs.
-    """
-    # List of datasets to download
-    datasets = [
-        # Earth relief grids
-        "@earth_gebco_01d_g",
-        "@earth_gebcosi_01d_g",
-        "@earth_gebcosi_15m_p",
-        "@earth_relief_01d_p",
-        "@earth_relief_01d_g",
-        "@earth_relief_30m_p",
-        "@earth_relief_30m_g",
-        "@earth_relief_10m_p",
-        "@earth_relief_10m_g",
-        "@earth_relief_05m_p",
-        "@earth_relief_05m_g",
-        "@earth_synbath_01d_g",
-        # List of tiles of 03s srtm data.
-        # Names like @N35E135.earth_relief_03s_g.nc is for internal use only.
-        # The naming scheme may change. DO NOT USE IT IN YOUR SCRIPTS.
-        "@N30W120.earth_relief_15s_p.nc",
-        "@N35E135.earth_relief_03s_g.nc",
-        "@N37W120.earth_relief_03s_g.nc",
-        "@N00W090.earth_relief_03m_p.nc",
-        "@N00E135.earth_relief_30s_g.nc",
-        "@N00W010.earth_relief_15s_p.nc",  # Specific grid for 15s test
-        "@N04W010.earth_relief_03s_g.nc",  # Specific grid for 03s test
-        # Earth synbath relief grids
-        "@S15W105.earth_synbath_30s_p.nc",
-        # Earth seafloor age grids
-        "@earth_age_01d_g",
-        "@N00W030.earth_age_01m_g.nc",  # Specific grid for 01m test
-        # Earth geoid grids
-        "@earth_geoid_01d_g",
-        "@N00W030.earth_geoid_01m_g.nc",  # Specific grid for 01m test
-        # Earth magnetic anomaly grids
-        "@earth_mag_01d_g",
-        "@S30W060.earth_mag_02m_p.nc",  # Specific grid for 02m test
-        "@earth_mag4km_01d_g",
-        "@S30W120.earth_mag4km_02m_p.nc",  # Specific grid for 02m test
-        # Earth mask grid
-        "@earth_mask_01d_g",
-        # Earth free-air anomaly grids
-        "@earth_faa_01d_g",
-        "@N00W030.earth_faa_01m_p.nc",  # Specific grid for 01m test
-        # Earth vertical gravity gradient grids
-        "@earth_vgg_01d_g",
-        "@N00W030.earth_vgg_01m_p.nc",  # Specific grid for 01m test
-        # Earth WDMAM grids
-        "@earth_wdmam_01d_g",
-        "@S90E000.earth_wdmam_03m_g.nc",  # Specific grid for 03m test
-        # Earth day/night grids
-        "@earth_day_01d_p",
-        # Other cache files
-        "@capitals.gmt",
-        "@circuit.png",
-        "@earth_relief_20m_holes.grd",
-        "@EGM96_to_36.txt",
-        "@MaunaLoa_CO2.txt",
-        "@RidgeTest.shp",
-        "@RidgeTest.shx",
-        "@RidgeTest.dbf",
-        "@RidgeTest.prj",
-        "@Table_5_11.txt",
-        "@Table_5_11_mean.xyz",
-        "@fractures_06.txt",
-        "@hotspots.txt",
-        "@ridge.txt",
-        "@mars370d.txt",
-        "@srtm_tiles.nc",  # needed for 03s and 01s relief data
-        "@static_earth_relief.nc",
-        "@ternary.txt",
-        "@test.dat.nc",
-        "@tut_bathy.nc",
-        "@tut_quakes.ngdc",
-        "@tut_ship.xyz",
-        "@usgs_quakes_22.txt",
-    ]
-    which(fname=datasets, download="a")
-
-
 def load_static_earth_relief():
     """
     Load the static_earth_relief file for internal testing.
diff --git a/pygmt/src/solar.py b/pygmt/src/solar.py
@@ -1,6 +1,10 @@
 """
 solar - Plot day-night terminators and twilight.
 """
+from __future__ import annotations
+
+from typing import Literal
+
 import pandas as pd
 from pygmt.clib import Session
 from pygmt.exceptions import GMTInvalidInput
@@ -22,32 +26,38 @@
     t="transparency",
 )
 @kwargs_to_strings(R="sequence", c="sequence_comma", p="sequence")
-def solar(self, terminator="d", terminator_datetime=None, **kwargs):
+def solar(
+    self,
+    terminator: Literal["astronomical", "civil", "day_night", "nautical"] = "day_night",
+    terminator_datetime=None,
+    **kwargs,
+):
     r"""
     Plot day-light terminators or twilights.
 
-    This function plots the day-night terminator. Alternatively, it can plot
-    the terminators for civil twilight, nautical twilight, or astronomical
-    twilight.
+    This function plots the day-night terminator. Alternatively, it can plot the
+    terminators for civil twilight, nautical twilight, or astronomical twilight.
 
     Full option list at :gmt-docs:`solar.html`
 
     {aliases}
 
     Parameters
     ----------
-    terminator : str
-        Set the type of terminator displayed. Valid arguments are
-        ``"day_night"``, ``"civil"``, ``"nautical"``, and ``"astronomical"``,
-        which can be set with either the full name or the first letter of the
-        name [Default is ``"day_night"``].
+    terminator
+        Set the type of terminator displayed, which can be set with either the full name
+        or the first letter of the name. Available options are:
 
-        Refer to https://en.wikipedia.org/wiki/Twilight for the definitions of
-        different types of twilight.
+        - ``"astronomical"``: Astronomical twilight
+        - ``"civil"``: Civil twilight
+        - ``"day_night"``: Day/night terminator
+        - ``"nautical"``: Nautical twilight
+
+        Refer to https://en.wikipedia.org/wiki/Twilight for the definitions of different
+        types of twilight.
     terminator_datetime : str or datetime object
-        Set the UTC date and time of the displayed terminator
-        [Default is the current UTC date and time]. It can be
-        passed as a string or Python datetime object.
+        Set the UTC date and time of the displayed terminator [Default is the current
+        UTC date and time]. It can be passed as a string or Python datetime object.
     {region}
     {projection}
     {frame}
@@ -86,25 +96,16 @@ def solar(self, terminator="d", terminator_datetime=None, **kwargs):
     >>> # show the plot
     >>> fig.show()
     """
-
     kwargs = self._preprocess(**kwargs)
     if kwargs.get("T") is not None:
+        msg = "Use 'terminator' and 'terminator_datetime' instead of 'T'."
+        raise GMTInvalidInput(msg)
+
+    valid_terminators = ["day_night", "civil", "nautical", "astronomical"]
+    if terminator not in valid_terminators and terminator not in "dcna":
         raise GMTInvalidInput(
-            "Use 'terminator' and 'terminator_datetime' instead of 'T'."
-        )
-    if terminator not in [
-        "day_night",
-        "civil",
-        "nautical",
-        "astronomical",
-        "d",
-        "c",
-        "n",
-        "a",
-    ]:
-        raise GMTInvalidInput(
-            f"Unrecognized solar terminator type '{terminator}'. Valid values "
-            "are 'day_night', 'civil', 'nautical', and 'astronomical'."
+            f"Unrecognized solar terminator type '{terminator}'. "
+            f"Valid values are {valid_terminators}."
         )
     kwargs["T"] = terminator[0]
     if terminator_datetime:
diff --git a/pygmt/tests/test_geopandas.py b/pygmt/tests/test_geopandas.py
diff --git a/pygmt/tests/test_grdimage_image.py b/pygmt/tests/test_grdimage_image.py

Original file line number	Diff line number	Diff line change
`@@ -59,6 +59,6 @@`
`59`	`59`	`panel=True,`
`60`	`60`	`)`
`61`	`61`
`62`		`-fig.colorbar(position="JBC+w10c/0.25c+h", frame="a2000f500+lElevation (m)")`
	`62`	`+fig.colorbar(position="JBC+w10c/0.25c+h", frame="xa2000f500+lElevation (m)")`
`63`	`63`
`64`	`64`	`fig.show()`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@`
`90`	`90`	`style="cc",`
`91`	`91`	`pen="black",`
`92`	`92`	`)`
`93`		`-fig.colorbar(frame="af+lDepth (km)")`
	`93`	`+fig.colorbar(frame="xaf+lDepth (km)")`
`94`	`94`	`fig.show()`
`95`	`95`
`96`	`96`	`# sphinx_gallery_thumbnail_number = 3`