Skip to content

Comments

Add execution of notebooks to CI#18

Open
observingClouds wants to merge 26 commits intomainfrom
fix/notebooks
Open

Add execution of notebooks to CI#18
observingClouds wants to merge 26 commits intomainfrom
fix/notebooks

Conversation

@observingClouds
Copy link
Collaborator

@observingClouds observingClouds commented Oct 12, 2025

Adds execution of notebooks to documentation build, ensuring that the notebooks are being executable.

Addresses part of #14

@observingClouds observingClouds marked this pull request as ready for review February 8, 2026 13:51
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds CI enforcement around Jupyter Book builds (intended to execute notebooks) and introduces documentation-side utilities/scripts to support notebook examples and parameter documentation.

Changes:

  • Update Jupyter Book configuration and GitHub Actions workflow to (intended) execute notebooks during CI documentation builds.
  • Add a lat/lon nearest-point selection utility (KDTree + caching) for use in notebooks.
  • Update project dependencies and adjust/trim documentation pages and links.

Reviewed changes

Copilot reviewed 16 out of 25 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
tests/check_data_availability.py Minor formatting/quoting cleanup for catalog availability script.
pyproject.toml Adds plotting/science/GRIB dependencies needed for notebook execution.
danra-book/scripts/utils.py Adds KDTree-based nearest lat/lon selection + local pickle caching helpers.
danra-book/scripts/parameter_list.py Reformats script and writes parameter markdown from Zarr datasets.
danra-book/requirements.txt Minor formatting/line alignment change.
danra-book/references.bib Minor formatting/line alignment change.
danra-book/docs/summary.md Removes the summary page from docs.
danra-book/docs/references.md Removes references stub page from docs.
danra-book/docs/parameters.md Removes previously checked-in parameters page (now generated elsewhere).
danra-book/docs/modelspecs.md Fixes code fence formatting around CRS WKT block.
danra-book/docs/introduction.md Removes old introduction page content.
danra-book/docs/documentation.md Simplifies navigation and links “Known issues” to GitHub issues.
danra-book/docs/description.md No functional change (formatting/line normalization).
danra-book/docs/data-formats.md Removes stub page.
danra-book/docs/data-details.md Whitespace/format cleanup.
danra-book/docs/data-availability.md Replaces s3:// links with AWS registry URLs and minor formatting cleanup.
danra-book/docs/annex.md Removes annex stub page.
danra-book/about.md Minor formatting/line normalization.
danra-book/_toc.yml Removes commented-out chapters from TOC.
danra-book/_config.yml Enables notebook execution settings and sets long execution timeout.
.zenodo.json Minor formatting/line alignment change.
.github/workflows/sphinx.yml Adds caching + CDS key provisioning and tightens Jupyter Book build flags.
.github/workflows/changelog-check.yml Minor formatting/line alignment change.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

raise ValueError("dataset must have a suite_name attribute")

if not isinstance(pt, dict):
raise TypeError("pt_latlon must be a dict with keys 'lat' and 'lon'")
Copy link

Copilot AI Feb 8, 2026

Choose a reason for hiding this comment

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

The TypeError message refers to "pt_latlon", but the argument name is "pt". This makes debugging harder; update the message to match the parameter name (and ideally mention the expected keys).

Suggested change
raise TypeError("pt_latlon must be a dict with keys 'lat' and 'lon'")
raise TypeError("pt must be a dict with keys 'lat' and 'lon'")

Copilot uses AI. Check for mistakes.
Comment on lines +35 to +36
$TMPDIR/*.pkl
$TMPDIR/*.grib
Copy link

Copilot AI Feb 8, 2026

Choose a reason for hiding this comment

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

actions/cache does not perform shell expansion for inputs; using "$TMPDIR/.pkl" and "$TMPDIR/.grib" will likely not match anything, so the cache won’t be restored/saved. Use an explicit path like "${{ runner.temp }}/.pkl" (or "/tmp/.pkl") instead.

Suggested change
$TMPDIR/*.pkl
$TMPDIR/*.grib
${{ runner.temp }}/*.pkl
${{ runner.temp }}/*.grib

Copilot uses AI. Check for mistakes.
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.

1 participant