Skip to content

Commit

Permalink
add a little
Browse files Browse the repository at this point in the history
  • Loading branch information
jedwards4b committed Jul 14, 2017
1 parent edb2d45 commit 5f9e230
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion doc/source/users_guide/adding-components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ Adding components

Here are the steps to add prognostic components to CIME models.

There are a couple of aspects of a component interface to CIME, the
scripts interface which controls setting up component inputs and
building the component and the run interface which controls connecting
the component to the coupler and through the coupler, the other
components of the CIME based model.

The component should have a subdirectory **cime_config** and this
subdirectory should have two files **buildnml** and **buildlib** The
**buildnml** script is used to build the components instructional,
Expand All @@ -21,4 +27,10 @@ line, it is called in the case.build step and is expected to build the
the buildlib script will be called with three arguments in order they
are caseroot, libroot (the location of the installed library,
typically EXEROOT/lib) and bldroot, the location of the component
build directory.
build directory. Look at the cime internal components such as datm
for an example.

The coupler interface is dependent on which coupler is used, for the mct coupler in cime
the component model must provide NNN_INIT_MCT, NNN_RUN_MCT, NNN_FINAL_MCT where NNN is the
component type of the particular component (eg ATM for an atmosphere, LND for a land model)
these subroutines are expected to be in the component library.

0 comments on commit 5f9e230

Please sign in to comment.