Totally new documentation - #53
Conversation
|
@billsacks @uturuncoglu @DeniseWorthen - using help from Claude - I have totally rewritten the CMEPS documentation. I thought I would start with a PR to NorESMhub first - and then do a clean PR to ESCOMP. Please let me know what you want changed or rephrased. Your feedback would be super appreciated. |
|
@mvertens Thanks for doing this. We were desperately need this but could not find time for it. Let me go through the documentation. I'll update you about it soon. |
|
@uturuncoglu - thank you! Note that the User Guide for now is CESM/NorESM specific (that's stated at the top) - but it would be great to add a UFS specific section(s). Please feel free to suggest any changes - and do a PR to my branch on NorESMhub for now. |
|
@uturuncoglu - I have also added some place holders for UFS in the User's Guide - so it's not longer just CESM/NorESM specific. |
|
@mvertens Perfect. Thanks. I am still reviewing it. I'll push my review until end of this week. |
|
@anton-seaice - adding you to this as well - since this documentation might be valuable for your project and it would be good to possibly your model specific uses? |
Complete rewrite of the CMEPS documentation
With the help of Claude - this PR is a full rewrite and restructuring of the CMEPS Sphinx documentation
into four clearly-scoped parts.
See https://noresmhub.github.io/CMEPS/ to view the new documentation in this PR.
New structure
albedos, land→land-ice downscaling), surface fractions, and conservation.
addfld/addmap/addmrg), conservation math, the phase lifecycle, mapping, merging, fractions, atm/ocn fluxes, ocean albedo, budgets, history,restart, and a walkthrough for adding a coupled field.
Legacy content — migrated, not lost
The old pages were retired after their content was moved into the new structure:
introduction.rstoverview/concepts+developer/conservationesmflds.rstdeveloper/field_exchange+users/fieldsfractions.rstdeveloper/fractionsgeneric.rstdeveloper/code_organizationprep.rstdeveloper/phase_lifecycleaddendum/*reference/*Building the docs
Notes for reviewers