You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
I think we should update the documentation based on the Divio system. This will switch from our current style of a
gallery
andtutorials
to a five category system consisting of:Getting started
,Tutorial
,How-to
,Reference
, andExplanation
. Inspired by this Verde issueSimple cooking analogy to understand these sections:
Tutorial
is a cooking lessonHow-to
is a recipeReference
is a encyclopedia article about an ingredientExplanation
is a book on the history and theory of cookingGetting started
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)
Creating plots (Maps)
Creating profiles (Profile)
Other
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.
Reference
Explaination
These are meant to explain how things work and why they are that way.
The text was updated successfully, but these errors were encountered: