-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add module descriptions to overview
- Loading branch information
Showing
1 changed file
with
20 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,34 @@ | ||
# 🔎 Overview | ||
|
||
Antarctic-Plots | ||
Antarctic-Plots is a Python package developed to help with conducting Antarctic | ||
science. The 5 modules shown here provide tools to help with a variety of common | ||
tasks. | ||
|
||
## Modules | ||
|
||
**Antarctic-Plots** consists of 5 modules: | ||
### Regions | ||
|
||
Pre-defined or interactively chosen geographic regions. Includes many ice | ||
shelves, glaciers, and general geographic regions. These can be used in | ||
functions throughout, such as subsetting data or specifying areas to plot. | ||
|
||
### Fetch | ||
|
||
Easily download data sets to your computer, retrieve previously download data | ||
sets, and perform common gridded data manipulations. This module uses `Pooch` to | ||
managed the download, storage, and retrieve of data, and `PyGMT` for grid | ||
manipulations. | ||
|
||
## Maps | ||
|
||
Create high-quality maps using PyGMT with functions specifically tailored to | ||
Antarctica. plot types: 2D, 3D, subplots, interactive maps | ||
|
||
### Profile | ||
|
||
### Regions | ||
Define a line, sample layers & data along it, and plot the results. | ||
|
||
### Utils | ||
|
||
Useful functions for common tasks: coordinate conversion, grid comparison, | ||
masking, de-trending. |