Repository navigation
Replace the agent docs with a short map and agent guide; propagate add_incs errors - #446
Merged
pchakraborty merged 3 commits intoNov 12, 2026
Merged
Conversation
run and run_add_incs called ADD_INCS without rc, and add_incs passed rc=rc to PULL_Q without checking it, so a failure there (for example a missing water tracer) went unreported. All of these calls now use _RC.
docs/ARCHITECTURE.md is now a short map (codemap, how DYN and ADV are put together, contracts, invariants, cross-cutting concerns); AGENTS.md keeps rules, status, known traps and build and test. Remove docs/decisions.md. Covers the adv-sa case and the current geometry keys, and fixes the parent-document paths.
Describe where the regression data comes from, how the checkpoints are compared, the logging setup and what each case runs; remove the section on cmpchk.py scripts that do not exist and the Held-Suarez description of dyn-sa (CASE_ID 1 is the Jablonowski-Williamson steady state). Drop the corresponding status item from AGENTS.md.
pchakraborty
marked this pull request as ready for review
November 11, 2026 15:13
tclune
approved these changes
Nov 12, 2026
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.
Description
docs/ARCHITECTURE.mdis now a short repository map in the style of matklad's ARCHITECTURE.md (about 70 lines instead of about 410): bird's-eye view (the dynamics state lives in MAPL's internal state and is copied into FV3 before each step and back after it; tracers stay with their owners and are lent throughTRADV), codemap, howDYNandADVare put together (placement under Superdyn, grid, state,run,run_add_incs,FV_Runand tracer packing,ADVand itsDYCOREsettings), contracts (imports, exports;DYNandADVboth provideTRADVand subscribe to no service), invariants, cross-cutting concerns. It names modules and routines, describes only what changes rarely, and has no status or to-dos.AGENTS.mdkeeps what changes and what to do: rules (bugs and questions go to issues; do not edit generated*___.h; MAPL3 error macros; porting follows theGEOSgcm_GridCompAGENTS.md), status and to-dos, known traps (each phrased as what goes wrong), build and test. Verified against4d7c4a3.docs/decisions.md(the reasons were inferred, not recorded decisions).adv-sa(Add adv-sa regression test for standalone AdvCore #437) and the currentgeometry:keys, and pointed one directory too high for Superdyn's documents; the new ones are checked against the code.regression/README.mdbrought up to date: where the regression data comes from (LOCAL_REGRESSION_DATA_DIR, S3 sync), how checkpoints are compared, thelogging.yamlsetup, and what each case runs; removed the section oncmpchk.pyscripts that do not exist, anddyn-sais no longer called Held-Suarez (CASE_ID: 1is the Jablonowski-Williamson steady state).DynCore_GridCompMod.F90:runandrun_add_incscalledADD_INCSwithoutrc, andadd_incspassedrc=rcto its eightPULL_Qcalls without checking it, so errors there went unreported. These calls now use_RC. Error handling only; no change to results.The open questions and observations from the removed documents are not in this PR; they are collected separately to be filed as issues. Same approach as GEOS-ESM/GOCART#503, GEOS-ESM/GEOSgcm_GridComp#1577 and GEOS-ESM/GEOSradiation_GridComp#117; the PRs are independent.
Testing
Built in the GEOSgcm fixture;
ctest -L REGRESSIONpasses, includingadv-dyn,adv-saanddyn-sa.