Skip to content

Commit

Permalink
Merge pull request CICE-Consortium#126 from apcraig/docA
Browse files Browse the repository at this point in the history
Update documentation
  • Loading branch information
eclare108213 authored Apr 20, 2018
2 parents 5b375c2 + 7a0793b commit dd265e8
Show file tree
Hide file tree
Showing 24 changed files with 1,833 additions and 3,994 deletions.
6 changes: 0 additions & 6 deletions configuration/scripts/tests/CTest/CTestConfig.cmake

This file was deleted.

6 changes: 0 additions & 6 deletions configuration/scripts/tests/CTest/CTestTestfile.cmake

This file was deleted.

27 changes: 0 additions & 27 deletions configuration/scripts/tests/CTest/gen_ctestfile.csh

This file was deleted.

61 changes: 0 additions & 61 deletions configuration/scripts/tests/CTest/parse_timings.csh

This file was deleted.

81 changes: 0 additions & 81 deletions configuration/scripts/tests/CTest/run_ctest.csh

This file was deleted.

43 changes: 0 additions & 43 deletions configuration/scripts/tests/CTest/steer.cmake

This file was deleted.

4 changes: 2 additions & 2 deletions doc/source/cice_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
Index of primary variables and parameters
==========================================

This index defines many of the symbols used frequently in the ice model
This index defines many of the symbols used frequently in the CICE model
code. Values appearing in this list are fixed or recommended; most
namelist parameters are indicated ( :math:`E_\circ`) with their default
values. For other namelist options, see Section :ref:`tab-namelist`. All
values. For other namelist options, see Section :ref:`tabnamelist`. All
quantities in the code are expressed in MKS units (temperatures may take
either Celsius or Kelvin units).

Expand Down
33 changes: 10 additions & 23 deletions doc/source/developer_guide/dg_about.rst
Original file line number Diff line number Diff line change
@@ -1,31 +1,18 @@
:tocdepth: 3

.. _about_dev:
.. _dev_about:

About Development
==================

The Icepack model consists of three different parts, the column physics
code, the icepack driver, and the scripts. Development of each of these
pieces will be described below separately.
The CICE model consists of four different parts, the CICE dynamics and supporting infrastructure,
the CICE driver code, the Icepack column physics code, and the scripts. Development of each of these
pieces is described separately.

Subroutine calls and other linkages into Icepack from the host model should only
need to access the **icepack\_intfc\*.F90** interface modules within the
``columnphysics/`` directory.
The Icepack driver in the ``configuration/driver/`` directory is based on the CICE
model and provides an example of the sea ice host model capabilities needed for inclusion
of Icepack. In particular, host models will need to include code equivalent to that
in the modules **icedrv\_\*_column.F90**. Calls into the Icepack interface routines
are primarily from **icedrv\_step\_mod.F90** but there are others (search the driver code
for ``intfc``).
Guiding principles for the creation of CICE include the following:
- CICE can be run in stand-alone or coupled modes. A top layer driver, coupling layer,
or model cap can be used to drive the CICE model.
- The Icepack column physics modules are independent, consist of methods that operate
on individual gridcells, and contain so underlying infrastructure. CICE must call
into the Icepack using interfaces and approaches specified by Icepack.

Guiding principles for the creation of Icepack include the following:
- The column physics modules shall be independent of all sea ice model infrastructural
elements that may vary from model to model. Examples include input/output, timers,
references to CPUs or computational tasks, initialization other than that necessary for
strictly physical reasons, and anything related to a horizontal grid.
- The column physics modules shall not call or reference any routines or code that
reside outside of the **columnphysics/** directory.
- Any capabilities required by a host sea ice model (e.g. calendar variables, tracer
flags, diagnostics) shall be implemented in the driver and passed into or out of the
column physics modules via array arguments.
Loading

0 comments on commit dd265e8

Please sign in to comment.