Merge branch 'main' into add-tut-symbols

GenericMappingTools · Dec 24, 2024 · 3d3010d · 3d3010d
2 parents d35af8b + 5a3a290
commit 3d3010d
Show file tree

Hide file tree

Showing 76 changed files with 551 additions and 283 deletions.
diff --git a/.github/workflows/benchmarks.yml b/.github/workflows/benchmarks.yml
@@ -45,7 +45,7 @@ jobs:
 
       # Install Micromamba with conda-forge dependencies
       - name: Setup Micromamba
-        uses: mamba-org/[email protected].2
+        uses: mamba-org/[email protected].3
         with:
           environment-name: pygmt
           condarc: |
@@ -58,14 +58,14 @@ jobs:
           cache-environment-key: micromamba-environment-${{ steps.date.outputs.date }}
           create-args: >-
             gmt=6.5.0
-            python=3.12
+            python=3.13
             numpy
             pandas
             xarray
             netCDF4
             packaging
             geopandas
-            pyarrow
+            pyarrow-core
             pytest
             pytest-codspeed
             pytest-mpl
@@ -87,7 +87,7 @@ jobs:
 
       # Run the benchmark tests
       - name: Run benchmarks
-        uses: CodSpeedHQ/action@v3.1.0
+        uses: CodSpeedHQ/action@v3.2.0
         with:
           # 'bash -el -c' is needed to use the custom shell.
           # See https://github.com/CodSpeedHQ/action/issues/65.

diff --git a/.github/workflows/cache_data.yaml b/.github/workflows/cache_data.yaml
@@ -43,15 +43,15 @@ jobs:
 
       # Install Micromamba with conda-forge dependencies
       - name: Setup Micromamba
-        uses: mamba-org/[email protected].2
+        uses: mamba-org/[email protected].3
         with:
           environment-name: pygmt
           condarc: |
             channels:
               - conda-forge
               - nodefaults
           create-args: >-
-            python=3.12
+            python=3.13
             gmt=6.5.0
             numpy
             pandas

diff --git a/.github/workflows/ci_docs.yml b/.github/workflows/ci_docs.yml
@@ -55,7 +55,7 @@ jobs:
         # Is it a draft Pull Request (true or false)?
         isDraft:
           - ${{ github.event.pull_request.draft }}
-        # Only run one job (Ubuntu + Python 3.12) for draft PRs
+        # Only run jobs on Ubuntu for draft PRs
         exclude:
           - os: macos-latest
             isDraft: true
@@ -80,7 +80,7 @@ jobs:
 
       # Install Micromamba with conda-forge dependencies
       - name: Setup Micromamba
-        uses: mamba-org/[email protected].2
+        uses: mamba-org/[email protected].3
         with:
           environment-name: pygmt
           condarc: |
@@ -92,7 +92,7 @@ jobs:
           # environment cache is persistent for one week.
           cache-environment-key: micromamba-environment-${{ steps.date.outputs.date }}
           create-args: >-
-            python=3.12
+            python=3.13
             gmt=6.5.0
             ghostscript=10.04.0
             numpy
@@ -101,16 +101,16 @@ jobs:
             netCDF4
             packaging
             contextily
-            geopandas<1.0
+            geopandas
             ipython
-            pyarrow
+            pyarrow-core
             rioxarray
             make
             pip
             python-build
             myst-nb
             panel
-            sphinx
+            sphinx>=6.2
             sphinx-autodoc-typehints
             sphinx-copybutton
             sphinx-design

diff --git a/.github/workflows/ci_doctests.yaml b/.github/workflows/ci_doctests.yaml
@@ -42,15 +42,15 @@ jobs:
 
       # Install Micromamba with conda-forge dependencies
       - name: Setup Micromamba
-        uses: mamba-org/[email protected].2
+        uses: mamba-org/[email protected].3
         with:
           environment-name: pygmt
           condarc: |
             channels:
               - conda-forge
               - nodefaults
           create-args: >-
-            python=3.12
+            python=3.13
             gmt=6.5.0
             numpy
             pandas
@@ -60,7 +60,7 @@ jobs:
             contextily
             geopandas
             ipython
-            pyarrow
+            pyarrow-core
             rioxarray
             make
             pip

diff --git a/.github/workflows/ci_tests.yaml b/.github/workflows/ci_tests.yaml
@@ -56,7 +56,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.10', '3.12']
+        python-version: ['3.11', '3.13']
         os: [ubuntu-latest, macos-latest, windows-latest]
         # Is it a draft Pull Request (true or false)?
         isDraft:
@@ -68,21 +68,21 @@ jobs:
           - os: windows-latest
             isDraft: true
         include:
-          # Python 3.10 + core packages (minimum supported versions) + optional packages (minimum supported versions if any)
-          - python-version: '3.10'
-            numpy-version: '1.24'
+          # Python 3.11 + core packages (minimum supported versions) + optional packages (minimum supported versions if any)
+          - python-version: '3.11'
+            numpy-version: '1.25'
             pandas-version: '=2.0'
             xarray-version: '=2023.04'
-            optional-packages: ' contextily geopandas<1 ipython pyarrow rioxarray sphinx-gallery'
-          # Python 3.12 + core packages (latest versions) + optional packages
-          - python-version: '3.12'
-            numpy-version: '2.1'
+            optional-packages: ' contextily geopandas<1 ipython pyarrow-core rioxarray sphinx-gallery'
+          # Python 3.13 + core packages (latest versions) + optional packages
+          - python-version: '3.13'
+            numpy-version: '2.2'
             pandas-version: ''
             xarray-version: ''
-            optional-packages: ' contextily geopandas>=1.0 ipython pyarrow rioxarray sphinx-gallery'
-          # Python 3.11 + core packages (Linux only)
+            optional-packages: ' contextily geopandas>=1.0 ipython pyarrow-core rioxarray sphinx-gallery'
+          # Python 3.12 + core packages (Linux only)
           - os: 'ubuntu-latest'
-            python-version: '3.11'
+            python-version: '3.12'
             numpy-version: ''
             pandas-version: ''
             xarray-version: ''
@@ -113,7 +113,7 @@ jobs:
 
       # Install Micromamba with conda-forge dependencies
       - name: Setup Micromamba
-        uses: mamba-org/[email protected].2
+        uses: mamba-org/[email protected].3
         with:
           environment-name: pygmt
           condarc: |
@@ -133,7 +133,6 @@ jobs:
             xarray${{ matrix.xarray-version }}
             netCDF4
             packaging
-            dvc
             make
             pip
             python-build
@@ -154,9 +153,21 @@ jobs:
         env:
           GH_TOKEN: ${{ github.token }}
 
+      - name: Install uv
+        uses: astral-sh/[email protected]
+
+      - name: Install dvc
+        run: |
+          uv venv
+          source .venv/bin/activate
+          uv pip install dvc
+          uv pip list
+
       # Pull baseline image data from dvc remote (DAGsHub)
       - name: Pull baseline image data from dvc remote
-        run: dvc pull --no-run-cache --verbose && ls -lhR pygmt/tests/baseline/
+        run: |
+          source .venv/bin/activate
+          uv run dvc pull --no-run-cache --verbose && ls -lhR pygmt/tests/baseline/
 
       # Install the package that we want to test
       - name: Install the package
@@ -176,7 +187,7 @@ jobs:
 
       # Upload coverage to Codecov
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v5.0.7
+        uses: codecov/codecov-action@v5.1.1
         if: success() || failure()
         with:
           use_oidc: true

diff --git a/.github/workflows/ci_tests_dev.yaml b/.github/workflows/ci_tests_dev.yaml
@@ -36,7 +36,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-24.04, macos-15, windows-2022]
+        os: [ubuntu-24.04, macos-15, windows-2025]
         gmt_git_ref: [master]
     timeout-minutes: 30
     defaults:
@@ -57,7 +57,7 @@ jobs:
 
       # Install Micromamba with conda-forge dependencies
       - name: Setup Micromamba
-        uses: mamba-org/[email protected].2
+        uses: mamba-org/[email protected].3
         with:
           environment-name: pygmt
           condarc: |
@@ -69,7 +69,7 @@ jobs:
           # environment cache is persistent for one week.
           cache-environment-key: micromamba-environment-${{ steps.date.outputs.date }}
           create-args: >-
-            python=3.12
+            python=3.13
             cmake
             make
             ninja

diff --git a/.github/workflows/ci_tests_legacy.yaml b/.github/workflows/ci_tests_legacy.yaml
@@ -51,15 +51,15 @@ jobs:
 
       # Install Micromamba with conda-forge dependencies
       - name: Setup Micromamba
-        uses: mamba-org/[email protected].2
+        uses: mamba-org/[email protected].3
         with:
           environment-name: pygmt
           condarc: |
             channels:
               - conda-forge
               - nodefaults
           create-args: >-
-            python=3.10
+            python=3.11
             gmt=${{ matrix.gmt_version }}
             ghostscript<10
             numpy<2
@@ -70,7 +70,7 @@ jobs:
             contextily
             geopandas
             ipython
-            pyarrow
+            pyarrow-core
             rioxarray
             sphinx-gallery
             make

diff --git a/.github/workflows/format-command.yml b/.github/workflows/format-command.yml
@@ -27,7 +27,7 @@ jobs:
       # Setup Python environment
       - uses: actions/[email protected]
         with:
-          python-version: '3.12'
+          python-version: '3.13'
 
       # Install formatting tools
       - name: Install formatting tools

diff --git a/.github/workflows/publish-to-pypi.yml b/.github/workflows/publish-to-pypi.yml
@@ -53,7 +53,7 @@ jobs:
     - name: Set up Python
       uses: actions/[email protected]
       with:
-        python-version: '3.12'
+        python-version: '3.13'
 
     - name: Install dependencies
       run: python -m pip install build
@@ -75,10 +75,10 @@ jobs:
         ls -lh dist/
 
     - name: Publish to Test PyPI
-      uses: pypa/[email protected].2
+      uses: pypa/[email protected].3
       with:
         repository-url: https://test.pypi.org/legacy/
 
     - name: Publish to PyPI
       if: startsWith(github.ref, 'refs/tags')
-      uses: pypa/[email protected].2
+      uses: pypa/[email protected].3
diff --git a/.github/workflows/style_checks.yaml b/.github/workflows/style_checks.yaml
@@ -30,7 +30,7 @@ jobs:
       - name: Set up Python
         uses: actions/[email protected]
         with:
-          python-version: '3.12'
+          python-version: '3.13'
 
       - name: Install packages
         run: |

diff --git a/.github/workflows/type_checks.yml b/.github/workflows/type_checks.yml
@@ -39,7 +39,7 @@ jobs:
       - name: Set up Python
         uses: actions/[email protected]
         with:
-          python-version: '3.12'
+          python-version: '3.13'
 
       - name: Install packages
         run: |

diff --git a/ci/requirements/docs.yml b/ci/requirements/docs.yml
@@ -4,7 +4,7 @@ channels:
     - nodefaults
 dependencies:
     # Required dependencies
-    - python=3.12
+    - python=3.13
     - gmt=6.5.0
     - ghostscript=10.04.0
     - numpy
@@ -14,9 +14,9 @@ dependencies:
     - packaging
     # Optional dependencies
     - contextily
-    - geopandas<1.0
+    - geopandas
     - ipython
-    - pyarrow
+    - pyarrow-core
     - rioxarray
     # Development dependencies (general)
     - make
@@ -25,7 +25,7 @@ dependencies:
     # Dev dependencies (building documentation)
     - myst-nb
     - panel
-    - sphinx
+    - sphinx>=6.2
     - sphinx-autodoc-typehints
     - sphinx-copybutton
     - sphinx-design

diff --git a/doc/_templates/autosummary/enums.rst b/doc/_templates/autosummary/enums.rst
@@ -0,0 +1,7 @@
+{{ fullname | escape | underline }}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+    :members:
+    :member-order: bysource
diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -195,6 +195,20 @@ Getting metadata from tabular or grid data:
     info
     grdinfo
 
+Enums
+-----
+
+.. currentmodule:: pygmt.enums
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: autosummary/enums.rst
+
+    GridRegistration
+    GridType
+
+.. currentmodule:: pygmt
 
 Miscellaneous
 -------------
@@ -205,8 +219,6 @@ Miscellaneous
     which
     show_versions
 
-.. currentmodule:: pygmt
-
 Datasets
 --------
 

diff --git a/doc/conf.py b/doc/conf.py
@@ -171,7 +171,7 @@
 ]
 
 source_suffix = ".rst"
-needs_sphinx = "1.8"
+needs_sphinx = "6.2"
 # Encoding of source files
 source_encoding = "utf-8-sig"
 root_doc = "index"