From 88d5b0ef8e3519fef05574cff2d5a97d16fe8783 Mon Sep 17 00:00:00 2001 From: Michael Grund Date: Wed, 10 Mar 2021 05:28:28 +0100 Subject: [PATCH] Improve the docstring of the pygmt package (#1016) Co-authored-by: Dongdong Tian Co-authored-by: Yao Jiayuan Co-authored-by: Meghan Jones --- pygmt/__init__.py | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/pygmt/__init__.py b/pygmt/__init__.py index 8c29a5c0b10..3e3331ef6af 100644 --- a/pygmt/__init__.py +++ b/pygmt/__init__.py @@ -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