Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: update docs for cesm3 #4740

Closed
wants to merge 5 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
more doc updates
jedwards4b committed Jan 24, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 6c112de3a59de7505224f426621c4724a49fbabe
10 changes: 5 additions & 5 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -25,7 +25,7 @@ jobs:
runs-on: ubuntu-latest
if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
ref: 'gh-pages'
fetch-depth: 0
@@ -64,17 +64,17 @@ jobs:
name: Build and deploy documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 0
lfs: true
- name: Install python 3.x
uses: actions/setup-python@v2
uses: actions/setup-python@v5
with:
python-version: '3.x'
# https://github.com/actions/cache/blob/main/examples.md#python---pip
- name: Cache pip
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('doc/requirements.txt') }}
@@ -91,7 +91,7 @@ jobs:
if: |
github.event_name == 'pull_request' &&
github.event.pull_request.head.repo.full_name == github.repository
uses: peaceiris/actions-gh-pages@v3
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{secrets.GITHUB_TOKEN}}
publish_dir: './_build/html'
7 changes: 4 additions & 3 deletions doc/source/build_cpl/adding-components.rst
Original file line number Diff line number Diff line change
@@ -79,10 +79,11 @@ Each component model requires a dedicated directory under the ``components/`` di

CIME requires each component model to adhere to a standard interface for communication with the coupler. Implement the following:

1. **Component-Specific Interface File:**
Each component is required to have a file named ``<class>_comp_nuopc.F90``, where ``<class>`` specifies the component type (e.g., ``atm``, ``lnd``, ``ice``, ``rof``, ``glc``, ``wav``, ``cpl``, ``esp``). This file must define a public routine ``SetServices`` that sets pointers to the model's phase routines (``initialize``, ``run``, and ``finalize``).
1. **Component-Specific Interface File:** Each component is required to have a file named <class>_comp_<driver>.F90, where <class> specifies the component type (e.g., atm, lnd, ice, rof, glc, wav, cpl, esp) and driver specifies the model driver (nuopc or mct). For nuopc this file must define a public routine SetServices that sets pointers to the model's phase routines, for mct the phase routine names (initialize, run, and finalize) are assumed and must be present.

CESM uses the NUOPC (National Unified Operational Prediction Capability) system as the underlying framework for component interaction. For detailed guidance on implementing and configuring the NUOPC-based interfaces, refer to the `NUOPC Layer Documentation <https://www.earthsystemcog.org/projects/nuopc>`_.
CESM uses the NUOPC (National Unified Operational Prediction Capability) system as the underlying framework for component interaction. For detailed guidance on implementing and configuring the NUOPC-based interfaces, refer to the NUOPC Layer Documentation <https://www.earthsystemcog.org/projects/nuopc>_.

E3SM uses the MCT (Model Coupling Toolkit) system as the framework.   Detailed guidance on implementing and configuring the MCT-based interfaces can be found in <https://www.mcs.anl.gov/research/projects/mct/mct_APIs.pdf>_.

2. **Initialize the Component:**
Include an initialization routine (``<model_name>_init``) that defines initial conditions and grid mappings.