search

NCAR / ccpp-framework

Common Community Physics Package (CCPP)
http://www.dtcenter.org/community-code/common-community-physics-package-ccpp/
Other
26 stars 62 forks source link

Remove requirement that suite definition file names begin with "suite_" #569

Closed mkavulich closed 18 hours ago

mkavulich commented 1 month ago

As part of a new set of suite naming guidelines (see https://github.com/NCAR/ccpp-doc/pull/72), we are removing the requirement that suite definition file names begin with the literal string suite_. Currently this requirement is hard-coded into CCPP prebuild (but not in capgen), so the changes in this PR are necessary to remove them.

I included some back-compatibility logic to allow for the previous naming convention to work as well. So if a user attempts to use ccpp_prebuild.py with a suite named "suitename", it will first look for an SDF named "suitename.xml", and then (if not found) look for an SDF named "suite_suitename.xml".

User interface changes?: Yes, but not required; see above back-compatibility description.

Fixes: #568 Remove requirement that suite files begin with "suite_"

Testing: test removed: None unit tests: Renamed the SDF for test_blocked_data so that it tests the new suite naming conventions. Other tests were left alone, so the old naming conventions also get tested system tests: ?? manual testing: Ran many different tests with SCM; see https://github.com/NCAR/ccpp-scm/pull/477 for more details

mkavulich commented 1 month ago

@climbfuji regarding the suite names, since we are still supporting the legacy naming convention I thought retaining a mix of old and new suite names in our unit tests was appropriate.