Earthdata Cloud Cookbook Python Notebook Template (Jupyter)

Authors
Affiliations

Albert Einstein

University of Relativity

Marie Curie

University of Radioactivity

Published

Invalid Date

There is no need to make a cell with title, authors, date, etc. This will be generated automatically from the yaml metadata in the raw cell at the top of the document

Overview

If you have an introductory paragraph, lead with it here! Keep it short and tied to your material. This is also a great place to add a relevant image.

If it works for your material, a great way to frame things is to use the POP (Purpose, Outcomes, Process) framework:

  • Purpose: What is the motivation for this tutorial? What problem does it solve?
  • Outcomes: quick notes on what you’ll learn and where the tutorial ends
  • Process: maybe a time estimate, and/or where it was first taught?

Learning objectives

List the main learning objectives here.

Prerequisites

Following your overview, tell your reader what concepts, packages, or other background information they’ll need before learning your material. Tie this explicitly with links to other pages here in Foundations or to relevant external resources. Remove this body text, then populate the Markdown table, denoted in this cell with | vertical brackets, below, and fill out the information following. In this table, lay out prerequisite concepts by explicitly linking to other Foundations material or external resources, or describe generally helpful concepts.

Label the importance of each concept explicitly as helpful/necessary.

Concepts Importance Notes
Intro to earthaccess Necessary Required for accessing NASA Earthdata Cloud resources
Understanding of NetCDF Helpful Familiarity with metadata structure
Project management Helpful
  • Time to learn: estimate in minutes. For a rough idea, use 5 mins per subsection, 10 if longer; add these up for a total. Safer to round up and overestimate.
  • System requirements:
    • Populate with any system, version, or non-Python software requirements if necessary
    • Otherwise use the concepts table above and the Imports section below to describe required packages as necessary
    • If no extra requirements, remove the System requirements point altogether

Imports

Begin your body of content with another --- divider before continuing into this section, then remove this body text and populate the following code cell with all necessary Python imports up-front:

import sys
# import earthaccess

Your first content section

This is where you begin your first section of material, loosely tied to your objectives stated up front. Tie together your notebook as a narrative, with interspersed Markdown text, images, and more as necessary,

# as well as any and all of your code cells
print("Hello world!")
Hello world!

A content subsection

Divide and conquer your objectives with Markdown subsections, which will populate the helpful navbar in Jupyter Lab and here on the Jupyter Book!

# some subsection code
a = [1, 2, 3, 4, 5]
[i + 2 for i in a]
[3, 4, 5, 6, 7]

Another content subsection

Keep up the good work! A note, try to avoid using code comments as narrative, and instead let them only exist as brief clarifications where necessary.

Your second content section

Here we can move on to our second objective, and we can demonstrate…

A subsection to the second section

a quick demonstration

of further and further
header levels

Check out any number of helpful Markdown resources for further customizing your notebooks and the MyST Syntax Overview for MyST-specific formatting information. Don’t hesitate to ask questions if you have problems getting it to look just right.

Last Section

You can add callouts using quarto callout syntax to highlight important information, provide helpful hints, or even just to add some fun and personality to your notebook. Here’s an example of a note callout:

Note

Your relevant information here!

Tip

A helpful hint.

Warning

Be careful!

We also suggest checking out Quarto’s documentation on specifying output options in Jupyter Notebooks.

Summary

Add one final --- marking the end of your body of content, and then conclude with a brief single paragraph summarizing at a high level the key pieces that were learned and how they tied to your objectives. Look to reiterate what the most important takeaways were.

Additional resources

Link to relevant external material, further reading, documentation, etc.

References

Be rigorous in your citations and references as necessary. Give credit where credit is due.

You’re done! Give yourself a quick review, a high five, and send us a pull request. A few final notes:

  • Kernel > Restart Kernel and Run All Cells... to confirm that your notebook will cleanly run from start to finish
  • Kernel > Restart Kernel and Clear All Outputs... before committing your notebook, our machines will do the heavy lifting
  • Take credit! Provide author information in the metadata.
  • Give credit! Attribute appropriate authorship for referenced code, information, images, etc.
  • Only include what you’re legally allowed: no copyright infringement or plagiarism

Thank you for your contribution!

Acknowledgements

This template builds from the Project Pythia Notebook Template, which was in turn inspired by this template of the wonderful The Turing Way Jupyter Book.