Skip to content

Commit

Permalink
Improve the docstring of the pygmt package (#1016)
Browse files Browse the repository at this point in the history
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Yao Jiayuan <[email protected]>
Co-authored-by: Meghan Jones <[email protected]>
  • Loading branch information
4 people authored Mar 10, 2021
1 parent 98d83f6 commit 88d5b0e
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions pygmt/__init__.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
# pylint: disable=missing-docstring
#
# The main API for PyGMT.
#
# All of PyGMT is operated on a "modern mode session" (new to GMT6). When you
# import the pygmt library, a new session will be started automatically. The
# session will be closed when the current Python process terminates. Thus, the
# Python API does not expose the `gmt begin` and `gmt end` commands.
"""
PyGMT is a library for processing geospatial and geophysical data and making
publication quality maps and figures. It provides a Pythonic interface for the
Generic Mapping Tools (GMT), a command-line program widely used in the Earth
Sciences. Besides making GMT more accessible to new users, PyGMT aims to
provide integration with the PyData ecosystem as well as support for rich
display in Jupyter notebooks.
Main Features
-------------
Here are just a few of the things that PyGMT does well:
- Easy handling of individual types of data like Cartesian, geographic, or
time-series data.
- Processing of (geo)spatial data including gridding, filtering, and masking
- Allows plotting of a large spectrum of objects on figures including
lines, vectors, polygons, and symbols (pre-defined and customized)
- Generate publication-quality illustrations and make animations
"""

import atexit as _atexit

Expand Down

0 comments on commit 88d5b0e

Please sign in to comment.