Merge branch 'main' into try-micromamba

Author: seisman

.github/ISSUE_TEMPLATE/bump_gmt_checklist.md

@@ -29,7 +29,6 @@ assignees: ''
 **To-Do for bumping the minimum required GMT version**:
 
 - [ ] Bump the minimum required GMT version (1 PR)
-  - [ ] Update `doc/install.rst`
   - [ ] Update `required_version` in `pygmt/clib/session.py`
   - [ ] Update `test_get_default` in `pygmt/tests/test_clib.py`
   - [ ] Update compatibility table in `README.rst`

.github/workflows/cache_data.yaml

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

.github/workflows/check-links.yml

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

.github/workflows/ci_docs.yml

@@ -60,7 +60,7 @@ jobs:
 
       # Checkout current git repository
       - name: Checkout
-        uses: actions/[email protected].0
+        uses: actions/[email protected].2
         with:
           # fetch all history so that setuptools-scm works
           fetch-depth: 0
@@ -80,7 +80,7 @@ jobs:
 
       # Download cached remote files (artifacts) from GitHub
       - name: Download remote data from GitHub
-        uses: dawidd6/action-download-artifact@v2.26.1
+        uses: dawidd6/action-download-artifact@v2.27.0
         with:
           workflow: cache_data.yaml
           workflow_conclusion: success
@@ -107,7 +107,7 @@ jobs:
         run: make -C doc clean all
 
       - name: Checkout the gh-pages branch
-        uses: actions/[email protected].0
+        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:
 
       # Checkout current git repository
       - name: Checkout
-        uses: actions/checkout@v3.4.0
+        uses: actions/checkout@v3.5.2
         with:
           # fetch all history so that setuptools-scm works
           fetch-depth: 0
@@ -54,7 +54,7 @@ jobs:
 
       # Download cached remote files (artifacts) from GitHub
       - name: Download remote data from GitHub
-        uses: dawidd6/action-download-artifact@v2.26.0
+        uses: dawidd6/action-download-artifact@v2.27.0
         with:
           workflow: cache_data.yaml
           workflow_conclusion: success

.github/workflows/ci_tests.yaml

@@ -89,7 +89,7 @@ jobs:
 
       # Checkout current git repository
       - name: Checkout
-        uses: actions/[email protected].0
+        uses: actions/[email protected].2
         with:
           # fetch all history so that setuptools-scm works
           fetch-depth: 0
@@ -111,7 +111,7 @@ jobs:
 
       # Download cached remote files (artifacts) from GitHub
       - name: Download remote data from GitHub
-        uses: dawidd6/action-download-artifact@v2.26.1
+        uses: dawidd6/action-download-artifact@v2.27.0
         with:
           workflow: cache_data.yaml
           workflow_conclusion: success

.github/workflows/ci_tests_dev.yaml

@@ -54,7 +54,7 @@ jobs:
 
       # Checkout current git repository
       - name: Checkout
-        uses: actions/[email protected].0
+        uses: actions/[email protected].2
         if: github.event_name != 'repository_dispatch'
         with:
           # fetch all history so that setuptools-scm works
@@ -71,7 +71,7 @@ jobs:
 
       # Checkout the pull request branch
       - name: Checkout
-        uses: actions/[email protected].0
+        uses: actions/[email protected].2
         if: github.event_name == 'repository_dispatch'
         with:
           token: ${{ steps.generate-token.outputs.token }}
@@ -155,7 +155,7 @@ jobs:
 
       # Download cached remote files (artifacts) from GitHub
       - name: Download remote data from GitHub
-        uses: dawidd6/action-download-artifact@v2.26.1
+        uses: dawidd6/action-download-artifact@v2.27.0
         with:
           workflow: cache_data.yaml
           workflow_conclusion: success

.github/workflows/ci_tests_legacy.yaml

@@ -47,7 +47,7 @@ jobs:
 
       # Checkout current git repository
       - name: Checkout
-        uses: actions/[email protected].0
+        uses: actions/[email protected].2
         with:
           # fetch all history so that setuptools-scm works
           fetch-depth: 0
@@ -68,7 +68,7 @@ jobs:
 
       # Download cached remote files (artifacts) from GitHub
       - name: Download remote data from GitHub
-        uses: dawidd6/action-download-artifact@v2.26.1
+        uses: dawidd6/action-download-artifact@v2.27.0
         with:
           workflow: cache_data.yaml
           workflow_conclusion: success

.github/workflows/dvc-diff.yml

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

.github/workflows/format-command.yml

@@ -18,7 +18,7 @@ jobs:
           private_key: ${{ secrets.APP_PRIVATE_KEY }}
 
       # Checkout the pull request branch
-      - uses: actions/[email protected].0
+      - uses: actions/[email protected].2
         with:
           token: ${{ steps.generate-token.outputs.token }}
           repository: ${{ github.event.client_payload.pull_request.head.repo.full_name }}

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

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

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

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

.github/workflows/style_checks.yaml

@@ -24,7 +24,7 @@ jobs:
     steps:
       # Checkout current git repository
       - name: Checkout
-        uses: actions/[email protected].0
+        uses: actions/[email protected].2
 
       # Setup Python
       - name: Set up Python

doc/conf.py

@@ -5,12 +5,14 @@
 # pylint: disable=invalid-name
 
 import datetime
+from importlib.metadata import metadata
 
 # isort: off
 from sphinx_gallery.sorting import (  # pylint: disable=no-name-in-module
     ExplicitOrder,
     ExampleTitleSortKey,
 )
+import pygmt
 from pygmt import __commit__, __version__
 from pygmt.sphinx_gallery import PyGMTScraper
 
@@ -149,9 +151,15 @@
     html_baseurl = "https://pygmt.org/latest/"
 release = __version__
 
+requires_python = metadata("pygmt")["Requires-Python"]
+with pygmt.clib.Session() as lib:
+    requires_gmt = ">=" + lib.required_version
+
 # These enable substitutions using |variable| in the rst files
 rst_epilog = f"""
 .. |year| replace:: {year}
+.. |requires_python| replace:: {requires_python}
+.. |requires_gmt| replace:: {requires_gmt}
 """
 
 html_last_updated_fmt = "%b %d, %Y"

doc/install.rst

@@ -64,7 +64,7 @@ Start by looking at the tutorials on our sidebar, good luck!
 Which Python?
 -------------
 
-PyGMT is tested to run on **Python 3.9 or greater**.
+PyGMT is tested to run on Python |requires_python|.
 
 We recommend using the `Mambaforge <https://github.com/conda-forge/miniforge#mambaforge>`__
 Python distribution to ensure you have all dependencies installed and the
@@ -77,12 +77,9 @@ installations on your system.
 Which GMT?
 ----------
 
-PyGMT requires Generic Mapping Tools (GMT) version 6 as a minimum, which is the
-latest released version that can be found at
-the `GMT official site <https://www.generic-mapping-tools.org>`__.
-We need the latest GMT (>=6.3.0) since there are many changes being made to GMT
-itself in response to the development of PyGMT, mainly the new
-:gmt-docs:`modern execution mode <cookbook/introduction.html#modern-and-classic-mode>`.
+PyGMT requires Generic Mapping Tools (GMT) |requires_gmt| since there
+are many changes being made to GMT itself in response to the development of PyGMT,
+mainly the new :gmt-docs:`modern execution mode <cookbook/introduction.html#modern-and-classic-mode>`.
 
 Compiled conda packages of GMT for Linux, macOS and Windows are provided
 through `conda-forge <https://anaconda.org/conda-forge/gmt>`__.

pygmt/helpers/decorators.py

@@ -679,7 +679,7 @@ def kwargs_to_strings(**conversions):
     >>> import xarray as xr
     >>> module(
     ...     R=[
-    ...         xr.DataArray(data=np.datetime64("2005-01-01T08:00:00")),
+    ...         xr.DataArray(data=np.datetime64("2005-01-01T08:00:00", "ns")),
     ...         pd.Timestamp("2015-01-01T12:00:00.123456789"),
     ...     ]
     ... )

pygmt/src/colorbar.py

@@ -85,8 +85,8 @@ def colorbar(self, **kwargs):
         rectangular borders instead, with a 6p corner radius. You can override
         this radius by appending another value. Finally, append **+s** to draw
         an offset background shaded region. Here, *dx/dy* indicates the shift
-        relative to the foreground frame [4p/-4p] and shade sets the fill
-        style to use for shading [Default is ``"gray50"``].
+        relative to the foreground frame [Default is ``"4p/-4p"``] and shade
+        sets the fill style to use for shading [Default is ``"gray50"``].
     truncate : list or str
         *zlo*/*zhi*.
         Truncate the incoming CPT so that the lowest and highest z-levels are