Skip to content

Commit

Permalink
more doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jedwards4b committed Jan 24, 2025
1 parent 5ea52ef commit 6c112de
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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') }}
Expand All @@ -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'
Expand Down
7 changes: 4 additions & 3 deletions doc/source/build_cpl/adding-components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 6c112de

Please sign in to comment.