Skip to content

DOC: List all dependencies in the instalation guides #4807

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 2 commits into
base: main
Choose a base branch
from
+24 −25
Open

DOC: List all dependencies in the instalation guides #4807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33530fa
DOC: List all dependencies in the instalation guides
seisman Aug 9, 2026
ee85c53
typo: Fix rioarray to rioxarray
seisman Aug 10, 2026
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ PyGMT depends on GMT and the following Python libraries:
[IPython](https://ipython.org/),
[GeoPandas](https://geopandas.org/),
[contextily](https://contextily.readthedocs.io/),
[rioarray](https://corteva.github.io/rioxarray/),
[rioxarray](https://corteva.github.io/rioxarray/),
[PyArrow](https://arrow.apache.org/docs/python/)

For detailed version requirements, see [Minimum Supported Versions](https://www.pygmt.org/latest/minversions.html).
Expand Down
47 changes: 23 additions & 24 deletions doc/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@ import pygmt
pygmt.show_versions()
```

You are now ready to make your first figure! Start by looking at our [Intro](intro/index.rst),
[Tutorials](tutorials/index.rst), and [Gallery](gallery/index.rst). Good luck!
You are now ready to make your first figure! Start by looking at our
[Intro](intro/index.rst), [Tutorials](tutorials/index.rst), and
[Gallery](gallery/index.rst). Good luck!

:::{note}
The sections below provide more detailed, step by step instructions to install and test
Expand All @@ -46,10 +47,10 @@ development version.

PyGMT is tested to run on Python {{ requires.python }}.

We recommend using the [Miniforge](https://github.com/conda-forge/miniforge#miniforge3)
Python distribution to ensure you have all dependencies installed. Installing Miniforge
does not require administrative rights to your computer and doesn't interfere with any
other Python installations on your system.
We recommend using the [Miniforge](https://github.com/conda-forge/miniforge) Python
distribution to ensure you have all dependencies installed. Installing Miniforge does
not require administrative rights to your computer and doesn't interfere with any other
Python installations on your system.

## Which GMT?

Expand All @@ -61,26 +62,25 @@ Compiled conda packages of GMT for Linux, macOS and Windows are provided through
[build GMT from source](https://github.com/GenericMappingTools/gmt/blob/master/BUILDING.md)
instead.

We recommend following the instructions further on to install GMT 6.
We recommend following the instructions further on to install GMT.

## Dependencies

@yvonnefroehlich yvonnefroehlich Aug 9, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe move the "Dpendencies" section to the top, similar as in the README? To let users know which packages will be installed together with PyGMT.

@seisman seisman Aug 10, 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.

I prefer to keep the "Quickstart" section as the first section, so that users can install PyGMT without knowing any details.

README is mainly for describing the project, so I think in that file, it makes more sense to have "Dependencies" before "QuickStart".


PyGMT requires the following packages to be installed:
PyGMT depends on GMT and the following Python libraries:

- [NumPy](https://numpy.org)
- [pandas](https://pandas.pydata.org)
- [xarray](https://xarray.dev/)
- [packaging](https://packaging.pypa.io)
- **Required**:
[NumPy](https://numpy.org/),
[pandas](https://pandas.pydata.org/),
[xarray](https://xarray.pydata.org/),
[packaging](https://packaging.pypa.io/en/stable/)
- **Optional**:
[IPython](https://ipython.org/),
[GeoPandas](https://geopandas.org/),
[contextily](https://contextily.readthedocs.io/),
[rioxarray](https://corteva.github.io/rioxarray/),
[PyArrow](https://arrow.apache.org/docs/python/)

:::{note}
For the minimum supported versions of the dependencies, please see [](minversions.md).
:::

:::{note}
Some optional dependencies (e.g., [IPython](https://ipython.readthedocs.io/en/stable/),
[GeoPandas](https://geopandas.org/en/stable/)) add more functionality to PyGMT.
For a complete list of the optional dependencies, refer to [](ecosystem.md).
:::
For detailed version requirements, see [](minversions.md).

## Installing GMT and other dependencies

Expand Down Expand Up @@ -164,8 +164,8 @@ from Python.

## Testing your install

To ensure that PyGMT and its dependencies are installed correctly, run the following
in your Python interpreter:
To ensure that PyGMT and its dependencies are installed correctly, run the following in
your Python interpreter:

```{code-cell} ipython
---
Expand Down Expand Up @@ -231,7 +231,6 @@ jupyter kernelspec list --json
After that, you need to restart Jupyter, open your notebook, select the `pygmt` kernel
and then import pygmt.


### Not working transparency

It is known that some combinations of GMT and Ghostscript versions cause issues,
Expand Down
Loading