Merge branch 'master' into test-coast-dvc

Author: willschlitzer

.github/workflows/ci_tests_dev.yaml

@@ -1,5 +1,4 @@
-# This workflow installs PyGMT dependencies, builds documentation and runs tests on GMT dev version
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+# This workflow installs PyGMT and runs tests on GMT dev version
 
 name: GMT Dev Tests
 
@@ -10,10 +9,13 @@ on:
     types: [ready_for_review]
     paths-ignore:
       - 'doc/**'
+      - 'examples/**'
       - '*.md'
       - '*.json'
       - 'README.rst'
       - 'LICENSE.txt'
+      - '.gitignore'
+      - '.pylintrc'
   repository_dispatch:
     types: [test-gmt-dev-command]
   # Schedule daily tests
@@ -28,7 +30,7 @@ jobs:
       fail-fast: false
       matrix:
         python-version: [3.9]
-        os: [ubuntu-20.04, macOS-10.15, windows-latest]
+        os: [ubuntu-latest, macOS-11.0, windows-latest]
         gmt_git_ref: [master]
     defaults:
       run:
@@ -73,6 +75,7 @@ jobs:
       - name: Setup Miniconda
         uses: conda-incubator/setup-miniconda@v2.0.1
         with:
+          activate-environment: pygmt
           python-version: ${{ matrix.python-version }}
           channels: conda-forge
           miniconda-version: "latest"
@@ -81,8 +84,9 @@ jobs:
       - name: Install dependencies
         run: |
           conda install ninja cmake libblas libcblas liblapack fftw gdal \
-                        ghostscript libnetcdf hdf5 zlib curl pcre ipython \
-                        dvc pytest pytest-cov pytest-mpl
+                        ghostscript libnetcdf hdf5 zlib curl pcre make dvc
+          pip install --pre numpy pandas xarray netCDF4 packaging \
+                            ipython pytest-cov pytest-mpl pytest>=6.0 sphinx-gallery
 
       # Build and install latest GMT from GitHub
       - name: Install GMT ${{ matrix.gmt_git_ref }} branch (Linux/macOS)

CONTRIBUTING.md

@@ -369,35 +369,13 @@ or run tests which contain names that match a specific keyword expression:
 Writing an image-based test is only slightly more difficult than a simple test.
 The main consideration is that you must specify the "baseline" or reference
 image, and compare it with a "generated" or test image. This is handled using
-the *decorator* functions `@check_figures_equal` and
-`@pytest.mark.mpl_image_compare` whose usage are further described below.
-
-#### Using check_figures_equal
-
-This approach draws the same figure using two different methods (the reference
-method and the tested method), and checks that both of them are the same.
-It takes two `pygmt.Figure` objects ('fig_ref' and 'fig_test'), generates a png
-image, and checks for the Root Mean Square (RMS) error between the two.
-Here's an example:
-
-```python
-@check_figures_equal()
-def test_my_plotting_case():
-  "Test that my plotting function works"
-  fig_ref, fig_test = Figure(), Figure()
-  fig_ref.grdimage("@earth_relief_01d_g", projection="W120/15c", cmap="geo")
-  fig_test.grdimage(grid, projection="W120/15c", cmap="geo")
-  return fig_ref, fig_test
-```
-
-Note: This is the recommended way to test plots whenever possible, such as when
-we want to compare a reference GMT plot created from NetCDF files with one
-generated by PyGMT that passes through several layers of virtualfile machinery.
-Using this method will help save space in the git repository by not having to
-store baseline images as with the other method below.
+the *decorator* functions `@pytest.mark.mpl_image_compare` and `@check_figures_equal`
+whose usage are further described below.
 
 #### Using mpl_image_compare
 
+> **This is the preferred way to test plots whenever possible.**
+
 This method uses the [pytest-mpl](https://github.com/matplotlib/pytest-mpl)
 plug-in to test plot generating code.
 Every time the tests are run, `pytest-mpl` compares the generated plots with known
@@ -502,6 +480,24 @@ summarized as follows:
     git push
     dvc push
 
+#### Using check_figures_equal
+
+This approach draws the same figure using two different methods (the reference
+method and the tested method), and checks that both of them are the same.
+It takes two `pygmt.Figure` objects ('fig_ref' and 'fig_test'), generates a png
+image, and checks for the Root Mean Square (RMS) error between the two.
+Here's an example:
+
+```python
+@check_figures_equal()
+def test_my_plotting_case():
+  "Test that my plotting function works"
+  fig_ref, fig_test = Figure(), Figure()
+  fig_ref.grdimage("@earth_relief_01d_g", projection="W120/15c", cmap="geo")
+  fig_test.grdimage(grid, projection="W120/15c", cmap="geo")
+  return fig_ref, fig_test
+```
+
 ### Documentation
 
 #### Building the documentation

pygmt/datasets/__init__.py

@@ -3,7 +3,7 @@
 # Load sample data included with GMT (downloaded from the GMT cache server).
 
 from pygmt.datasets.earth_relief import load_earth_relief
-from pygmt.datasets.tutorial import (
+from pygmt.datasets.samples import (
     load_japan_quakes,
     load_ocean_ridge_points,
     load_sample_bathymetry,

pygmt/datasets/tutorial.py renamed to pygmt/datasets/samples.py

@@ -1,5 +1,5 @@
 """
-Functions to load sample data from the GMT tutorials.
+Functions to load sample data.
 """
 import pandas as pd
 from pygmt.src import which

pygmt/tests/test_datasets_tutorial.py renamed to pygmt/tests/test_datasets_samples.py

@@ -1,5 +1,5 @@
 """
-Test basic functionality for loading datasets for tutorials.
+Test basic functionality for loading sample datasets.
 """
 from pygmt.datasets import (
     load_japan_quakes,