climateclara/icepack

Development repository for sea-ice column physics

Overview

This repository contains files describing the column physics of the sea ice model CICE, which is now maintained by the CICE Consortium. For testing purposes and guidance for including Icepack in other sea ice host models, this repository also includes a driver and basic test suite.

Icepack 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 can be done together.

Obtaining Icepack

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

Icepack 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 https://github.com/CICE-Consortium/Icepack.git local_directory_name
   or use svn
   svn co https://github.com/CICE-Consortium/Icepack/branch_name
   where "branch name" can also be a version name
3. download a tarball for a particular version from the git releases: https://github.com/CICE-Consortium/Icepack/releases

Documentation

Detailed and searchable online documentation of Icepack can be found at https://cice-consortium.github.io/Icepack with the following sections:

• Quick Start, which has instructions for running the model.
• Science guide
• User guide with a Testing subsection with instructions for setting up standard tests (e.g. regression, restart).
• Developer guide with a Documentation subsection with instructions on how to update documentation using Sphinx along with code development.
• Index

Note that the documentation Table of Contents can be accessed at any point by clicking the upper left hand "Icepack x.x.xx documentation" link.

More Information

The Icepack wiki page contains links to additional information, e.g.

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

The Test-Results wiki has test results for both CICE and Icepack.

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

See also our FAQ.