Skip to content

Remove the "full test" section from installation guide #1206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 14, 2021
Merged

Remove the "full test" section from installation guide #1206

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 4 additions & 22 deletions doc/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down