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

[develop] Updates to Users Guide and Tables #722

Merged
merged 47 commits into from
Jul 11, 2023

Conversation

gspetro-NOAA
Copy link
Collaborator

@gspetro-NOAA gspetro-NOAA commented Jun 8, 2023

This PR updates the UPP User's Guide and associated tables. A human-friendly version of the docs on my fork can be viewed here: https://gsp-upp.readthedocs.io/en/text-ug-updates/

Update Tables (added/deleted fields)***:

  • GRIB2 Fields Produced by UPP (add table sorted by UPP ID)
  • Unified Model Variables from UFS

***Note that additions appear with ** around the name (rendered as bold type on ReadTheDocs). Someone should double-check these to verify accuracy, since the documentation was not always clear. I will remove the ** before merging.

Update User's Guide

  • Correct minor typos/grammar
  • Switch to sphinx_rtd_theme
  • Add link to terms of service in wiki
  • Add UPP schematic from DTC's UPP System Architecture page
  • Add directory structure diagram
  • Add Glossary
  • Add prerequisites section

Additionally, this PR updates the list of prerequisites in the README.md file. This should resolve Issue #723 .

@gspetro-NOAA gspetro-NOAA marked this pull request as ready for review June 8, 2023 19:37
Copy link
Contributor

@hertneky hertneky left a comment

Choose a reason for hiding this comment

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

@gspetro-NOAA I didn't quite make it through this document. I will be back in the office on the 29th and can finish that day if you are able to wait.
Many are just spelling out acronyms, or being a bit more specific, which is up to you to take or leave

Freezing level RH,RH_ON_0C_ISOTHERM,RH,63
10 M u-component wind,UGRD_ON_SPEC_HGT_LVL_ABOVE_GRND_10m,UGRD,64
10 M v-component wind,VGRD_ON_SPEC_HGT_LVL_ABOVE_GRND_10m,VGRD,65
**Relative humidity on sigma levels 0.33-1.0**,RH_ON_SIGMA_LVL_0.33-1.0,RH,66
Copy link
Contributor

Choose a reason for hiding this comment

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

Relative humidity on sigma layer (0.33-1.00 mean)

docs/UPP_GRIB2_Table_byID.csv Outdated Show resolved Hide resolved
docs/UPP_GRIB2_Table_byID.csv Outdated Show resolved Hide resolved
docs/UPP_GRIB2_Table_byID.csv Outdated Show resolved Hide resolved
docs/UPP_GRIB2_Table_byID.csv Outdated Show resolved Hide resolved
docs/UPP_GRIB2_Table_byID.csv Outdated Show resolved Hide resolved
docs/UPP_GRIB2_Table_byID.csv Outdated Show resolved Hide resolved
docs/UPP_GRIB2_Table_byID.csv Outdated Show resolved Hide resolved
docs/UPP_GRIB2_Table_byID.csv Outdated Show resolved Hide resolved
docs/UPP_GRIB2_Table_byID.csv Outdated Show resolved Hide resolved
Copy link
Contributor

@hertneky hertneky left a comment

Choose a reason for hiding this comment

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

Finished! Just a handful more changes. One comment about a number of the older satellite products, esp the ones that state not available for grib2 output, they are not in post_avblflds and maybe should not be in this table. They are slated for removal when they get a chance. You could remove them from this table now.

docs/UPP_GRIB2_Table_byID.csv Outdated Show resolved Hide resolved
docs/UPP_GRIB2_Table_byID.csv Outdated Show resolved Hide resolved
docs/UPP_GRIB2_Table_byID.csv Outdated Show resolved Hide resolved
docs/UPP_GRIB2_Table_byID.csv Outdated Show resolved Hide resolved
docs/UPP_GRIB2_Table_byID.csv Outdated Show resolved Hide resolved
docs/UPP_GRIB2_Table_byID.csv Outdated Show resolved Hide resolved
docs/UPP_GRIB2_Table_byID.csv Outdated Show resolved Hide resolved
docs/UPP_GRIB2_Table_byID.csv Outdated Show resolved Hide resolved
Copy link
Contributor

@hertneky hertneky left a comment

Choose a reason for hiding this comment

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

Looks, may be good to do a stand-alone test to ensure these produce expected results since they were not tested for grib2 output. If you decide to do that, let me know if you need help with that, it is not time consuming if you already have UPP built and have simple test data.

@gspetro-NOAA
Copy link
Collaborator Author

Looks, may be good to do a stand-alone test to ensure these produce expected results since they were not tested for grib2 output. If you decide to do that, let me know if you need help with that, it is not time consuming if you already have UPP built and have simple test data.

@FernandoAndrade-NOAA Do you know how to do this? Otherwise, I will need some help, @hertneky .

@WenMeng-NOAA WenMeng-NOAA added No Baseline Change No baseline of the UPP regression tests are made. Ready for Review This PR is ready for code review. labels Jul 7, 2023
@WenMeng-NOAA
Copy link
Collaborator

@FernandoAndrade-NOAA If you have UPP RT tests and UPP standalone test for VTMP, please note them.

@WenMeng-NOAA
Copy link
Collaborator

@hertneky Do you think any requested changes are not updated?

@FernandoAndrade-NOAA
Copy link
Collaborator

@WenMeng-NOAA VTMP Standalone test results with VTMP and hafs are located in the following location with changes in HURPRS09.tm00:
/scratch1/NCEPDEV/nems/Fernando.Andrade-maldonado/regression-tests/upp-tests/emc/rt-722/RTs-resync/rundir/fv3hafs_2022092800
I'm rerunning RTs for the other tests in the same RTs-resync directory now to make sure on Hera

@hertneky
Copy link
Contributor

@hertneky Do you think any requested changes are not updated?

It looks like all changes have been made.

Copy link
Contributor

@hertneky hertneky left a comment

Choose a reason for hiding this comment

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

Final changes look good, @FernandoAndrade-NOAA mentioned he tested the VTMP additions stand-alone. The virtual temperature output in his tests look reasonable. Thanks for testing that!

@FernandoAndrade-NOAA
Copy link
Collaborator

Final changes look good, @FernandoAndrade-NOAA mentioned he tested the VTMP additions stand-alone. The virtual temperature output in his tests look reasonable. Thanks for testing that!

Thanks for confirming!
@WenMeng-NOAA RTs for the other tests cases have completed in the same RTs-resync directory on Hera, I'm not seeing any changes in results

@WenMeng-NOAA
Copy link
Collaborator

/scratch1/NCEPDEV/nems/Fernando.Andrade-maldonado/regression-tests/upp-tests/emc/rt-722/RTs-resync/rundir/fv3hafs_2022092800

@FernandoAndrade-NOAA Your test results for VTMP look good to me.

@WenMeng-NOAA
Copy link
Collaborator

@FernandoAndrade-NOAA Please approve this PR.

@WenMeng-NOAA
Copy link
Collaborator

This PR is ready for merging.

@WenMeng-NOAA WenMeng-NOAA merged commit 811df42 into NOAA-EMC:develop Jul 11, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation No Baseline Change No baseline of the UPP regression tests are made. Ready for Review This PR is ready for code review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants