Documentation update #4749
Documentation update #4749
Conversation
|
You can preview documentation at https://esmci.github.io/cime/branch/doc_update/html/index.html |
There was a problem hiding this comment.
Should the copyright (2017) be updated? I have made it through the ccs documentation and will cover the SystemTests separately. @jasonb5 thank you for taking this on, it looks great.
|
|
||
| CIME is developed by the | ||
| `E3SM <https://climatemodeling.science.energy.gov/projects/energy-exascale-earth-system-model>`_ and | ||
| `CESM <http://www.cesm.ucar.edu/>`_ projects. |
There was a problem hiding this comment.
The footer of this page contains a copyright dated 2017. Should this be updated?
There was a problem hiding this comment.
also, maybe update:
http://www.cesm.ucar.edu -> https://www.cesm.ucar.edu
doc/source/ccs/index.rst
Outdated
| than computed from the equations. The values received are ignored. These active-model substitutes are called *data models*. | ||
| active | ||
| Solve a complex set of equations to describe the model's behavior. Also called *prognostic* or *full* models. | ||
| These can be full General Circulation Models. Multiple active models might be available (for example POP and MPAS-ocean to represent the global ocean) but only one ocean or atmosphere model at a time can be used in a component set. |
There was a problem hiding this comment.
Can we replace POP with MOM here?
doc/source/ccs/index.rst
Outdated
| **component set** or **compset**: | ||
| stub | ||
| For some configurations, no data model is needed and one instead uses a *stub* version that simply occupies the | ||
| required place in the driver and does not send or receive any data. For example, if you are setting up an aqua-planet case |
There was a problem hiding this comment.
The CESM nuopc driver does not use stub components. They only provide placeholders for the compset name.
There was a problem hiding this comment.
I suppose it's probably best to leave stub here since it's possible for any model to use stub components.
doc/source/ccs/index.rst
Outdated
| @@ -106,95 +101,98 @@ See :ref:`Component Sets<compsets>` for more information. "GLC" originally meant | |||
| S All stub models (for testing only) | |||
There was a problem hiding this comment.
This compset (S) doesn't exist in CESM.
There was a problem hiding this comment.
E3SM still has the S compset, but I suppose thats model specific now. @jgfouca Are you fine with removing references to S compset since it's not exactly CIME specific now?
doc/source/ccs/index.rst
Outdated
| The *machine* is the computer you are using to run CIME and build and run the climate model. It could be a workstation | ||
| Machine and Compilers | ||
| ::::::::::::::::::::: | ||
| The *machine* is the computer you are using to run CIME to build and run the climate model. It could be a workstation | ||
| or a national supercomputer. The exact name of *machine* is typically the UNIX hostname but it could be any string. A machine |
There was a problem hiding this comment.
Is the word 'national' needed here? Any supercomputer will do.
There was a problem hiding this comment.
I'm fine with just having supercomputer.
| This would imply when parsing the compset longname, CIME would need to be able to recognize the string ``_DOCN%FOO_``. | ||
| To enable this, you will need to do the following: | ||
|
|
||
| 1. edit ``$CIMEROOT/src/components/data_comps/docn/cime_config/config_component.xml`` (see the ``FOO`` additions below). |
|
|
||
| .. code-block:: xml | ||
|
|
||
| <entry id="REBUILD_TRIGGER_ATM"> |
There was a problem hiding this comment.
Where did this come from? I don't recall ever having this variable in the model or any component and it's not there now as far as I can tell.
There was a problem hiding this comment.
This was introduced with #4609. The original behavior is the default so you would only be defining this to change it.
| </entry> | ||
|
|
||
| <entry id="CONFIG_CPL_FILE_MODEL_SPECIFIC"> | ||
| <default_value>$CIMEROOT/driver_cpl/cime_config/config_component_$MODEL.xml</default_value> |
There was a problem hiding this comment.
This is pretty much correct, only the example path is wrong.
| @@ -18,6 +24,164 @@ The node has the following contents: | |||
| <schema>$CIMEROOT/cime_config/xml_schemas/config_grids_v2.xsd</schema> | |||
| </entry> | |||
|
|
|||
| Definition | |||
There was a problem hiding this comment.
mostly okay but paths have changed.
| Defining the machine | ||
| ======================== | ||
| Machines | ||
| ================== |
There was a problem hiding this comment.
This is out of date with the latest xml structure and needs to be rewritten.
|
@jedwards4b @jrya7 Thanks for the feedback! I'll make these updates. This is very much still a work in progress, so expect many more changes. |
|
@jasonb5 sounds good, I manage the CESM websites so let me know if any links/pages need to be moved around or edited! |
| Testname syntax | ||
| ================ | ||
| ----------------- | ||
| .. _`Test naming`: | ||
|
|
There was a problem hiding this comment.
On line 48 Grid may also use a complete grid description (or grid longname).
There was a problem hiding this comment.
On line 196. The _N modifier is not available for CESM, use _C instead.
There was a problem hiding this comment.
At line 69 we should add that in addition to these tests provided by CIME a component can provide additional tests that may be specific to that particular component. This can be done by specifying an additional directory in the config_files.xml file variable SYSTEM_TESTS_DIR. By default each component
will be searched for a cime_config/SystemTests subdirectory.
doc/source/tools/index.rst
Outdated
| ect.rst | ||
| mapping-tools.rst | ||
| cprnc.rst | ||
| load-balancing-tool.rst |
There was a problem hiding this comment.
The ect test for cesm3 is still in development and this will need major revision. The load balancing tool has been removed.
There was a problem hiding this comment.
Removed load-balancing-tools.rst and references.
Since ect is CESM specific should this code/documentation be relocated to CESM's docs?
|
@jasonb5 , is this ready to merge? |
|
Is there an online preview of these changes? |
Reorganizes docs and updates content.
Test suite:
Test baseline:
Test namelist changes:
Test status: [bit for bit, roundoff, climate changing]
Fixes [CIME Github issue #]
User interface changes?:
Update gh-pages html (Y/N)?: