Skip to content

Fix breeze_over_four_oceans docs example + add missing datasets to table#398

Open
glwagner wants to merge 3 commits into
mainfrom
glw/docs-datasets-and-breeze-fix
Open

Fix breeze_over_four_oceans docs example + add missing datasets to table#398
glwagner wants to merge 3 commits into
mainfrom
glw/docs-datasets-and-breeze-fix

Conversation

@glwagner

@glwagner glwagner commented Jul 1, 2026

Copy link
Copy Markdown
Member

Summary

Two related docs fixes. The dev docs have been frozen at a pre-ERA5 build for ~a month because every push-to-main docs deploy has failed silently.

1. Fix the deploy-blocking example

examples/breeze_over_four_oceans.jl accessed slab_ocean_atmos.dynamics.reference_state, but atmosphere_simulation returns a Simulationdynamics lives on .model (AnelasticDynamics, verified to hold reference_state). The bad access threw a FieldError that aborted the whole docs build.

Why PR CI never caught it: the example has build_always=false, so per docs/make.jl + docs.yml it is executed only on push-to-main/tags or on PRs labelled build all examples. Ordinary PR CI skips it. So PRs stayed green while every main deploy died before publishing — freezing dev at the 2026-05-26 build (just before ERA5 was added in #298).

2. Add missing datasets to the supported-datasets table

docs/src/Metadata/metadata_overview.md never listed some shipped datasets:

  • GLO30, GLO90 (CopernicusDEM, :bottom_height) — Bathymetry and static grids
  • GloFASReanalysis (:river_discharge) — Land

(ERA5 was already in the source table since #298; it simply never deployed.)

Verification

This PR carries the build all examples label so CI runs breeze_over_four_oceans and confirms the fix on the full deploy path.

🤖 Generated with Claude Code

The `breeze_over_four_oceans` example accessed `slab_ocean_atmos.dynamics`,
but `atmosphere_simulation` returns a `Simulation`, whose `dynamics` lives on
`.model`. The resulting `FieldError` aborted the docs build. Because the example
has `build_always=false`, it runs only on the main-push deploy (and labelled
PRs), so PR CI never caught it and every main deploy since has failed to publish
— freezing the dev docs at a pre-ERA5 build.

Also add the CopernicusDEM (`GLO30`, `GLO90`) and GloFAS (`GloFASReanalysis`)
datasets to the supported-datasets table, which were shipped but never listed.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@glwagner glwagner added the build all examples add this label to build all the examples in the PR label Jul 1, 2026
glwagner and others added 2 commits July 1, 2026 15:56
atmosphere_simulation returns a Simulation, so set!, velocities,
microphysical_fields, and liquid_ice_potential_temperature must go
through .model, matching breeze_over_slab_land.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XCkJjRLctVm4c7FM7W7Bbx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build all examples add this label to build all the examples in the PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants