Skip to content

Commit

Permalink
doc: Convert overview source code from ReST to Markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
seisman committed Jan 6, 2024
1 parent 98e0074 commit 3c1a08d
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 117 deletions.
6 changes: 4 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,10 @@

# Auto-generate header anchors with MyST parser
myst_heading_anchors = 4
# Allow code fences using colons
myst_enable_extensions = ["colon_fence"]
myst_enable_extensions = [
"attrs_inline", # Allow inline attributes after images
"colon_fence", # Allow code fences using colons
]

# Make the list of returns arguments and attributes render the same as the
# parameters list
Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
:hidden:
:caption: Getting Started

overview.rst
overview.md
install.rst
get_started/index.rst

Expand Down
81 changes: 81 additions & 0 deletions doc/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# Overview

## About

PyGMT is a Python wrapper for the
[Generic Mapping Tools (GMT)](https://github.com/GenericMappingTools/gmt),
a command-line program widely used across the Earth, Ocean, and Planetary sciences and
beyond. It provides capabilities for processing spatial data (gridding, filtering,
masking, FFTs, etc) and making high quality plots and maps.

PyGMT is different from Python libraries like [Bokeh](https://bokeh.pydata.org/en/latest/)
and [Matplotlib](https://matplotlib.org/), which have a larger focus on interactivity
and allowing different backends. GMT uses the
[PostScript](https://en.wikipedia.org/wiki/PostScript) format to generate high quality
(static) vector graphics for publications, posters, talks, etc. It is memory efficient
and very fast. The PostScript figures can be converted to other formats like PDF, PNG,
and JPG for use on the web and elsewhere. In fact, PyGMT users will usually not have any
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](http://www.leouieda.com) and
[Paul Wessel](http://www.soest.hawaii.edu/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/showAward?AWD_ID=1558403)
and [EAR-1948603](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1948602).

We welcome any feedback and ideas! 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).

## Presentations

These are conference presentations about the development of PyGMT (previously "GMT/Python"):

- "Geospatial Analysis & Visualization with PyGMT".
2022.
Max Jones, Wei Ji Leong, and Leonardo Uieda.
Presented at *SciPy 2022*.
doi:[10.6084/m9.figshare.20483793](https://doi.org/10.6084/m9.figshare.20483793)

![](_static/scipy2022-youtube-thumbnail.jpg){.align-center width="80%"}

- "PyGMT: Accessing the Generic Mapping Tools from Python".
2019.
Leonardo Uieda and Paul Wessel.
Presented at *AGU 2019*.
doi:[10.6084/m9.figshare.11320280](https://doi.org/10.6084/m9.figshare.11320280)

![](_static/agu2019-poster.jpg){.align-center width="80%"}

- "Building an object-oriented Python interface for the Generic Mapping Tools".
2018.
Leonardo Uieda and Paul Wessel.
Presented at *SciPy 2018*.
doi:[10.6084/m9.figshare.6814052](https://doi.org/10.6084/m9.figshare.6814052)

![](_static/scipy2018-youtube-thumbnail.png){.align-center width="80%"}

- "Integrating the Generic Mapping Tools with the Scientific Python Ecosystem".
2018.
Leonardo Uieda and Paul Wessel.
Presented at *AOGS Annual Meeting 2018*.
doi:[10.6084/m9.figshare.6399944](https://doi.org/10.6084/m9.figshare.6399944)

![](_static/aogs2018-poster.jpg){.align-center width="80%"}

- "Bringing the Generic Mapping Tools to Python".
2017.
Leonardo Uieda and Paul Wessel.
Presented at *SciPy 2017*.
doi:[10.6084/m9.figshare.7635833](https://doi.org/10.6084/m9.figshare.7635833)

![](_static/scipy2017-youtube-thumbnail.png){.align-center width="80%"}

- "A modern Python interface for the Generic Mapping Tools".
2017.
Leonardo Uieda and Paul Wessel.
Presented at *AGU 2017*.
doi:[10.6084/m9.figshare.5662411](https://doi.org/10.6084/m9.figshare.5662411)

![](_static/agu2017-poster.jpg){.align-center width="80%"}
114 changes: 0 additions & 114 deletions doc/overview.rst

This file was deleted.

0 comments on commit 3c1a08d

Please sign in to comment.