Tutorial Title¶

This template is designed for you to make a copy and replace the text and sample code in each section with your own, while following the general format outlined here. You will likely have a different number of cells in each section, so feel free to add and remove. The template is meant as a guide for which content is important to include.

Reminders:

Please read our Contribution Guide and our Pedagogy Guide before creating your tutorial. The pedagogy guide outlines best practices for creating and delivering code-based tutorials in a notebook format.

We recommend that before starting to develop the tutorial, it is a good idea to review the libraries that are in already in the tutorials environment and to use these within your new tutorial if possible. If the tutorial includes the use of a new package or library, consult with the NSIDC Data Use and Education team via Github Issue on whether an existing library can be used instead. If not, work with NSIDC to modify the environment yml file.

1. Tutorial Introduction/Overview¶

Provide an overview of the tutorial here, including any relevant background material and the motivation for creating the tutorial. Indicate whether the tutorial was designed to be self-led or presented at a hackweek or conference workshop.

Credits¶

List the contributors to the tutorial.

Include the following statement:

For questions regarding the notebook, or to report problems, please create a new issue in the NSIDC-Data-Tutorials repo.

Objectives/Learning Goals/Outcomes¶

List the objectives and/or skills gained upon completion of the tutorial.

After completing this notebook you will be able to...

Prerequisites/Knowledge Requirements¶

Please describe necessary set-up steps required before running the notebook.

Include guidance for using the tutorials environment and point to the main repo README for setup instructions.

Indicate whether an Earthdata Login is required for data access, and include the link for registration. Current recommended practice for authentication is to create a .netrc file in your home directory following these instructions (Step 1) and to use the .netrc file for authentication when required for data access during the tutorial.

Include a list of knowledge requirements or skills that would be necessary or useful for successful completion or comprehension of the tutorial. Some examples of useful information for tutorial users include the following:

To get the most out of this tutorial notebook, you should be familiar with the following concepts/data sets/programming languages...

The main packages/libraries that will be used in this notebook are...

The GIS concepts applied in this tutorial are...

Example of end product (recommended, not required)¶

Include a figure that illustrates the end product of the notebook. This could be a data plot, map or some other type of visualization.

Please include figures in an "img" folder located at the same level as the notebook within your tutorial folder.

Time requirement¶

Provide an estimate of the amount of time required to complete the tutorial.

2. Tutorial steps¶

Import libraries and classes¶

Import the libraries/packages and tools that will be needed to run the code in the tutorial. It can be really helpful to include comments next to each import indicating usage.

Authentication/Earthdata Login (optional - for NASA Earthdata only)¶

Different libraries will have different methods for authenticating via Earthdata Login. The following cell contains an example of the authentication process used by the earthaccess python client for NASA CMR (if you are using a different library, yours will be different). The process requires having created a .netrc file in your home directory following these instructions (Step 1). The earthaccess library's "login" method is called while passing the argument "strategy=netrc". If no .netrc file is found, the method will provide interactive cells for entering Earthdata Login credentials within the notebook.

Main body of the tutorial¶

Create the body of the tutorial here using a series of code cells. Intersperse the code cells with markdown cells containing descriptions of the steps and any relevant commentary. The number of sub-steps here will vary depending on tutorial content - common steps/actions include data discovery, data access, and file opening/examination.

Some important best practices to consider when designing and creating the tutorial steps include:

Avoid cognitive overload by restricting your notebook to a single, short task.

Limit the amount of code in each cell. Many small code snippets in individual cells are better than a single long block of code.

Write code to be understandable (rather than efficient, for example).

Confine comments to markdown cells as much as possible.

For more details please see Pedagogy Best Practices.

3. Learning outcomes recap (optional)¶

Provide a brief summary of the learning outcomes of the tutorial

4. Additional resources (optional)¶

List some additional resources for users to consult, if applicable/desired.

When your tutorial is ready for review, please read our Contributor Guide for next steps.¶