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 for new 3D diagnostic tendencies #38

Merged
merged 25 commits into from
Jul 21, 2021

Conversation

SamuelTrahanNOAA
Copy link
Contributor

@SamuelTrahanNOAA SamuelTrahanNOAA commented Apr 13, 2021

The "develop" and "main" branches of UFS, FV3, and ccpp/physics now support 3D diagnostic tendencies for tracers. This PR updates the documentation to match the new method.

Edit July 20, 2021: The code is now in the "main" and "develop" branches, so this PR contains documentation for the latest code.

Changes written by @SamuelTrahanNOAA by request of @ligiabernardet and @climbfuji

Code PRs are here:

NOAA-EMC/fv3atm#332
NCAR/ccpp-physics#681
ufs-community/ufs-weather-model#660

@SamuelTrahanNOAA
Copy link
Contributor Author

I'm uncertain of the SCM aspects of the documentation, so I'm hoping others can comment on that in their reviews.

@ligiabernardet
Copy link
Collaborator

It is good to review this PR, but it should only be merged when the code changes themselves go to master.

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.

Thank you so much for documenting this capability. It is quite easy to follow.

CCPPtechnical/source/ParamSpecificOutput.rst Outdated Show resolved Hide resolved
CCPPtechnical/source/ParamSpecificOutput.rst Outdated Show resolved Hide resolved
CCPPtechnical/source/ParamSpecificOutput.rst Outdated Show resolved Hide resolved

.. _avail_tend_processes:

.. table:: Processes that can change non-chemical tracer and state variables. The third column is the
Copy link
Collaborator

Choose a reason for hiding this comment

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

Need to introduce a space in the rendered HTML between the end of Table 1 and the beginning of Table 2

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added space before each table. How does it look now?

CCPPtechnical/source/ParamSpecificOutput.rst Outdated Show resolved Hide resolved
CCPPtechnical/source/ParamSpecificOutput.rst Show resolved Hide resolved
CCPPtechnical/source/ParamSpecificOutput.rst Outdated Show resolved Hide resolved
CCPPtechnical/source/ParamSpecificOutput.rst Outdated Show resolved Hide resolved
CCPPtechnical/source/ParamSpecificOutput.rst Outdated Show resolved Hide resolved
CCPPtechnical/source/ParamSpecificOutput.rst Outdated Show resolved Hide resolved
SamuelTrahanNOAA and others added 15 commits April 16, 2021 14:28
Co-authored-by: ligiabernardet <ligia.bernardet@noaa.gov>
Co-authored-by: ligiabernardet <ligia.bernardet@noaa.gov>
Co-authored-by: ligiabernardet <ligia.bernardet@noaa.gov>
Co-authored-by: ligiabernardet <ligia.bernardet@noaa.gov>
Co-authored-by: ligiabernardet <ligia.bernardet@noaa.gov>
Co-authored-by: ligiabernardet <ligia.bernardet@noaa.gov>
Co-authored-by: ligiabernardet <ligia.bernardet@noaa.gov>
Co-authored-by: ligiabernardet <ligia.bernardet@noaa.gov>
Co-authored-by: ligiabernardet <ligia.bernardet@noaa.gov>
Co-authored-by: ligiabernardet <ligia.bernardet@noaa.gov>
Co-authored-by: ligiabernardet <ligia.bernardet@noaa.gov>
@SamuelTrahanNOAA
Copy link
Contributor Author

Thank you so much for documenting this capability. It is quite easy to follow.

Hopefully it is still easy to follow now that I've rearranged it.

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.

Documentation looks good.
One @grantfirl has this capability working in the SCM, some touch ups will be needed. Including being clear about SCM using time-aggregated tendencies (doc still says instantaneous).

@SamuelTrahanNOAA
Copy link
Contributor Author

Can this PR be merged now? The code PRs are all merged to their respective central repositories.

@climbfuji climbfuji merged commit 198b6a8 into NCAR:main Jul 21, 2021
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.

4 participants