Repository navigation
docs: reorder the examples nav to reading order (into tripolar-north-fold) - #1
Merged
Merged
Conversation
…ering The examples nav went MITgcm, ECCOv4, MOM6, NEMO -- which was neither the filename order nor a difficulty order. xgcm-examples renumbers the notebooks to match how they are meant to be read, and this follows: 01_mitgcm simplest grid, plain .plot(), diff/interp/cumsum 02_nemo_idealized closed basin; adds metrics/derivative/integrate/cumint/transform 03_MOM6 first real curvilinear (tripolar) grid; sets up the fold 04_eccov4 hardest topology (13-tile LLC face_connections), 1.1 GB 05_tripolar_fold most specialized; picks up 03's Arctic seam Two changes of substance over the old order: NEMO moves up from last (it is the natural second step, and burying it meant metrics/transform appeared only at the very end) and ECCOv4 moves down from second (13-tile face_connections is the hardest concept in the suite and it carries the largest download). Also updates the two links the renumbering would have broken: - docs/grid_topology.md -> xgcm-examples/04_eccov4.ipynb - docs/grid_metrics.ipynb -> .../xgcm-examples/01_mitgcm/ (two anchors) Needs the xgcm-examples submodule bumped to the renumbered commit; the notebooks are renamed there, so this nav is only correct alongside that bump. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01C2MVD2DtZLieu1zXgEoXbv
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
…ebooks) Advance the docs/xgcm-examples pointer from xgcm-examples master (24aa947) to the head of xgcm/xgcm-examples#26 (20bb1a1), which renames and improves the example notebooks (adds 05_tripolar_fold, renumbers 01-04, and updates to the xgcm v1.0 padding API). This matches the pointer already recorded on the base branch (tripolar-north-fold), so PR #1's remaining diff is just the nav reorder. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Targets
tripolar-north-fold(the branch behind xgcm#711), since that branch already owns the05_tripolar_foldnav entry and the north-fold docs.Pairs with xgcm/xgcm-examples#34, which renumbers the notebooks. These must land together — the notebooks are renamed there, so this nav is only correct alongside a submodule bump to that commit.
Nav
The examples nav read MITgcm → ECCOv4 → MOM6 → NEMO, which was neither the filename order nor a difficulty order — it reflected the order the examples happened to get written. New order, with filenames renumbered to match:
01_mitgcm.plot(), introducesdiff/interp/cumsum02_nemo_idealizedmetrics,derivative,integrate,cumint,transform03_MOM604_eccov4face_connections), heaviest data (~1.1 GB)05_tripolar_foldTwo changes of substance:
max |w_recon − w_model| = 4.2e-09). Leaving it last meantmetrics/transformonly appeared at the very end.face_connectionsis the hardest concept in the suite and it carries by far the largest download. Its early slot was a legacy of being the original flagship, not of difficulty.This also makes 03 → 05 a genuine hand-off: 03 ends by admitting it "looks away from the Arctic seam", and 05 now opens by fixing exactly that calculation.
Link fixes
The renumbering would have broken two existing links; both are fixed here:
docs/grid_topology.md:177→xgcm-examples/04_eccov4.ipynbdocs/grid_metrics.ipynb→.../xgcm-examples/01_mitgcm/(two anchors:#barotropic-transport-streamfunction,#divergence)Merge order
examples-06-tripolar-fold(added import statement xgcm/xgcm#26)masterdocs/xgcm-examplessubmodule pointer ontripolar-north-fold🤖 Generated with Claude Code
https://claude.ai/code/session_01C2MVD2DtZLieu1zXgEoXbv