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

Documentation updates for UGWP Version 0 #217

Merged
merged 3 commits into from
Aug 27, 2019

Conversation

climbfuji
Copy link
Collaborator

@climbfuji climbfuji commented Aug 22, 2019

This PR updates the technical documentation to reflect changes in the scheme names gwdps_pre --> GFS_GWD_generic_pre, and remove trailing whitespaces. Affects
doc/CCPPtechnical/source/ConstructingSuite.rst only.

Additionally: increase default size for CCPP dynamic variable lookup table in src/ccpp_fields_idx.h

Associated PRs:

NCAR/ccpp-physics#298
https://github.com/NCAR/FV3/pull/186
https://github.com/NCAR/NEMSfv3gfs/pull/218
#217

… from gwdps_pre to GFS_GWD_generic_pre, remove trailing whitespaces
Copy link

@JulieSchramm JulieSchramm left a comment

Choose a reason for hiding this comment

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

Yay, no typos!

@climbfuji
Copy link
Collaborator Author

See https://github.com/NCAR/NEMSfv3gfs/pull/218 for testing.

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.

Approved

Copy link
Contributor

@llpcarson llpcarson left a comment

Choose a reason for hiding this comment

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

Approved

Copy link
Collaborator

@gold2718 gold2718 left a comment

Choose a reason for hiding this comment

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

Can someone explain why specific suites are documented in the framework infrastructure repository?

@@ -160,16 +160,16 @@ Consider the case where a model requires that some subset of physics be called o
</group>
</suite>

-------------------------------
-------------------------------
Operational GFS v15 Suite
Copy link
Collaborator

Choose a reason for hiding this comment

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

I am still not sure why the GFS suite is documented in the CCPP Framework which is supposed to be infrastructure for all models. Are all suites going to be documented here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We briefly touched on this issue of having documentation that changes more frequently under ccpp-framework. The problem I think is that the "big document" aka techdoc combines technical aspects of the ccpp-framework and scientific aspects such as the suites.

We agreed that it would be better to move this contents into a ccpp-doc (ccpp-documentation) repository on the NCAR GitHub to avoid changing ccpp-framework everytime a small change is made to the documentation. Since the techdoc is NOAA-NCAR/DTC centric, this would be something NCAR/CGD NCAR/MMM don't really have to worry about. We also agreed that your feedback is valuable and that it still would be good to invite you for looking at the PRs. What do you think? Details could be fleshed out next Thursday?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think I agree on all these fronts. The CCPP Framework documentation should describe some simple suite or suites that demonstrate the features of suites.
The ccpp-doc would be a more complete technical document for GMTB / NOAA.
Ideally, we could configure the CCPP Framework technical document to make it easy to incorporate into model-specific docs (e.g., UFS, CESM). I would also like to see some way to have a technical document for a suite that is part of the suite when we finally stand up a CCPP Physics repository.
I am happy to review other documents (when I'm not too busy :).

@climbfuji climbfuji merged commit cfe7cb9 into NCAR:gmtb/develop Aug 27, 2019
@climbfuji climbfuji deleted the doc_updates_ugwd_cires branch June 27, 2022 03:02
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.

5 participants