Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename CCPP suites to non-meaningful names #477

Draft
wants to merge 37 commits into
base: main
Choose a base branch
from

Conversation

mkavulich
Copy link
Collaborator

@mkavulich mkavulich commented May 22, 2024

Description:

This PR renames CCPP suites to non-meaningful bird names, as suggested by various colleagues and ChatGPT. The old names are mapped to the new names via a file "alias.json" for convenience.

Some older, unsupported suites, especially those with no entry in suite_info.py, are moved to a new directory suites_not_used/, analogous to the ufs-weather-model treatment of these suites.

Dependencies:

Framework PR: NCAR/ccpp-framework#569

  • Requires a PR to CCPP framework to remove the ccpp_prebuild requirement that all suite files start with the prefix "suite_". This Framework update requires some changes to the CI tests to use MPI, which is required in the latest version.

Physics PR: NCAR/ccpp-physics#1073

New guidelines are proposed in CCPP Technical documentation PR here: NCAR/ccpp-doc#72

Tests:

Ran full suite of regression tests, all succeeded. Running manual tests on MacOS showed a few suites that are failing with segmentation faults, but this seems to be intermittent and must be related to my specific machine. One suite (SCM_GFS_v16_RRTMGP "mallard") failed all tests due to memory allocation; this appears to be a pre-existing problem, see #484.

Did a bit-for-bit comparison for all the regtest cases (arm_sgp_summer_1997_A, astex, bomex, LASSO_2016051812, twpice) between this branch and the branch for PR #482 (which updated framework and physics to same hash as this PR); aside from the failing tests the only differences were for suite "robin" (previously SCM_GFS_v17_HR3_RRTMGP), and this is expected due to a changed tracers file.

Issue:

This resolves #476

… to new.

Problems that still need solving:

 - At runtime, there is no logic to map the old suite name to the new for the static API
…ge namelists, documentation, and other stuff later. This helps test back-compatibility features like the alias file.

 - Update descriptions of "barn_owl" suites, esp details about "prescribed surface" suites
 - Another set of renames
 - Add "rename" script for posterity (will delete before commit)
…names). Now we just force everyone to rename them all. We do keep the ability for suite files to be named "suite_[suitename].xml" for back-compatibility.

 - Update alias files for new names
 - Rename physics namelists and tracers for renamed suites
 - Update renames in various files in src and run directory
 - Update Regression Test files for renames
 - Remove old, orphaned SDFs SCM_GFS_v15p2_FA and SCM_GFS_v15p2_MYJ

Next commit will rename the rest of the suites.
…for each.

 - Un-delete suite_SCM_GFS_v15p2_MYJ, which is still present in "suite_info.py"
…to treatment of old suites in fv3atm.

No reason to waste a bird on these!
 - Moved a few more to "suites_not_used"
 - More specific description for prescribed surface suites
 - most importantly, updating the new HR3+RRTMGP (robin) and RRFS_v1 (warbler) suites.
 - Add some more space in description comments for legibility
@mkavulich mkavulich force-pushed the feature/suite_names_update_rebase branch from a3061c0 to fb91098 Compare May 23, 2024 20:17
@mkavulich mkavulich force-pushed the feature/suite_names_update_rebase branch from 5826f71 to 93c292e Compare May 23, 2024 21:59
@mkavulich mkavulich mentioned this pull request May 29, 2024
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.

Change suite names to follow new CCPP guidelines
2 participants