search

E3SM-Project / E3SM

Energy Exascale Earth System Model source code. NOTE: use "maint" branches for your work. Head of master is not validated.
https://docs.e3sm.org/E3SM
Other
332 stars 334 forks source link

MPAS-seaice documentation #6356

Closed eclare108213 closed 1 week ago

eclare108213 commented 4 weeks ago

Creates MPAS-seaice documentation structure within E3SM and adds content.

github-actions[bot] commented 4 weeks ago

PR Preview Action v1.4.7 :---: :rocket: Deployed preview to https://E3SM-Project.github.io/E3SM/pr-preview/pr-6356/ on branch gh-pages at 2024-05-01 00:44 UTC

eclare108213 commented 4 weeks ago

@rljacob ... edited: I need to be more patient, now the docs are rendering....

I'd like to share the rendered docs with others on the sea ice team before I formally submit this PR, so that they can check it and help fill in some missing content.

eclare108213 commented 4 weeks ago

@proteanplanet @darincomeau @njeffery @erinethomas @akturner

These docs are meant to be high-level, no equations or other details, just enough to help people understand the basics and get them started looking in the right places for further information. The docs are currently missing BGC, coupling, a file containing scripts for making CICE-QC plots using MPAS-Analysis, and probably a few odds and ends in other places.

Please take a look at the link https://e3sm-project.github.io/E3SM/pr-preview/pr-6356/ and check the docs for correctness (e.g. I still don't fully understand how Registry and E3SM's namelists interact), make suggestions, etc. To not clutter this PR (and other people's email) too much, I suggest putting discussion in comments at https://acme-climate.atlassian.net/wiki/spaces/ICE/pages/4169596993/Development+of+MPAS-SI+documentation. We need to finish this up and get it in the code soon, for the tutorial. We can add more info later, if needed.

rljacob commented 4 weeks ago

This looks great!

eclare108213 commented 4 weeks ago

@chengzhuzhang, just so you're aware.

chengzhuzhang commented 4 weeks ago

@chengzhuzhang, just so you're aware.

This is great effort. I was wondering about the doc status for MPAS-ice, Thank you for the update!

eclare108213 commented 3 weeks ago

@proteanplanet @njeffery Do either of you want to add text re coupling and BGC, respectively, to this PR? I've marked those sections as "under construction" for now.

mark-petersen commented 2 weeks ago

We would like to have this merge tomorrow morning so we are ready for the tutorial next week. It looks like the only remaining item is @erinethomas's addition above. @eclare108213 if you have time, please add Erin's paragraph. If not, I can do that tonight.

@darincomeau let us know if you have additional comments. Otherwise, please approve.

eclare108213 commented 2 weeks ago

I will work on this later today. There's also a file referred to in the text that needs to be added to the directory.

mark-petersen commented 2 weeks ago

@eclare108213 please change this PR out of draft mode.

mark-petersen commented 2 weeks ago

@eclare108213 are you comfortable with this being merged now?

eclare108213 commented 2 weeks ago

Yes, it's ready to go!