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

Scientific documentation for CCPP-SCM v7.0.0 #1077

Merged
merged 36 commits into from
Sep 5, 2024
Merged

Conversation

mzhangw
Copy link
Collaborator

@mzhangw mzhangw commented Jun 14, 2024

@mzhangw mzhangw requested a review from ligiabernardet June 14, 2024 21:10
@mzhangw mzhangw self-assigned this Jun 21, 2024
Copy link
Collaborator

@ligiabernardet ligiabernardet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HI Man, Tks for the updates. Pls see some comments. I am not done, but I thought I'd send you some initial thoughts

physics/docs/pdftxt/mainpage.txt Outdated Show resolved Hide resolved
physics/docs/pdftxt/mainpage.txt Outdated Show resolved Hide resolved
physics/docs/pdftxt/mainpage.txt Show resolved Hide resolved
physics/docs/pdftxt/mainpage.txt Outdated Show resolved Hide resolved
physics/docs/pdftxt/mainpage.txt Outdated Show resolved Hide resolved
physics/docs/pdftxt/all_schemes_list.txt Outdated Show resolved Hide resolved
physics/docs/pdftxt/all_schemes_list.txt Outdated Show resolved Hide resolved
physics/docs/pdftxt/all_schemes_list.txt Outdated Show resolved Hide resolved
physics/docs/pdftxt/all_schemes_list.txt Outdated Show resolved Hide resolved
physics/docs/pdftxt/all_schemes_list.txt Outdated Show resolved Hide resolved
@@ -2,14 +2,11 @@
!! This file is the parameterization of orographic gravity wave
!! drag, mountain blocking, and form drag.

!> This module contains the orographic gravity wave drag scheme
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It may be too late for this release, but I think we need to rename this scheme and all references to the "drag suite" to "drag scheme". When I get a chance I will open an issue to make the naming conventions more consistent.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see your point. Please work with scheme PoC on this. It is called suite because it internally has various subcomponent. However, I see how that makes it super confusing for CCPP users.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed that it is confusing to call this scheme a "suite". Surely there is a term that can be used that signifies that this scheme has subcomponents than calling it the same term that we reserve for a collection of CCPP schemes.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps change "orographic gravity wave drag scheme" to "orographic drag schemes"? I omitted the word 'wave' because the mountain blocking and form drag components are not 'wave' phenomena.

@ligiabernardet
Copy link
Collaborator

Hi Man, please lmk when these items have been addressed and the website refreshed for final review. Tks

  • In some places (e.g., RRTMG documentation), there is a section on CCPP Physics Updates for v6.0.0. I suggest incorporating all v6 and previous documentation into the main body of the documentation. Then, possibly call out any v7 updates (as you have for, e.g., Thompson).
  • What is the overall strategy for defining acronyms throughout the documentation? I can't figure what should be defined where. Do you want to add a page of acronym definitions? If it is too much to do now, perhaps after the release?
  • RRTMGP could use reference(s)
  • All schemes overview: Instead of "Others", how about" Lake Models"
  • Smoke and Dust should be removed from phys updates since they do not function with SCM
  • RUC: There is a list of "physics updates". Are those for v7. If so, please state. If they are older, please incorporate into main documentation.

@mkavulich
Copy link
Collaborator

@mzhangw Regarding the GFS_NSST scheme, it seems to me like the v4.0 page has a more detailed history and scientific description of the algorithm used along with a nice scientific visualization, though I don't know if it's out-of-date or anything like that. It's not a big deal, just something I noticed while browsing older drafts.

Copy link
Collaborator

@grantfirl grantfirl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mzhangw Please review/approve/merge this: mzhangw#10

There were several changes in this branch that caused ccpp_prebuild to fail. One is that there needs to be an empty !! line after the htmlinclude line. Second, you need to keep the 3 line Doxygen markup for DDTs that are needed by the host/physics (the arg_table, htmlinclude, and blank line). My PR into your branch fixes it so that this branch builds.

Changes needed to compile scidoc v7 updates
@grantfirl
Copy link
Collaborator

@ligiabernardet @mkavulich Since you requested changes, please re-review to see if your concerns have been addressed. With 8442afa, this now builds OK.

- CSDLFsfc: Downward LW
- CSDSFsfc: Downward SW
- CSULFsfc: Upward LW
- CSULFsfc: Upward LW
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CSULFsfc is duplicated in this context.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rhaesung Good catch. Line 63 should be "CSDLFsfc: Downward LW."
@mzhangw Looks like this is true for RRTMG as well,

- CSULFsfc: Upward LW
, and we should change.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dustinswales CSDLFsfc: Downward LW is already explained in line 60.


While the parameterization for smoke and dust representation is used RRFS prototype tests and is included in the
HRRR_gf Suite Definition File, is not active in the CCPP Single Column Model since the smoke and dust tracers are initialized
with new zero values.
Copy link

@hertneky hertneky Aug 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While the parameterization for smoke and dust representation is used by RRFS prototype tests and is included in the
HRRR_gf Suite Definition File, it is not active in the CCPP Single Column Model since the smoke and dust tracers are initialized
with new zero values.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a couple grammar fixes in italics

@grantfirl grantfirl merged commit c5c88df into NCAR:main Sep 5, 2024
3 checks passed
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.