Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Docs structure #209

Open
26 of 34 tasks
mdtanker opened this issue Jun 11, 2024 · 0 comments
Open
26 of 34 tasks

New Docs structure #209

mdtanker opened this issue Jun 11, 2024 · 0 comments

Comments

@mdtanker
Copy link
Owner

mdtanker commented Jun 11, 2024

I think we should update the documentation based on the Divio system. This will switch from our current style of a gallery and tutorials to a five category system consisting of: Getting started, Tutorial, How-to, Reference, and Explanation. Inspired by this Verde issue

Simple cooking analogy to understand these sections:

  • Tutorial is a cooking lesson
  • How-to is a recipe
  • Reference is a encyclopedia article about an ingredient
  • Explanation is a book on the history and theory of cooking

Getting started

  • Installing
  • Notebook with a quick taste of PolarToolkit. choose a pre-set region (Ross Ice Shelf), download data (Bedmap2), make a map, add standard embellishments, and plot a star to point out Disco Deep, and a cross-section through the region
  • Citing PolarToolkit

Tutorial

These tutorials should grow in complexity and are meant to be followed in order by someone new to PolarToolkit. They shouldn't try to explain how things work, but just teach by doing.

Loading data (Fetch)

  • Download Polar data: Download 1 dataset each from Antarctica and Greenland with defaults. Not plotting
  • Specify grid parameters: choose region, spacing, and reference frame

Creating plots (Maps)

  • Create a simple map: Download 1 dataset and create a simple map with defaults
  • Add map elements: add colorbar, gridlines, inset, north arrow, scalebar
  • Make subplots: Download 4 datasets and make a subplot
  • Show gridded data in 3D: Download bed topography data and plot in 3D
  • Plot point data: Download some point data and use maps.basemap and PyGMT to plot it

Creating profiles (Profile)

  • Create a cross-section: default profile with 2 endpoints
  • Show data along a profile: add default data

Other

  • Interactively explore your data: interactive gridded and point data
  • Reproject your data: load a grid and some point data in lat long, reproject to EPSG.

How-to

These should be short and to the point, focused on the problem presented. They can assume that people have done the tutorials. Also don't explain things, but allow some flexibility.

  • Download NASA data
  • Switch between Antarctica, the Arctic or Greenland
  • Define a geographic region: manually (EPSG grid figures), bounding data, or interactively
  • Manipulating geographic regions: combining, expanding
  • Use with PyGMT: define projection and use normal PyGMT plotting functions
  • Choose a colorscale
  • Organize subplots
  • Grid manipulations: subset, resample, filter, change registration
  • Point data manipulations: block reduce, inside region,
  • Compare grids
  • Mask data: with shapefile and interactively
  • Customize profiles: clip ends, change basemap style, etc.
  • Extract grid info: get_grd_info, get min max, get combined min max

Reference

  • Available regions
  • Available datasets
  • API
  • References
  • Changelog

Explaination

These are meant to explain how things work and why they are that way.

  • EPSG projections
  • Specifying which hemisphere
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant