Skip to content

Draft notebook templates#414

Open
ateucher wants to merge 7 commits intomainfrom
notebook-templates
Open

Draft notebook templates#414
ateucher wants to merge 7 commits intomainfrom
notebook-templates

Conversation

@ateucher
Copy link
Member

@ateucher ateucher commented Mar 12, 2026

This is a first attempt to add notebook templates, based on the draft style guide and cookbook coworking.

This serves several purposes:

  1. Provide standardized metadata to every notebook that can (hopefully) be parsed and used for integration into the NASA Earthdata website
  2. Standardize presentation of title, authors, etc.
  3. Standardize tutorial sections
  4. Provide an easy entry point for new contributions

These are lightly modified from the Project Pythia template, with Quarto metadata added at the top. I've added a .qmd and .ipynb template. For the .qmd template, the metadata is in the yaml frontmatter, and for .ipynb it is in a raw cell at the beginning of the document.

I think for diff-viewing and line-by-line review in this PR, the .qmd document is the easiest, but they are essentially the same content. So I think we should iterate on the .qmd and then copy to the .ipynb when ready.

Note that the nasa-metadata key is just to hold metadata. It is a non-standard key (which Quarto allows) so we can provide that information in a structured way. Everything else is a standard key that Quarto uses in some way to control rendering or populate content.

TODO:

  • Decide on metadata fields
  • Add instructions in the contributing guide for how to use the templates
  • Add R versions
  • Decide on sections and add templates for different categories (to-dos, tutorials)
  • Borrow from ASDC's cookbook PR hooks for checking on PRs (from @danielfromearth)
  • ...

Rendered versions of the templates are in the deploy preview: ipynb and qmd

@github-actions
Copy link

github-actions bot commented Mar 12, 2026

@github-actions github-actions bot temporarily deployed to pull request March 12, 2026 21:53 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 12, 2026 21:59 Inactive
@NASA-Openscapes NASA-Openscapes deleted a comment from github-actions bot Mar 12, 2026
@ateucher ateucher requested a review from ronnyhdez March 12, 2026 22:07
@github-actions github-actions bot temporarily deployed to pull request March 12, 2026 22:20 Inactive
Copy link
Contributor

@jules32 jules32 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Andy! Thanks for incorporating all the ideas from yesterday. I added a few comments here but think it's ready to talk through on Wednesday :)

Co-authored-by: Julia Stewart Lowndes <julia@openscapes.org>
@github-actions github-actions bot temporarily deployed to pull request March 13, 2026 17:13 Inactive
email: marie@science.org
affiliation: University of Radioactivity
date: last-modified # automatically generates the date when the doc gets rendered. Can be overridden with a specific date if desired.
keywords: [sea-ice, netcdf, xarray]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keywords as GCMD? If there is an API (yes there is) then yes. And then include the Topics (would show up in Learn, Pathfinders by Topic)

Here is GCMD API: https://cmr.earthdata.nasa.gov/kms/ and guide is here: https://wiki.earthdata.nasa.gov/pages/viewpage.action?spaceKey=ED&title=KMS+User%27s+Guide

language field (python, r)

@jules32
Copy link
Contributor

jules32 commented Mar 18, 2026

Should an environment (ie corn, py-rocket?) be part of the metadata?

Thinking if folks will download single notebooks with a button, would they need a link to an environment?

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

Successfully merging this pull request may close these issues.

2 participants