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]: Add Doxygen variable definitions to modules #965

Merged
merged 109 commits into from
Jul 8, 2024

Conversation

gspetro-NOAA
Copy link
Collaborator

@gspetro-NOAA gspetro-NOAA commented Jun 6, 2024

This PR updates documentation in the following files:

doc/Doxyfile.in --> Removed extra = and updated file using doxygen -u Doxyfile.in to resolve warnings.
UFS_unified_variables_table.csv - fix typo
BOUND.f
BNDLYR.f
CALDWP.f
CALGUST.f
CALHEL.f
CMASSI.f
CTLBLK.f
FRZLVL2.f
GFIP3.f
GFSPOSTSIG.F
IFI.F
LOOKUP.f
MASKS_mod.f
MISCLN.f
PARA_RANGE.f
READ_xml.f
RHGRD.f
RQSTFLD.f
SET_LVLSXML.f
SOIL_mod.f
TRPAUS.f
UPP_PHYSICS.f
VRBLS2D.f
VRBLS3D.f
VRBLS4D.f
cuparm.f
grib2_module.f
gtg_filter.F90
gtg_indices.F90
gtg_read_config.F90
intio_tags.f
machine.f
params.F
physcons.f
svptbl.f
sorc/ncep_post.fd/wrf_io_flags.f
xml_perl_data.f
ZENSUN.f

This PR largely addresses Issue #392 and warnings that came up in modules after documenting routines for that issue.

Authors: @gspetro-NOAA, @jdkublnick

@gspetro-NOAA gspetro-NOAA marked this pull request as ready for review July 2, 2024 15:22
@FernandoAndrade-NOAA FernandoAndrade-NOAA added the Ready for Review This PR is ready for code review. label Jul 8, 2024
Copy link
Collaborator

@FernandoAndrade-NOAA FernandoAndrade-NOAA left a comment

Choose a reason for hiding this comment

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

No changes in RT results on Hera.

@WenMeng-NOAA WenMeng-NOAA added the No Baseline Change No baseline of the UPP regression tests are made. label Jul 8, 2024
@WenMeng-NOAA
Copy link
Collaborator

This PR is ready for merging.

@WenMeng-NOAA WenMeng-NOAA merged commit 60d1cbb into NOAA-EMC:develop Jul 8, 2024
4 of 5 checks passed
FernandoAndrade-NOAA pushed a commit that referenced this pull request Aug 14, 2024
* add CTLBLK html

* add CALMICT htmls

* add CALPBL/CALPBLREGIME htmls

* add CALPW, CALRAD_WCLOUD_newcrtm, and CLDRAD htmls

* add COLLECT and COLLECT_LOC htmls

* update EXCH & FDLVL htmls

* update GFIP3, GPVS, and GRIDSPEC htmls

* update INITPOST* htmls

* update MDL2P, MPI_FIRST, & PMICRPH

* update PROCESS & WRFPOST files

* update xml_perl_data html

* update gh-pages

* update ghp

* update gh-pages w/ content of PR 965

* fix path the 2D-Decomp md file

* rm file w/local path
DavidHuber-NOAA added a commit to DavidHuber-NOAA/UPP that referenced this pull request Sep 9, 2024
* origin/develop:
  Updates to support MPAS applications (RRFS and HFIP) (NOAA-EMC#1029)
  Add 6-hrly max winds at 10m to SFS (NOAA-EMC#1019)
  Update jet.lua (NOAA-EMC#1027)
  Updates to support UPP use with MPAS (NOAA-EMC#1018)
  [develop]: Turn on WARN_AS_ERROR for Doxygen Documentation Builds (NOAA-EMC#1023)
  Sample PR for testing (NOAA-EMC#1007)
  Enable template 4-49 to obtain aerosol ensemble information (NOAA-EMC#1011)
  Relocate gfs/gefs/sfs control files (NOAA-EMC#990)
  update g2tmp on aws to 1.12.0 (NOAA-EMC#996)
  [develop]: Update requirements files (NOAA-EMC#994)
  Bump zipp from 3.17.0 to 3.19.1 in /doc/UserGuide (NOAA-EMC#991)
  remove stack-python load for Gaea build (NOAA-EMC#993)
  Bump certifi from 2024.2.2 to 2024.7.4 in /doc/UserGuide (NOAA-EMC#988)
  [develop]: Add Doxygen variable definitions to modules (NOAA-EMC#965)
  Read bucket either as an integer or float (NOAA-EMC#984)
  Update Orion module file for Rocky 9 upgrade (NOAA-EMC#987)
  UPP bugfixes for inline post and g2tmpl 1.12.0 compatibility (and number concentration updates) (NOAA-EMC#974)
  Sync the RRFS hotfix NOAA-EMC#967 and NOAA-EMC#968. (NOAA-EMC#979)
  Bump urllib3 from 2.2.1 to 2.2.2 in /doc/UserGuide (NOAA-EMC#981)
  Fix for hydrostatic runs - write out Omega and HGT from model output (NOAA-EMC#959)
  Bump requests from 2.31.0 to 2.32.0 in /doc/UserGuide (NOAA-EMC#963)
  Correct rt.sh paths (NOAA-EMC#957)
  Updates to use GRIB2 template 4.9 for QPFFFG and QPFARI variables in RRFS (NOAA-EMC#929)
  Add hourly averaged smoke PM2.5 and dust PM10 (NOAA-EMC#917)
  Update Namelist documentation for all namelist options (NOAA-EMC#940)
  update gtg code revision to v.4.16.3 (NOAA-EMC#954)
  Bump jinja2 from 3.1.3 to 3.1.4 in /doc/UserGuide (NOAA-EMC#953)
  Clean up labeling for 15-min accumulated fields (NOAA-EMC#948)
  Updates to the GSL exp1 ceiling diagnostic (NOAA-EMC#947)
  Additional RT log information (NOAA-EMC#941)
  add cmake load to modulefile/gaea.lua (NOAA-EMC#945)
  RRFS updates (NOAA-EMC#938)
  add module for AWS (NOAA-EMC#934)
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.

4 participants