climateclara/cice

Development repository for the CICE sea-ice model

Overview

This repository contains files needed to run versions 6 and higher of the sea ice model CICE, which is now maintained by the CICE Consortium. Versions prior to v6 are found in the CICE-svn-trunk repository.

CICE consists of a top level driver and dynamical core plus the Icepack column physics code, which is included in CICE as a git submodule. Because Icepack is a submodule of CICE, Icepack and CICE development are handled independently with respect to the github repositories even though development and testing may be done together.

Obtaining CICE

If you expect to make any changes to the code, we recommend that you first fork both the CICE and Icepack repositories. Basic instructions for working with CICE and Icepack are found in the Git Workflow Guidance, linked from the wikis in the primary code repositories
https://github.com/CICE-Consortium/CICE/wiki
https://github.com/CICE-Consortium/Icepack/wiki

CICE may be obtained in several different ways: [not yet tested]

1. clone the full repository
   See Git Workflow Guidance
2. check out only a particular branch, version or tag
   In the workflow for step 1 above, substitute
   git clone -b branch_name --single-branch --recursive https://github.com/CICE-Consortium/CICE.git local_directory_name
   or use svn
   svn co https://github.com/CICE-Consortium/CICE/branch_name
   where "branch name" can also be a version name
3. download a tarball for a particular version
   [how]

More information

Detailed and searchable online documentation of CICE can be found at https://cice-consortium.github.io/CICE/. In this documentation, a “Quick Start” subsection is available with instructions for running the model. A “Testing” subsection with instructions for setting up standard tests (e.g. regression, restart) is also available.

In-progress documentation (not yet merged into the main repo): https://duvivier.github.io/CICE/

The wiki pages for each repository contain links to additional information, e.g.

• complete documentation
• larger files such as the gx1 grid, land mask, and forcing files
• testing data

Test results for both CICE and Icepack can be found in the "Test-Results" repository.

The "About-Us" repository includes background and supporting information about the CICE Consortium, including how to interact with it.