ufs-community / ufs-weather-model

UFS Weather Model
Other
142 stars 249 forks source link

[develop]: Documentation updates + Submodule pointer update (fv3atm, ccpp-framework) for ccpp-framework PR 600 (bug fix for unit conversion error in ccpp_prebuild.py ) #2464 + Update chunksizes for cubed sphere grid #2465 #2463

Closed gspetro-NOAA closed 1 month ago

gspetro-NOAA commented 1 month ago

Description:

This PR updates to the Input/Output chapter of the documentation to include info on fd_ufs.yaml and to update the land-related sections. This PR also generates documentation from the docstrings in the tests-dev Python scripts. You can view the docs in my fork here: https://gsp-wm.readthedocs.io/en/text-landda/

Commit Message:

* UFSWM - 
  Update LND I/O docs
  Add fd_ufs.yaml docs
  Add tests-dev docs
* UFSWM - Change the default chunking for the cubed sphere history files to use only the horizontal grid size of each of the tiles.
   * FV3 - Change the default chunking for the cubed sphere history files to use only the horizontal grid size of each of the tiles.
   * FV3 - Submodule pointer update for ccpp-framework PR 600 (bug fix for unit conversion error in ccpp_prebuild.py)

Priority:

Git Tracking

UFSWM:

Sub component Pull Requests:

UFSWM Blocking Dependencies:


Changes

Regression Test Changes (Please commit test_changes.list):

Input data Changes:

Library Changes/Upgrades:


Testing Log:

gspetro-NOAA commented 1 month ago

Note that I have toggled on the functionality to build docs for every PR. If you click on "Details" after the docs/readthedocs.org:ufs-weather-model check at the bottom of the PR, you will either see the PR docs, the build progress (if it hasn't completed), or the traceback (if it fails). I believe that after 90 days, the build is deleted, so the docs are not stored indefinitely, but this will ensure that there are no obvious issues with the PR docs.

It is possible to turn on a "warn as error" functionality in the docs that will fail the build check when warnings appear (rather than just failing for errors). Let me know if you'd like me to turn on this functionality. It has the benefit of catching small issues as they occur (such as changes to URLs in the docs), which is helpful for maintenance. However, developers may not like having to fix issues like this that are outside their PR scope, even if they are usually small/simple fixes. That said, I'm happy to work with them to put the fixes into their PR or a subsequent PR if such issues occur.

jkbk2004 commented 1 month ago

@gspetro-NOAA can you sync up branch? I will try to combine in #2465.

jkbk2004 commented 1 month ago

Jobs on Jet are still not moving. Note that baseline is restored and available at /lfs5/HFIP/hfv3gfs/role.epic/RT/NEMSfv3gfs/develop-20241011. We need to skip Jet.

FernandoAndrade-NOAA commented 1 month ago

@jkbk2004 FYI Derecho is having persistent timeout issues with the s2swa_faster_intel compile

jkbk2004 commented 1 month ago

We can start merging process for this pr. We will follow the Derecho issue with https://github.com/ufs-community/ufs-weather-model/issues/2479. @ulmononian @RatkoVasic-NOAA FYI