[develop]: Update python docstrings and generate preliminary technical documentation #1131
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gspetro-NOAA
requested review from
danielabdi-noaa,
mark-a-potts,
jkbk2004,
willmayfield,
dmwright526,
natalie-perlin,
EdwardSnyder-NOAA and
MichaelLueken
as code owners
MichaelLueken
requested changes
Sep 17, 2024
There was a problem hiding this comment.
Thanks for adding a preliminary update to add technical documentation to the majority of the ush and tests/WE2E python scripts! Some of the input arguments and return definitions are lower case instead of capitalized, so I noted the ones that I saw during my initial review. A misspelt documenation was also noted during my review, as well as the modification of run_WE2E_tests.sh to run_WE2E_tests.py (the old shell script was removed after run_WE2E_tests.py was complete).
Co-authored-by: Michael Lueken <63728921+MichaelLueken@users.noreply.github.com>
…app into text/autodoc
MichaelLueken
approved these changes
Sep 18, 2024
There was a problem hiding this comment.
Thank you very much for making my requested changes! This work looks good to me.
The AQM and fundamental tests were run and successfully passed:
----------------------------------------------------------------------------------------------------
Experiment name | Status | Core hours used
----------------------------------------------------------------------------------------------------
aqm_grid_AQM_NA13km_suite_GFS_v16_20240918090657 COMPLETE 7843.59
----------------------------------------------------------------------------------------------------
Total COMPLETE 7843.59
----------------------------------------------------------------------------------------------------
Experiment name | Status | Core hours used
----------------------------------------------------------------------------------------------------
grid_RRFS_CONUScompact_25km_ics_HRRR_lbcs_RAP_suite_RRFS_v1beta_2 COMPLETE 11.81
grid_RRFS_CONUS_25km_ics_FV3GFS_lbcs_FV3GFS_suite_GFS_v15p2_20240 COMPLETE 8.91
grid_RRFS_CONUS_25km_ics_FV3GFS_lbcs_FV3GFS_suite_GFS_v17_p8_plot COMPLETE 25.19
grid_RRFS_CONUScompact_25km_ics_HRRR_lbcs_HRRR_suite_HRRR_2024091 COMPLETE 42.46
grid_SUBCONUS_Ind_3km_ics_HRRR_lbcs_RAP_suite_WoFS_v0_20240918162 COMPLETE 26.63
grid_RRFS_CONUS_25km_ics_NAM_lbcs_NAM_suite_GFS_v16_2024091816270 COMPLETE 45.41
----------------------------------------------------------------------------------------------------
Total COMPLETE 160.41
Approving PR now.
|
Changes look good to me. |
EdwardSnyder-NOAA
approved these changes
Sep 27, 2024
MichaelLueken
added
the
run_we2e_coverage_tests
|
The Jenkins tests successfully passed on Gaea, Hercules, and Orion. The Derecho pipeline was down and the tests on Hera GNU, Hera Intel, and Jet were aborted after running over 8 hours. I'm in the process of running the coverage WE2E tests on these machines now. |
|
Moving into October, the NRAL0032 account is no longer useable. Will run the Derecho coverage tests on Hercules. Hera is down for maintenance. Will update PR with Hera Intel coverage test results. Jet WE2E coverage tests are still running this morning. |
|
The Derecho coverage WE2E tests were run on Hercules and all tests successfully passed: |
|
Both the fundamental and coverage WE2E tests are just sitting in queue on Jet, so I decided to run the Jet WE2E coverage tests on Hera. All tests successfully passed: The Hera Intel WE2E coverage tests have successfully passed: as well as the Hera GNU WE2E coverage tests: Moving forward with merging this work now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DESCRIPTION OF CHANGES:
Initial implementation of SRW App technical documentation. Adds a section called "Technical Documentation" to the SRW App docs.
This PR also removes outdated/redundant text files in
doc(i.e., RUNTIME and INSTALL).Type of change
TESTS CONDUCTED:
Fundamental tests pass on Hera.
DEPENDENCIES:
N/A
DOCUMENTATION:
All documentation
ISSUE:
Resolves Issue #1130
Resolves Issue #340
CHECKLIST