search

ufs-community / ufs-weather-model

UFS Weather Model
Other
133 stars 239 forks source link

UFS documentation #1186

Open junwang-noaa opened 2 years ago

gspetro-NOAA commented 2 years ago

@junwang-noaa Can a ufs-v3.0.0 version of the readthedocs site be created in time for the SRW App release? I see that there is a release/public-v3 branch in the GitHub repo but no corresponding RTD docs version. It is fairly simply to activate docs for a branch in RTD; I'm happy to explain if needed.

junwang-noaa commented 2 years ago

Sure. FYI. @jkbk2004 @daniel-hildebrandt are managing the release/public-v3 branch.

DeniseWorthen commented 1 year ago

SRW documentation is currently undergoing development.

Not clear what the interaction between EIB and EPIC is on this project.

gspetro-NOAA commented 1 year ago

@DeniseWorthen @jkbk2004 It turns out that Ligia added me as a maintainer for the WM docs ReadTheDocs (RTD) site a while back. We will likely need someone on the WM side to add a ufs-srw-v2.1.0 tag on the UFS WM repo (corresponding to the WM hash being used in the SRW v2.1.0 release), and then I can go ahead and use that tag to create RTD documentation that pulls the docs from that hash. As to general WM documentation updates, I have a lot of ideas and have started some documentation improvements, but I haven't been able to work on them this Program Increment because EPIC shifted its focus more to SRW/RRFS and some other contractual requirements coming down the line. I'm hopeful I'll be able to get back to the WM docs, but I don't yet know when.

DeniseWorthen commented 1 year ago

@gspetro-NOAA Thanks for the update.