import sysEarthdata Cloud Cookbook Notebook Template
sea-ice, netcdf, xarray
Overview
If you have an introductory paragraph, lead with it here! Keep it short and tied to your material, then be sure to continue into the required list of topics below,
- This is a numbered list of the specific topics
- These should map approximately to your main sections of content
- Or each second-level,
##, header in your notebook - Keep the size and scope of your notebook in check
- And be sure to let the reader know up front the important concepts they’ll be leaving with
Learning objectives
List the main learning objectives here.
Prerequisites
This section was inspired by this template of the wonderful The Turing Way Jupyter Book.
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 Cartopy | Necessary | |
| 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:
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 in the Cookbook!
# 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 the Quarto Guide for syntax and guidance on customizing your notebooks. 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:
Your relevant information here!
A helpful hint.
Be careful!
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 finishKernel > 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!