Documentation updates for UGWP Version 0#217
Conversation
… from gwdps_pre to GFS_GWD_generic_pre, remove trailing whitespaces
…into doc_updates_ugwd_cires
|
See https://github.com/NCAR/NEMSfv3gfs/pull/218 for testing. |
gold2718
left a comment
gold2718
left a comment
There was a problem hiding this comment.
Can someone explain why specific suites are documented in the framework infrastructure repository?
|
|
||
| ------------------------------- | ||
| ------------------------------- | ||
| Operational GFS v15 Suite |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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 :).
5 participants
This PR updates the technical documentation to reflect changes in the scheme names
gwdps_pre-->GFS_GWD_generic_pre, and remove trailing whitespaces. Affectsdoc/CCPPtechnical/source/ConstructingSuite.rstonly.Additionally: increase default size for CCPP dynamic variable lookup table in
src/ccpp_fields_idx.hAssociated PRs:
NCAR/ccpp-physics#298
https://github.com/NCAR/FV3/pull/186
https://github.com/NCAR/NEMSfv3gfs/pull/218
#217