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
336 stars 338 forks source link

Add documentation for running coupled e3sm #6391

Closed wlin7 closed 1 month ago

wlin7 commented 1 month ago

User's guide for running coupled E3SM are added.

rljacob commented 1 month ago

@wlin7 can you redo this on latest master? I've added a "docs/user-guide" subdir and index.md file for this kind of material.

wlin7 commented 1 month ago

@wlin7 can you redo this on latest master? I've added a "docs/user-guide" subdir and index.md file for this kind of material.

Will do, @rljacob . Can I ask a question? I intend to use relative URL path to refer to the EAM and ELM docs. If for example from within docs/user-guide to refer to EAM's index.md, is ../../EAM/index.md the proper path?

wlin7 commented 1 month ago

With #6374 in as the top level guide, the most essential content of this PR (coupled compsets and grids) are covered. The remaining part is mainly SSP forcing data, which I will do later.

@rljacob ,do you think we can add the three SSP compsets as supported by the current version? #6335 expected to be merged to master no later than Monday (delayed as needing to restore config options for the CO2 compsets, the fix has been remerged to next)

rljacob commented 1 month ago

Yes go ahead.

github-actions[bot] commented 1 month ago

PR Preview Action v1.4.7 :---: :rocket: Deployed preview to https://E3SM-Project.github.io/E3SM/pr-preview/pr-6391/ on branch gh-pages at 2024-05-03 16:27 UTC

wlin7 commented 1 month ago

Not to merge this PR as it. Just to note that after replacing the relative path with the rendered full URLs to EAM and ELM docs, the preview now looks as expected. Thanks @mahf708 .

rljacob commented 1 month ago

When you redo this, change "E3SM Basics" to "Coupled E3SM" That is a better title for that section to distinguish it from the component sections.

EDIT: No leave it as "E3SM Basics". It cover's general running of the model which are relevant to F-cases too.

rljacob commented 1 month ago

Also your description of the compsets is better then my table of components (which is repetitive) so switch to that as well.

rljacob commented 1 month ago

Replaced by #6392