Skip to content
Merged
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
855e6b6
Reorganize section overview
yvonnefroehlich Jul 30, 2026
0965ab1
Merge branch 'main' into polish-overview
yvonnefroehlich Aug 3, 2026
d574b39
Merge branch 'main' into polish-overview
yvonnefroehlich Aug 3, 2026
90b0a93
Add 'project goals' to docs
yvonnefroehlich Aug 3, 2026
daaee72
Add 'Support' to docs and rename to 'Funding'
yvonnefroehlich Aug 3, 2026
c3c6e00
Add 'Related projects' to docs
yvonnefroehlich Aug 3, 2026
a84ecb4
Switch order of 'Funding' and 'Related projects'
yvonnefroehlich Aug 3, 2026
0ecc212
Remove 'funding', 'related projects', and 'min versions' content from…
yvonnefroehlich Aug 3, 2026
ac59bd9
Restructure 'Why PyGMT' and 'About' sections in README and docs
yvonnefroehlich Aug 3, 2026
6f896e3
Remove links at the beginning of the README and try line breaksfor ba…
yvonnefroehlich Aug 3, 2026
d56b23d
Directly add intro text on landing page, use RST to inserte PyGMT logo
yvonnefroehlich Aug 3, 2026
8c4de17
Merge branch 'main' into polish-overview
yvonnefroehlich Aug 3, 2026
2b28bd2
Add 'Related projects' and 'Funding' back to README
yvonnefroehlich Aug 4, 2026
11a2f41
Remove changes in index.md
yvonnefroehlich Aug 6, 2026
eb3d3af
Change subsection'Why PyGMT' to 'Overview'
yvonnefroehlich Aug 6, 2026
495ca7d
Add subsubsection 'License'
yvonnefroehlich Aug 6, 2026
f348d8b
Add 'Why PyGMT' as subsubsection
yvonnefroehlich Aug 6, 2026
20b17b5
Exclude changes in README
yvonnefroehlich Aug 6, 2026
76f8bfd
Merge branch 'main' into polish-overview
yvonnefroehlich Aug 7, 2026
d7bf625
Improve formulation
yvonnefroehlich Aug 7, 2026
fa9bc8a
Move 'Project goals' after 'Background'
yvonnefroehlich Aug 7, 2026
60e3c3d
Add intro sentence to 'Project goals'
yvonnefroehlich Aug 7, 2026
e440e68
Add content on currently status of the project
yvonnefroehlich Aug 7, 2026
b6b7a1e
Remove '../' from link
yvonnefroehlich Aug 8, 2026
4ef630d
Make grammar more consistent in list of project goals
yvonnefroehlich Aug 8, 2026
30729b1
Remove link to AUTHORS.md
yvonnefroehlich Aug 8, 2026
e62ea00
Polish formulations in subsection 'Why PyGMT'
yvonnefroehlich Aug 8, 2026
feec799
Add a subsection 'Community'
yvonnefroehlich Aug 8, 2026
772b35d
Mention PyGMT paper in subsection 'Background'
yvonnefroehlich Aug 8, 2026
2d050d7
Mention PyGMT paper in seperate paragraph
yvonnefroehlich Aug 8, 2026
72c43dc
Move 'Community' after 'Project goals'
yvonnefroehlich Aug 8, 2026
03445b6
Remove trailing white space
yvonnefroehlich Aug 8, 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
63 changes: 56 additions & 7 deletions doc/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
# Overview

## About
## Why PyGMT

A beautiful map is worth a thousand words. To experience the power of PyGMT, try it
online with [Binder or Google Colab](https://github.com/GenericMappingTools/try-gmt)
without installing anything on your computer.

For a quick introduction, check out our [3-minute overview](https://youtu.be/4iPnITXrxVU).
Afterward, try the [Intro to PyGMT](intro/index.rst) tutorial on your own, explore the
[Gallery](gallery/index.rst) for inspiration, follow the [Tutorials](tutorials/index.rst)
to learn more, explore available map [Projections](projections/index.rst), and finally
check out some [external PyGMT examples](external_resources).

## Background

PyGMT is a Python wrapper for the
[Generic Mapping Tools (GMT)](https://github.com/GenericMappingTools/gmt),
Expand All @@ -18,12 +30,49 @@ and JPG for use on the web and elsewhere. In fact, PyGMT users will usually not
contact with the original PostScript files and get only the more convenient formats like
PDF and PNG.

The project was started in 2017 by [Leonardo Uieda](https://www.leouieda.com) and
[Paul Wessel](https://en.wikipedia.org/wiki/Pål_Wessel) (the co-creator and main
developer of GMT) at the University of Hawaiʻi at Mānoa. The development of PyGMT
has been supported by NSF grants [OCE-1558403](https://www.nsf.gov/awardsearch/show-award/?AWD_ID=1558403)
and [EAR-1948602](https://www.nsf.gov/awardsearch/show-award/?AWD_ID=1948602).
For more information about the design and development of PyGMT, see the
[PyGMT paper](https://doi.org/10.1029/2026GC013105) published in
*Geochemistry, Geophysics, Geosystems*.

## Project goals

Comment thread
yvonnefroehlich marked this conversation as resolved.
From the beginning, the project has aimed to achieve the following goals:

- Make GMT more accessible to new users.
- Build a Pythonic API for GMT.
- Interface with the GMT C API directly using ctypes (no system calls).
- Support rich display in the Jupyter notebook.
- Integrate with the [scientific Python ecosystem](https://scientific-python.org/):
`numpy.ndarray` or `pandas.DataFrame` for data tables, `xarray.DataArray` for grids,
and `geopandas.GeoDataFrame` for geographical data.
Comment thread
yvonnefroehlich marked this conversation as resolved.

## Community

The PyGMT project was started in 2017 by [Leonardo Uieda](https://www.leouieda.com) and
[Paul Wessel](https://en.wikipedia.org/wiki/Pål_Wessel) (the co-creator and main developer
of GMT) at the University of Hawaiʻi at Mānoa. Currently, the project is community-driven
and maintained by an [international team](team.md), with contributions from
[multiple contributors](https://github.com/GenericMappingTools/pygmt/graphs/contributors).

We welcome any feedback and ideas! Let us know by submitting
We welcome any feedback, ideas, and contributions! Let us know by submitting
[issues on GitHub](https://github.com/GenericMappingTools/pygmt/issues) or by posting on
our [Discourse forum](https://forum.generic-mapping-tools.org/c/questions/pygmt-q-a).

## Related projects

Other official GMT wrappers include:

- [GMT.jl](https://github.com/GenericMappingTools/GMT.jl): A Julia wrapper for GMT.
- [gmtmex](https://github.com/GenericMappingTools/gmtmex): A Matlab/Octave wrapper for GMT.

## Funding

The development of PyGMT has been supported by NSF grants
[OCE-1558403](https://www.nsf.gov/awardsearch/show-award/?AWD_ID=1558403) and
[EAR-1948602](https://www.nsf.gov/awardsearch/show-award/?AWD_ID=1948602).

## License

PyGMT is free software: you can redistribute it and/or modify it under the terms of the
BSD 3-clause License. A copy of this license is provided in
[LICENSE.txt](https://github.com/GenericMappingTools/pygmt/blob/main/LICENSE.txt).
Loading