Skip to content

Commit 2ecf8e4

Browse files
yvonnefroehlichseismanmichaelgrund
authored
Add working example to quickstart section of README (#2369)
Co-authored-by: Dongdong Tian <[email protected]> Co-authored-by: Michael Grund <[email protected]>
1 parent ee6f20d commit 2ecf8e4

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ To truly understand how powerful PyGMT is, play with it online on `Binder <https
5555
For a quicker introduction, check out our `3 minute overview <https://youtu.be/4iPnITXrxVU>`__!
5656

5757
Afterwards, feel free to look at our `Tutorials <https://www.pygmt.org/latest/tutorials>`__,
58-
visit the `PyGMT Gallery <https://www.pygmt.org/latest/gallery>`__, and check out
58+
visit the `Gallery <https://www.pygmt.org/latest/gallery>`__, and check out
5959
some `external PyGMT examples <https://www.pygmt.org/latest/external_resources.html>`__!
6060

6161
.. image:: https://user-images.githubusercontent.com/14077947/155809878-48b8f235-141b-460a-80ec-08bbf6c36e40.png
@@ -102,6 +102,20 @@ If you use `mamba <https://mamba.readthedocs.org/>`__::
102102

103103
For other ways to install ``pygmt``, see `full installation instructions <https://www.pygmt.org/latest/install.html>`__.
104104

105+
Getting started
106+
+++++++++++++++
107+
108+
As a starting point, you can open a `Python interpreter <https://docs.python.org/3/tutorial/interpreter.html>`__
109+
or a `Jupyter notebook <https://docs.jupyter.org/en/latest/running.html>`__, and try the following example::
110+
111+
import pygmt
112+
fig = pygmt.Figure()
113+
fig.coast(projection="H10c", region="g", frame=True, land="gray")
114+
fig.show()
115+
116+
For more examples, please have a look at the `Gallery <https://www.pygmt.org/latest/gallery/index.html>`__
117+
and `Tutorials <https://www.pygmt.org/latest/tutorials/index.html>`__.
118+
105119

106120
Contacting Us
107121
-------------

0 commit comments

Comments
 (0)