Skip to content

Commit

Permalink
docs: add module descriptions to overview
Browse files Browse the repository at this point in the history
  • Loading branch information
mdtanker committed Dec 10, 2023
1 parent 8102792 commit 92edec5
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions docs/overview.md
@@ -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.

0 comments on commit 92edec5

Please sign in to comment.