Skip to content
Merged
Changes from 3 commits
Commits
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
37 changes: 24 additions & 13 deletions doc/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ We recommend following the instructions further on to install GMT 6.

## Dependencies

PyGMT requires the following libraries to be installed:
PyGMT requires the following packages to be installed:

- [numpy](https://numpy.org)
- [pandas](https://pandas.pydata.org)
Expand All @@ -97,19 +97,10 @@ PyGMT requires the following libraries to be installed:
For the minimum supported versions of the dependencies, please see [](minversions.md).
:::

The following are optional dependencies:

- [IPython](https://ipython.org): For embedding the figures in Jupyter notebooks (recommended).
- [Contextily](https://contextily.readthedocs.io): For retrieving tile maps from the internet.
- [GeoPandas](https://geopandas.org): For using and plotting GeoDataFrame objects.
- [RioXarray](https://corteva.github.io/rioxarray): For saving multi-band rasters to GeoTIFFs.

:::{note}
If you have [PyArrow](https://arrow.apache.org/docs/python/index.html) installed, PyGMT
does have some initial support for `pandas.Series` and `pandas.DataFrame` objects with
Apache Arrow-backed arrays. Specifically, only uint/int/float and date32/date64 dtypes
are supported for now. Support for string Arrow dtypes is still a work in progress.
For more details, see [issue #2800](https://github.com/GenericMappingTools/pygmt/issues/2800).
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).
:::

## Installing GMT and other dependencies
Expand Down Expand Up @@ -165,6 +156,26 @@ conda activate pygmt
From now on, all commands will take place inside the virtual environment called `pygmt`
and won't affect your default `base` installation.

::::: {tip}
You can also install PyGMT's optional dependencies for more functionality (after
activating the environment).
:::: {tab-set}
::: {tab-item} mamba
:sync: mamba
```
mamba install contextily geopandas ipython pyarrow rioxarray
```
:::

::: {tab-item} conda
:sync: conda
```
conda install contextily geopandas ipython pyarrow rioxarray
```
:::
::::
:::::

## Installing PyGMT

Now that you have GMT installed and your virtual environment activated, you can install
Expand Down