Skip to content

Commit 88d5b0e

Browse files
michaelgrundseismancore-manMeghan Jones
authored
Improve the docstring of the pygmt package (#1016)
Co-authored-by: Dongdong Tian <seisman.info@gmail.com> Co-authored-by: Yao Jiayuan <coreman.seism@gmail.com> Co-authored-by: Meghan Jones <meghanj@hawaii.edu>
1 parent 98d83f6 commit 88d5b0e

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

pygmt/__init__.py

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,22 @@
1-
# pylint: disable=missing-docstring
2-
#
3-
# The main API for PyGMT.
4-
#
5-
# All of PyGMT is operated on a "modern mode session" (new to GMT6). When you
6-
# import the pygmt library, a new session will be started automatically. The
7-
# session will be closed when the current Python process terminates. Thus, the
8-
# Python API does not expose the `gmt begin` and `gmt end` commands.
1+
"""
2+
PyGMT is a library for processing geospatial and geophysical data and making
3+
publication quality maps and figures. It provides a Pythonic interface for the
4+
Generic Mapping Tools (GMT), a command-line program widely used in the Earth
5+
Sciences. Besides making GMT more accessible to new users, PyGMT aims to
6+
provide integration with the PyData ecosystem as well as support for rich
7+
display in Jupyter notebooks.
8+
9+
Main Features
10+
-------------
11+
Here are just a few of the things that PyGMT does well:
12+
13+
- Easy handling of individual types of data like Cartesian, geographic, or
14+
time-series data.
15+
- Processing of (geo)spatial data including gridding, filtering, and masking
16+
- Allows plotting of a large spectrum of objects on figures including
17+
lines, vectors, polygons, and symbols (pre-defined and customized)
18+
- Generate publication-quality illustrations and make animations
19+
"""
920

1021
import atexit as _atexit
1122

0 commit comments

Comments
 (0)