Skip to content

Commit 6058cf6

Browse files
authored
doc: Convert overview source code from ReST to Markdown (#2953)
1 parent 5bfcbeb commit 6058cf6

File tree

4 files changed

+86
-117
lines changed

4 files changed

+86
-117
lines changed

doc/conf.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,10 @@
3434

3535
# Auto-generate header anchors with MyST parser
3636
myst_heading_anchors = 4
37-
# Allow code fences using colons
38-
myst_enable_extensions = ["colon_fence"]
37+
myst_enable_extensions = [
38+
"attrs_inline", # Allow inline attributes after images
39+
"colon_fence", # Allow code fences using colons
40+
]
3941

4042
# Make the list of returns arguments and attributes render the same as the
4143
# parameters list

doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
:hidden:
1919
:caption: Getting Started
2020

21-
overview.rst
21+
overview.md
2222
install.rst
2323
get_started/index.rst
2424

doc/overview.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Overview
2+
3+
## About
4+
5+
PyGMT is a Python wrapper for the
6+
[Generic Mapping Tools (GMT)](https://github.com/GenericMappingTools/gmt),
7+
a command-line program widely used across the Earth, Ocean, and Planetary sciences and
8+
beyond. It provides capabilities for processing spatial data (gridding, filtering,
9+
masking, FFTs, etc) and making high quality plots and maps.
10+
11+
PyGMT is different from Python libraries like [Bokeh](https://bokeh.pydata.org/en/latest/)
12+
and [Matplotlib](https://matplotlib.org/), which have a larger focus on interactivity
13+
and allowing different backends. GMT uses the
14+
[PostScript](https://en.wikipedia.org/wiki/PostScript) format to generate high quality
15+
(static) vector graphics for publications, posters, talks, etc. It is memory efficient
16+
and very fast. The PostScript figures can be converted to other formats like PDF, PNG,
17+
and JPG for use on the web and elsewhere. In fact, PyGMT users will usually not have any
18+
contact with the original PostScript files and get only the more convenient formats like
19+
PDF and PNG.
20+
21+
The project was started in 2017 by [Leonardo Uieda](http://www.leouieda.com) and
22+
[Paul Wessel](http://www.soest.hawaii.edu/wessel) (the co-creator and main developer of
23+
GMT) at the University of Hawaiʻi at Mānoa. The development of PyGMT has been supported
24+
by NSF grants [OCE-1558403](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1558403)
25+
and [EAR-1948603](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1948602).
26+
27+
We welcome any feedback and ideas! Let us know by submitting
28+
[issues on GitHub](https://github.com/GenericMappingTools/pygmt/issues) or by posting on
29+
our [Discourse forum](https://forum.generic-mapping-tools.org/c/questions/pygmt-q-a).
30+
31+
## Presentations
32+
33+
These are conference presentations about the development of PyGMT (previously "GMT/Python"):
34+
35+
- "Geospatial Analysis & Visualization with PyGMT".
36+
2022.
37+
Max Jones, Wei Ji Leong, and Leonardo Uieda.
38+
Presented at *SciPy 2022*.
39+
doi:[10.6084/m9.figshare.20483793](https://doi.org/10.6084/m9.figshare.20483793)
40+
41+
![](_static/scipy2022-youtube-thumbnail.jpg){.align-center width="80%"}
42+
43+
- "PyGMT: Accessing the Generic Mapping Tools from Python".
44+
2019.
45+
Leonardo Uieda and Paul Wessel.
46+
Presented at *AGU 2019*.
47+
doi:[10.6084/m9.figshare.11320280](https://doi.org/10.6084/m9.figshare.11320280)
48+
49+
![](_static/agu2019-poster.jpg){.align-center width="80%"}
50+
51+
- "Building an object-oriented Python interface for the Generic Mapping Tools".
52+
2018.
53+
Leonardo Uieda and Paul Wessel.
54+
Presented at *SciPy 2018*.
55+
doi:[10.6084/m9.figshare.6814052](https://doi.org/10.6084/m9.figshare.6814052)
56+
57+
![](_static/scipy2018-youtube-thumbnail.png){.align-center width="80%"}
58+
59+
- "Integrating the Generic Mapping Tools with the Scientific Python Ecosystem".
60+
2018.
61+
Leonardo Uieda and Paul Wessel.
62+
Presented at *AOGS Annual Meeting 2018*.
63+
doi:[10.6084/m9.figshare.6399944](https://doi.org/10.6084/m9.figshare.6399944)
64+
65+
![](_static/aogs2018-poster.jpg){.align-center width="80%"}
66+
67+
- "Bringing the Generic Mapping Tools to Python".
68+
2017.
69+
Leonardo Uieda and Paul Wessel.
70+
Presented at *SciPy 2017*.
71+
doi:[10.6084/m9.figshare.7635833](https://doi.org/10.6084/m9.figshare.7635833)
72+
73+
![](_static/scipy2017-youtube-thumbnail.png){.align-center width="80%"}
74+
75+
- "A modern Python interface for the Generic Mapping Tools".
76+
2017.
77+
Leonardo Uieda and Paul Wessel.
78+
Presented at *AGU 2017*.
79+
doi:[10.6084/m9.figshare.5662411](https://doi.org/10.6084/m9.figshare.5662411)
80+
81+
![](_static/agu2017-poster.jpg){.align-center width="80%"}

doc/overview.rst

Lines changed: 0 additions & 114 deletions
This file was deleted.

0 commit comments

Comments
 (0)