Updates for CCPP version 7 release #73

mkavulich · 2024-08-04T02:36:00Z

Updates to the technical documentation in advance of the CCPP v7 release. The rendered version of this branch can be found here: https://mike-k-tech-doc.readthedocs.io/en/latest/

Note that not all items in #71 have been completed; I have checked off the items that I was able to finish.

To do:

Update all links to Sci Doc once published
Update all links to code in repository once tag is created

…rences and links to v6, de-emphasizing "operational" suites

…able (still need to update descriptions), further revise language about "operational" suites

…d to be updated to final version later) - Update links to SCM users guide in new RTD location - Update rest of references to unsupported suites - Update ccpp_track_variables.py instructions for new physics suite directory structure - Reorganize how previous releases are documented, moved into their own section and cleaned up - A few other misc fixes

ligiabernardet

Mike, this is a terrific document. Lots of very helpful information for the user and developer community. Thank you for your updates.

ligiabernardet · 2024-08-04T20:05:50Z

CCPPtechnical/source/Overview.rst

@@ -107,79 +110,85 @@ undertaken by NOAA and NCAR (see more information at https://github.com/NCAR/ccp
 and https://dtcenter.org/community-code/common-community-physics-package-ccpp).

 The table below lists all parameterizations supported in CCPP public releases and the
-`CCPP Scientific Documentation <https://dtcenter.ucar.edu/GMTB/v6.0.0/sci_doc/index.html>`_
+`CCPP Scientific Documentation <https://dtcenter.ucar.edu/GMTB/v7.0.0p/sci_doc/index.html>`_


After

the DTC works with EMC and its sponsors to determine :term:schemes <scheme>
and suites to be included and supported.

I suggest including the criteria for inclusion discussed at the October 2023 CCPP Physics Code Mgmt Meeting (Slide 3 here). You may also want to repeat/refer to this information in Chapter 9.

The scheme is sufficiently different from schemes already in the repository.

The scheme is desired by an organization participating in the funding of CCPP or the scheme’s development and/or testing is a funded project of a CCPP-sponsor organization.

The scheme can be compiled/run with some CCPP-compliant host model.

Ideally, the scheme is regression tested using at least one host model.

The scheme is documented and (ideally) published with scientific results.

The scheme has developer support, or at least a point-of-contact for reviewing code changes.

ligiabernardet · 2024-08-04T20:13:14Z

CCPPtechnical/source/Overview.rst


-* The RRFS_v1beta suite is being used for development of the future `Rapid Refresh Forecast System (RRFS) <https://gsl.noaa.gov/focus-areas/unified_forecast_system/rrfs>`_, which is scheduled for implementation in late 2023. This scheme features Thompson microphysics, MYNN EDMF PBL, RRTMG radiation, MYNN SFL, CIRES uGWD, and Noah-MP land surface (it does not feature convective parameterization).
+Finally, the HRRR_gf suite was developed for use with prototypes of the `Rapid Refresh Forecast System (RRFS) <https://www.emc.ncep.noaa.gov/users/emc.campara/rrfs/>`_, and is similar to the physics used in the operational High-Resolution Rapid Refresh (HRRR) model physics package except with the implementation of deep convective parameterization.
+This suite features Thompson Aerosol-Aware microphysics, MYNN-EDMF PBL physics, `Grell-Freitas deep convection <https://dtcenter.ucar.edu/GMTB/v7.0.0p/sci_doc/_c_u__g_f.html>`_, RRTMG radiation, MYNN SFL, the `Global Systems Laboratory (GSL) <https://dtcenter.ucar.edu/GMTB/v7.0.0p/sci_doc/_g_f_s_drag_suite.html>`_ gravity wave drag scheme, and the `Rapid Update Cycle (RUC) Land Surface Model <https://dtcenter.ucar.edu/GMTB/v7.0.0p/sci_doc/_r_u_c_l_s_m.html>`_.


GSL drag scheme is now called Orographic Drag Scheme (see https://dtcenter.ucar.edu/GMTB/v7.0.0p/sci_doc/_g_f_s_drag_suite.html)

ligiabernardet · 2024-08-04T20:15:39Z

CCPPtechnical/source/Overview.rst

+
+The CCPP v6.0 release, issued in June 2022, was a major upgrade in conjunction with the `UFS SRW v2.0 release <https://ufscommunity.org/announcing-the-ufs-short-range-weather-application-srw-app-v2-0-0-release/>`_.
+
+The CCPP v7.0 release, issued in August 2024, was a major upgrade to physics and the Single-Column Model, particularly with the inclusion of the new `UFS Replay <https://ccpp-scm.readthedocs.io/en/latest/chap_cases.html#using-ufs-output-to-create-scm-cases-ufs-replay>`_ capability for running the SCM from UFS output.


We have moved away from the terminology "UFS Replay" to avoid giving the impression that SCM will produce same results as UFS. We not use the terminology "Case Generator".

ligiabernardet · 2024-08-04T20:20:24Z

CCPPtechnical/source/AddingNewSchemes.rst

@@ -113,7 +113,7 @@ Some tips for debugging problems:
 * Make sure to use an uppercase suffix ``.F90`` to enable C preprocessing.
 * A scheme called GFS_debug (GFS_debug.F90) may be added to the SDF where needed to print state variables and interstitial variables. If needed, edit the scheme beforehand to add new variables that need to be printed.
 * Check the ``ccpp_prebuild.py`` script for success/failure and associated messages; run the prebuild script with the --debug and --verbose flags. See :numref:`Chapter %s <ConstructingSuite>` for more details
-* Compile code in DEBUG mode (see section 2.3 of the `SCM User's Guide <https://github.com/NCAR/ccpp-scm/blob/main/scm/doc/TechGuide/main.pdf>`_, run through debugger if necessary (gdb, Allinea DDT, totalview, …).
+* Compile code in DEBUG mode (see section 4.3 of the `SCM User's Guide <https://ccpp-scm.readthedocs.io/en/latest/chap_quick.html#compiling-scm-with-ccpp>`_, run through debugger if necessary (gdb, Allinea DDT, totalview, …).


Note that this will require a change before the release, to refer to v7

…ork management/governance

- Add reference to "optional" attribute, warning about deprecated "pointer" attribute

…ve repo code for convenience

climbfuji

Thanks for all these updates, very much appreciated. A few tiny changes, the rest looks great.

CCPPtechnical/source/AddingNewSchemes.rst

climbfuji · 2024-08-16T02:34:57Z

CCPPtechnical/source/CCPPDebug.rst

@@ -34,12 +34,12 @@ Two categories of debugging with CCPP
 ============================================
 CCPP-compliant debugging schemes for the UFS
 ============================================
-For the UFS models, dedicated debugging schemes have been created by the CCPP developers. These schemes can be found in ``FV3/ccpp/physics/physics/GFS_debug.F90``. Developers can use the schemes as-is or customize and add to them as needed. Also, several customization options are documented at the top of the file. These mainly deal with the amount/type of data/information output from arrays, and users can switch between them by turning on or off the corresponding preprocessor directives inside ``GFS_debug.F90``, followed by recompiling.
+For the UFS models, dedicated debugging schemes have been created by the CCPP developers. These schemes can be found in `physics/Interstitials/UFS_SCM_NEPTUNE/GFS_debug.F90 <https://github.com/NCAR/ccpp-physics/blob/main/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_debug.F90>`__. Developers can use the schemes as-is or customize and add to them as needed. Also, several customization options are documented at the top of the file. These mainly deal with the amount/type of data/information output from arrays, and users can switch between them by turning on or off the corresponding preprocessor directives inside ``GFS_debug.F90``, followed by recompiling.


Not directly relevant to the documentation, but the release itself. Every time I used the debugging schemes I have to fix something because it's not been updated. Can you make sure that GFS_debug works before you tag the release code, please?

Thanks for mentioning this, it does look like the current capability is broken, we are investigating.

ufs-community/ccpp-physics#183 was merged after the deadline for physics PRs to be included in the release. Since the CCPP release is not associated with a release of the UFS, and only uses the SCM, we'd need to get this working in the SCM, but in order to do so, we'd need to bring in more CCPP physics PRs. I'm not sure that we should do this for the release, although I can work on it afterwards. Maybe for a *.1 tag/release?

@mkavulich @climbfuji Following up, I've updated the SCM to work with and test GFS_Debug.F90. See NCAR/ccpp-scm#529.

CCPPtechnical/source/CCPPPreBuild.rst

CCPPtechnical/source/CompliantPhysicsParams.rst

CCPPtechnical/source/Overview.rst

CCPPtechnical/source/ParamSpecificOutput.rst

Co-authored-by: Dom Heinzeller <dom.heinzeller@icloud.com>

mkavulich · 2024-09-05T15:24:44Z

@climbfuji Did you have any more comments? If not I'll go ahead and merge this PR.

mkavulich added 6 commits August 2, 2024 11:19

Fix a few warnings, start on updating Overview, including update refe…

cdce261

…rences and links to v6, de-emphasizing "operational" suites

More revisions to Overview, add GFS as glossary entry, update suite t…

6703d3e

…able (still need to update descriptions), further revise language about "operational" suites

Fix links, update suite descriptions

0035b39

Add details about new MPI requirements, disallowing pointers

cca5d03

Fix whitespace at end of lines

04456ba

ligiabernardet requested changes Aug 4, 2024

View reviewed changes

mkavulich added 3 commits August 13, 2024 10:29

Address Ligia's comments, clarify that NRL also contributes to Framew…

53f3cbb

…ork management/governance

- Fix links/formatting/spelling

4cdb72d

- Add reference to "optional" attribute, warning about deprecated "pointer" attribute

Add more details about optional arguments, some formatting fixes

1175991

mkavulich mentioned this pull request Aug 13, 2024

Update CCPP tech doc: schemes can currently have optional arguments in between regular arguments - follow up with moving opt args to the end NCAR/ccpp-framework#544

Open

Update full paths to files in physics repository, include links to li…

fa2c907

…ve repo code for convenience

mkavulich marked this pull request as ready for review August 15, 2024 20:56

mkavulich requested review from climbfuji and grantfirl as code owners August 15, 2024 20:56

climbfuji requested changes Aug 16, 2024

View reviewed changes

mkavulich and others added 2 commits August 16, 2024 08:17

Apply @climbfuji suggestions from code review

eb5c71d

Co-authored-by: Dom Heinzeller <dom.heinzeller@icloud.com>

Update CCPPtechnical/source/Overview.rst

72ae00b

Co-authored-by: Dom Heinzeller <dom.heinzeller@icloud.com>

climbfuji approved these changes Sep 5, 2024

View reviewed changes

ligiabernardet approved these changes Sep 5, 2024

View reviewed changes

mkavulich added 5 commits September 9, 2024 08:37

Update Scidoc links

f50405b

Missed this old update: suite GFS_v16beta --> GFS_v16

f6f6811

Update link to modules list

6d93169

Update scidoc example

bb9968e

Update github links for release

86b28d0

mkavulich merged commit 9676366 into NCAR:main Sep 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updates for CCPP version 7 release #73

Updates for CCPP version 7 release #73

mkavulich commented Aug 4, 2024 •

edited

Loading

ligiabernardet left a comment

ligiabernardet Aug 4, 2024

ligiabernardet Aug 4, 2024

ligiabernardet Aug 4, 2024

ligiabernardet Aug 4, 2024

climbfuji left a comment

climbfuji Aug 16, 2024

mkavulich Aug 26, 2024

grantfirl Aug 29, 2024

grantfirl Oct 17, 2024

mkavulich commented Sep 5, 2024


		The CCPP v6.0 release, issued in June 2022, was a major upgrade in conjunction with the `UFS SRW v2.0 release <https://ufscommunity.org/announcing-the-ufs-short-range-weather-application-srw-app-v2-0-0-release/>`_.

		The CCPP v7.0 release, issued in August 2024, was a major upgrade to physics and the Single-Column Model, particularly with the inclusion of the new `UFS Replay <https://ccpp-scm.readthedocs.io/en/latest/chap_cases.html#using-ufs-output-to-create-scm-cases-ufs-replay>`_ capability for running the SCM from UFS output.

Updates for CCPP version 7 release #73

Updates for CCPP version 7 release #73

Conversation

mkavulich commented Aug 4, 2024 • edited Loading

To do:

ligiabernardet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

climbfuji left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mkavulich commented Sep 5, 2024

mkavulich commented Aug 4, 2024 •

edited

Loading