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.

Sign up for GitHub

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

Jump to bottom

added documentation of w3iopo subroutine #1131

Merged
merged 3 commits into from
Nov 30, 2023
Merged

added documentation of w3iopo subroutine #1131

merged 3 commits into from
Nov 30, 2023

Conversation

edwardhartnett
Copy link
Contributor

Pull Request Summary

Adding documentation. No code changes in this PR.

Description

Part of #682

This is the documentation for w3iopo().

No code changes in this PR, so no changes of data output and no new tests are needed.

Issue(s) addressed

Adding documentation to w3iopo() in preparation for code for #682.

Commit Message

Adding documentation to w3iopo() in preparation for code for #682.

Check list

Testing

No testing needed, documentation only.

@edwardhartnett edwardhartnett marked this pull request as ready for review November 25, 2023 14:23
MatthewMasarik-NOAA
MatthewMasarik-NOAA requested changes Nov 29, 2023
View reviewed changes
Copy link
Collaborator

@MatthewMasarik-NOAA MatthewMasarik-NOAA left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Hi @edwardhartnett. I reviewed this by checking the output HTML pages. Everything looks good, though there are two variables that have '?'s in their descriptions, and I wanted to see if we could resolve those before merging.

I tried to track down the info for these, but was only partially successful for one of them.

  1. VERTST: https://github.com/edwardhartnett/WW3/blob/ea3b87387b804b46caa07c5831e6e2d6e7e3def4/model/src/w3iopomd.F90#L1047
    I could not find this defined anywhere. However, it's value is compared against VERGRD, which is defined as "Model definition file version number". So, maybe something to the effect of "Model definition file version number to be tested"?

  2. ZET_SETO: https://github.com/edwardhartnett/WW3/blob/ea3b87387b804b46caa07c5831e6e2d6e7e3def4/model/src/w3iopomd.F90#L1068
    I couldn't find this defined anywhere either. In w3odatmd.F90 there is a short comment after the declaration, which states it is for the wave setup, but really doesn't shed much light. I would maybe just leave the Meaning field for that variable blank?

I'll approve if those two lines are resolved.

@edwardhartnett
Copy link
Contributor Author

I've made the changes you suggest.

MatthewMasarik-NOAA
MatthewMasarik-NOAA approved these changes Nov 30, 2023
View reviewed changes
Copy link
Collaborator

@MatthewMasarik-NOAA MatthewMasarik-NOAA left a comment

Choose a reason for hiding this comment

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

Code review

Pass

Testing

Pass

As Ed pointed out, no code changes, so no regtesting needed. The "test" in this case was loading the html output and confirming all looks well.

image

Approved.

@MatthewMasarik-NOAA MatthewMasarik-NOAA merged commit 3f35df7 into NOAA-EMC:develop Nov 30, 2023
20 checks passed
@MatthewMasarik-NOAA
Copy link
Collaborator

The documentation is thorough and tables look very nice. Thanks @edwardhartnett!

@edwardhartnett edwardhartnett deleted the ejh_doc_1 branch November 30, 2023 21:01
miguelsolanocordoba added a commit to wavespotter/WW3 that referenced this pull request Apr 19, 2024
@miguelsolanocordoba @ukmo-ccbunney
@mickaelaccensi @benoitp-cmc @MatthewMasarik-NOAA @Ghazal-Mohammadpour @JessicaMeixner-NOAA @Biao-Zhao @edwardhartnett @AlexanderRichert-NOAA @ErickRogers @DeniseWorthen @camilleanne
Re-base with NOAA-EMC and fix gustiness (#15)
6334796 
* Bugfix - initialised VD and VS to zero in w3srcemd. (NOAA-EMC#1037)

* More efficient test for binary files in matrix.comp (NOAA-EMC#1035)

* Tidy up of pre-processor directives and unused variables in w3srcemd.F90 (NOAA-EMC#1010)

* Correct typo in w3srcemd.F90 pre-processor directive. (NOAA-EMC#1039)

* minor bugfix for matrix grepping on keywords (NOAA-EMC#1049)

* Stop masking group 1 output where icec > icen (NOAA-EMC#1019)

* Doxygen documentation added, 8th subset.(NOAA-EMC#1046)

* NC4 ,F90 ,XX0 switches removed from ww3_tp2.19 regtest (NOAA-EMC#1054)

* CI:  Fix for Intel scripts. GNU scripts updated. (NOAA-EMC#1064)

* correct the computation of QP parameter, add QKK output parameter, change UST scale factor (NOAA-EMC#1050)

* correct issue with ww3_multi when requesting restart2 and using nml file instead of inp file (NOAA-EMC#1070)

* correct calendar for track netcdf output (NOAA-EMC#1079)

* Fix missing mod_def.ww3 file in multigrid regression tests for track output (NOAA-EMC#1091)

* STAB3: fix cmake build for ST4 or ST3 (NOAA-EMC#1086)

* new feature to output out_grd.ww3, out_pnt.ww3 and mod_def.ww3 both in binary and ascii format using switch ASCII. (NOAA-EMC#1089)

* Update local unit number arrays (NDS, MDS) to be same size of array defined in w3odatmd (size=15). Also, defined unit numbers for NDS(14) and NDS(15). (NOAA-EMC#1098)

* Removed code referencing PHIOC in output section for PHICE in ww3_ounf (NOAA-EMC#1093)

* implementation of the GQM (Gaussian Quadrature Method) to replace the DIA in NL1 or NL2. (NOAA-EMC#1083)

* update logic to ensure you are not accessing uninitialized dates (NOAA-EMC#1114)

* Initialised S and D arrays in W3SDB1 before potential early return if zero energy. (NOAA-EMC#1115)

* ww3_ounp.F90:  x/y units attribute corrected from 'm' to 'km' (NOAA-EMC#1088)

* Bugfix: Assign unit numbers to ASCII gridded/point output in multi-grid mode. (NOAA-EMC#1118)

* correct bugs to run correctly GQM implementation (NOAA-EMC#1127)

* Adding documentation to w3iopo() in preparation for code for NOAA-EMC#682. (NOAA-EMC#1131)

* NCEP regtest module updates: uses spack-stack/1.5.0, includes scotch/7.0.4 (NOAA-EMC#1137)

* Minor update to ncep regtests (NOAA-EMC#1138)

* Updated intel workflow to install oneapi compilers from new location. (NOAA-EMC#1157)

* Add unit test for points I/O code. (NOAA-EMC#1158)

* Update Intel CI (relocate /usr/local; ensure intel-oneapi-mpi; use ubuntu-latest) (NOAA-EMC#1161)

* remove lookup table for ST4 to speed up computation and clean up the ST4 code (NOAA-EMC#1124)

Co-authored-by: Fabrice Ardhuin <[email protected]>

* initialize USSP_WN for mod_def (NOAA-EMC#1165)

* Introduce IC4M8 and IC4M9 to WW3 (NOAA-EMC#1176)

* clean up and add ST4 variables (NOAA-EMC#1181)

* w3fld1md.F90: fix divide by zero in CRIT2 parameter (NOAA-EMC#1184)

* ww3_prnc.F90: fix out-of-scope grid index write statement (NOAA-EMC#1185)

* Bugfix: address potential divide-by-zero in APPENDTAIL (NOAA-EMC#1188)

Co-authored-by: Denise Worthen <[email protected]>

* Provide initial drying of cells with depth < ZLIM for SMC grid. (NOAA-EMC#1192)

* Output OMP threading info to screen when running ww3_shel/ww3_multi compiled with the OMPG switch. Also fixes truncation of build.log when running run_cmake_build. (NOAA-EMC#1191)

* Added screen output showing number of threads when OMP enabled.

* update build to get more info in logs (NOAA-EMC#46)

---------

Co-authored-by: Jessica Meixner <[email protected]>

* update run_cmake_test to catch build errors and exit (NOAA-EMC#1194)

* fix merge conflicts

* Fix gustiness bug, as suggst by Pieter

* Change USTARsigma to WAM implementation

---------

Co-authored-by: Chris Bunney <[email protected]>
Co-authored-by: Mickael Accensi <[email protected]>
Co-authored-by: Benoit Pouliot <[email protected]>
Co-authored-by: Matthew Masarik <[email protected]>
Co-authored-by: Ghazal-Mohammadpour <[email protected]>
Co-authored-by: Jessica Meixner <[email protected]>
Co-authored-by: Biao Zhao <[email protected]>
Co-authored-by: Edward Hartnett <[email protected]>
Co-authored-by: Alex Richert <[email protected]>
Co-authored-by: Fabrice Ardhuin <[email protected]>
Co-authored-by: W. Erick Rogers <[email protected]>
Co-authored-by: Denise Worthen <[email protected]>
Co-authored-by: Camille Teicheira <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MatthewMasarik-NOAA MatthewMasarik-NOAA MatthewMasarik-NOAA approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@edwardhartnett @MatthewMasarik-NOAA