From 54f49dae283b124a666163c0eb28a61d19668504 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 12 Apr 2021 17:11:58 -0400 Subject: [PATCH] Remove the 'full test' section from installation guide Changes in this PR: - Remove the "Full test" section since it's no longer valid after migrating baseline images to dvc - Add a simple script to test the install. If it works, at least we know that the coast function, GSHHG data and gs work as expected. --- doc/install.rst | 26 ++++---------------------- 1 file changed, 4 insertions(+), 22 deletions(-) diff --git a/doc/install.rst b/doc/install.rst index b3a000b1143..75e9995331c 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -159,35 +159,17 @@ from Python. Testing your install -------------------- -Quick check -~~~~~~~~~~~ - To ensure that PyGMT and its dependencies are installed correctly, run the following in your Python interpreter:: import pygmt pygmt.show_versions() -Or run this in the command line:: - - python -c "import pygmt; pygmt.show_versions()" - - -Full test (optional) -~~~~~~~~~~~~~~~~~~~~ - -PyGMT ships with a full test suite. -You can run our tests after you install it but you will need a few extra -dependencies as well (be sure to have your conda environment activated):: + fig = pygmt.Figure() + fig.coast(region="g", frame=True, shorelines=1) + fig.show() - conda install pytest pytest-mpl ipython - -Test your installation by running the following inside a Python interpreter -(note that it may take a few minutes):: - - import pygmt - pygmt.show_versions() - pygmt.test() +If you see a global map with shorelines, then you're all set. Finding the GMT shared library