Skip to content

Commit d41618c

Browse files
authored
Remove the "full test" section from installation guide (#1206)
- 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.
1 parent 38f4d1f commit d41618c

File tree

1 file changed

+4
-22
lines changed

1 file changed

+4
-22
lines changed

doc/install.rst

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -159,35 +159,17 @@ from Python.
159159
Testing your install
160160
--------------------
161161

162-
Quick check
163-
~~~~~~~~~~~
164-
165162
To ensure that PyGMT and its dependencies are installed correctly, run the
166163
following in your Python interpreter::
167164

168165
import pygmt
169166
pygmt.show_versions()
170167

171-
Or run this in the command line::
172-
173-
python -c "import pygmt; pygmt.show_versions()"
174-
175-
176-
Full test (optional)
177-
~~~~~~~~~~~~~~~~~~~~
178-
179-
PyGMT ships with a full test suite.
180-
You can run our tests after you install it but you will need a few extra
181-
dependencies as well (be sure to have your conda environment activated)::
168+
fig = pygmt.Figure()
169+
fig.coast(region="g", frame=True, shorelines=1)
170+
fig.show()
182171

183-
conda install pytest pytest-mpl ipython
184-
185-
Test your installation by running the following inside a Python interpreter
186-
(note that it may take a few minutes)::
187-
188-
import pygmt
189-
pygmt.show_versions()
190-
pygmt.test()
172+
If you see a global map with shorelines, then you're all set.
191173

192174

193175
Finding the GMT shared library

0 commit comments

Comments
 (0)