Skip to content

Add emulator guide - #38

Merged
rljacob merged 4 commits into
mainfrom
add-emulator-docs
Nov 14, 2026
Merged

rljacob merged 4 commits into
mainfrom
add-emulator-docs

Conversation

@forsyth2

@forsyth2 forsyth2 commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Add emulator guide to docs.e3sm.org

Remaining action items:

Related pull requests:

  • Add Emulator data e3sm_data_docs#88 was initially for adding emulator output data to E3SM Data Docs, but some of the conversation thread there relates to this PR (i.e., adding an emulator guide).

@forsyth2 forsyth2 added the documentation Improvements or additions to documentation label Nov 5, 2026
@github-actions

github-actions Bot commented Nov 5, 2026 •

Copy link
Copy Markdown
PR Preview Action v1.8.2

QR code for preview link

🚀 View preview at
https://E3SM-Project.github.io/pr-preview/pr-38/

Built to branch gh-pages at 2026-11-09 01:37 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Comment thread docs/emulators/index.md Resolved
Comment thread docs/index.md Resolved
Add a short landing page covering how emulators differ from running
E3SM and what is usually needed to use them, plus a small page for each
emulator, listed from oldest to newest, that points to its paper,
release, and documentation.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mahf708
mahf708 marked this pull request as ready for review November 5, 2026 17:03
@mahf708
mahf708 requested a review from rljacob November 5, 2026 17:03
Comment thread docs/emulators/index.md Resolved

@rljacob rljacob left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great info and the right place for it.

Comment thread docs/emulators/ace-climsst-eamv2.md Resolved
mahf708 and others added 2 commits November 8, 2026 20:35
Address review feedback: the opening sentence now describes only the
emulators listed here rather than defining emulators in general, and a
new sentence says the pages cover running the emulators standalone,
outside of E3SM.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Address review feedback asking for an architecture bullet. Each
emulator page now lists its network architecture and the grid it runs
on, and the descriptions no longer repeat the grid.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Comment thread mkdocs.yaml
Comment on lines +8 to +12
- 'emulators/index.md'
- 'ACE-climSST-EAMv2' : 'emulators/ace-climsst-eamv2.md'
- 'ACE2-EAMv3' : 'emulators/ace2-eamv3.md'
- 'SamudrACE-E3SMv3' : 'emulators/samudrace-e3smv3.md'
- 'STRATA' : 'emulators/strata.md'

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not entirely sure the sidebar supports sub-bullets. There are currently none on https://docs.e3sm.org/.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://docs.e3sm.org/E3SM/EAM/ for example shows sub-bullet points, but only after clicking on EAM. Indeed, if we look at https://raw.githubusercontent.com/E3SM-Project/E3SM/refs/heads/master/docs/index.md, that doesn't have any nested lists either.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh actually I see the preview now: https://docs.e3sm.org/pr-preview/pr-38/. Ok, it looks like it renders just fine.

@rljacob
rljacob merged commit cf91b37 into main Nov 14, 2026
2 checks passed
@rljacob
rljacob deleted the add-emulator-docs branch November 14, 2026 02:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants