Skip to content

Conversation

adrifoster
Copy link
Collaborator

@adrifoster adrifoster commented Jun 3, 2025

Description of changes

Fixes broken documentation links in tech note and users guide - WIP

Specific notes

Some links I couldn't find - so we'll need to address those.

CTSM Issues Fixed (include github issue #):

Are answers expected to change (and if so in what way)? No

Any User Interface Changes (namelist or namelist defaults changes)? No

Does this create a need to change or add documentation? Did you do so? Yes

@samsrabin samsrabin linked an issue Jun 3, 2025 that may be closed by this pull request
------------------------------------

For running "I" cases there are several other noteworthy configuration items that you may want to work with. Most of these involve settings for the DATM, but one ``CCSM_CO2_PPMV`` applies to all models. The list of DATM settings is `here <http://esmci.github.io/cime/data_models/data-atm.html>`_. If you are running a B, E, or F case that doesn't use the DATM obviously the DATM_* settings will not be used. All of the settings below are in your ``env_build.xml`` and ``env_run.xml`` files
For running "I" cases there are several other noteworthy configuration items that you may want to work with. Most of these involve settings for the DATM, but one ``CCSM_CO2_PPMV`` applies to all models. The list of DATM settings is (**link currently broken**). If you are running a B, E, or F case that doesn't use the DATM obviously the DATM_* settings will not be used. All of the settings below are in your ``env_build.xml`` and ``env_run.xml`` files
Copy link
Member

Choose a reason for hiding this comment

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

Here's the first snapshot on the Wayback Machine. CIME discussion question here.

Copy link
Member

Choose a reason for hiding this comment

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

I think it may have gone to the CDEPS documentation.

Copy link
Member

@samsrabin samsrabin Jun 4, 2025

Choose a reason for hiding this comment

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

Of course, it's out of date... CRU-JRA doesn't show up anywhere, and there are still references to Cheyenne.

Copy link
Member

Choose a reason for hiding this comment

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

I've filed an issue about updating the CDEPS documentation (#3225). For now, just go ahead and link to the outdated page.

2. **DATM stream files**

The `Data Model Documentation <http://esmci.github.io/cime/data_models/data-atm.html>`_ gives the details of all the options for the data models and for DATM specifically. It goes into detail on all namelist items both for DATM and for DATM streams. So here we won't list ALL of the DATM namelist options, nor go into great details about stream files. But, we will talk about a few of the different options that are relevant for running with CLM. All of the options for changing the namelists or stream files is done by editing the ``user_nl_datm`` file.
The Data Model Documentation (**link currently broken**) gives the details of all the options for the data models and for DATM specifically. It goes into detail on all namelist items both for DATM and for DATM streams. So here we won't list ALL of the DATM namelist options, nor go into great details about stream files. But, we will talk about a few of the different options that are relevant for running with CLM. All of the options for changing the namelists or stream files is done by editing the ``user_nl_datm`` file.
Copy link
Member

Choose a reason for hiding this comment

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

See comment above.

@samsrabin samsrabin added documentation additions or edits to user-facing documentation or its infrastructure bfb bit-for-bit docs:minor-tech-fix Minor technical fix needed to documentation content (e.g. broken link, broken rendering) docs-loc:users-guide Relates to User's Guide (using CTSM/tools) docs-loc:tech-note Relates to Technical Note (science) labels Jun 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bfb bit-for-bit docs:minor-tech-fix Minor technical fix needed to documentation content (e.g. broken link, broken rendering) docs-loc:tech-note Relates to Technical Note (science) docs-loc:users-guide Relates to User's Guide (using CTSM/tools) documentation additions or edits to user-facing documentation or its infrastructure

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken external links in Tech Note and User's Guide

2 participants