Skip to content

DOC: Simplify the Quickstart section in README.md #4773

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

Open
seisman wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOC: Simplify the Quickstart section in README.md #4773

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
24 changes: 7 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,24 +49,17 @@ program widely used across the Earth, Ocean, and Planetary sciences and beyond.

## Quickstart

### Installation

Simple installation using
[conda](https://docs.conda.io/projects/conda/en/latest/user-guide/index.html):
Install PyGMT using [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/index.html):

```bash
conda install --channel conda-forge pygmt
```

For other ways to install `pygmt`, see the [full installation instructions](https://www.pygmt.org/latest/install.html).

@seisman seisman Jul 28, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to the end so that users are not directed away from the PyGMT documentation too early.


### Getting started
Then try the following example in a Python interpreter or Jupyter notebook. You should

@seisman seisman Jul 28, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the links to the Python interpreter and Jupyter Notebook, assuming that users already know how to run Python code. Users who do not know how to run Python code are also unlikely to be familiar with conda, so I think this is a reasonable assumption.

see a global map with land and water masses colored in tan and lightblue, respectively,
with the semi-transparent text "PyGMT" on top.

As a starting point, you can open a [Python interpreter](https://docs.python.org/3/tutorial/interpreter.html)
or a [Jupyter notebook](https://docs.jupyter.org/en/latest/running.html), and try the
following example:

``` python
```python
import pygmt

fig = pygmt.Figure()
Expand All @@ -75,11 +68,8 @@ fig.coast(land="tan", water="lightblue")
fig.text(position="MC", text="PyGMT", font="40p,AvantGarde-Book,red@75")
fig.show()
```

You should see a global map with land and water masses colored in tan and lightblue,
respectively. On top, there should be the semi-transparent text "PyGMT". For more examples,
please have a look at the [Gallery](https://www.pygmt.org/latest/gallery/index.html) and
[Tutorials](https://www.pygmt.org/latest/tutorials/index.html).
For other ways to install PyGMT and more examples, please visit the
[PyGMT documentation](https://www.pygmt.org/).

## Contacting us

Expand Down