NASA-IMPACT / NASA-IMPACT/veda-docs

Use binderbot to ensure notebook reproducibility

Open
#198 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
10
Forks
16
Avg merge
2d 31m
Merged PRs (30d)
4

Description

My understanding is that the notebooks contained in the VEDA docs are rendered from committed cell outputs. We could consider instead rendering the Quarto book by executing each notebook during the build process on the VEDA hub to ensure continued reproducibility as software versions change (xref https://github.com/NASA-IMPACT/pangeo-notebook-veda-image/pull/31#issuecomment-2605315151). More specifically, we could follow the approach that Project Pythia developed for their cookbooks which uses binderbot and some re-usable but custom GitHub actions. Here's a summary of their approach from Brian Rose's Pangeo showcase presentation last fall:

Image

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the committed notebooks in the VEDA docs and the linked Project Pythia cookbook-actions build-book.yaml. Compare that workflow with the current VEDA docs build process and determine how binderbot would run notebooks on the VEDA hub. Done means the book build executes the notebooks and verifies reproducible outputs as dependencies change.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, jupyter-notebook
Domain
build-system, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.