:tocdepth: 3


.. _quickstart:

Quick Start
===========

Clone the model from the CICE-Consortium repository::

  git clone --recurse-submodules https://github.com/CICE-Consortium/CICE

Instructions for working with Git and GitHub with CICE (and Icepack) can be
found in the `CICE Git Workflow Guide <https://github.com/CICE-Consortium/About-Us/wiki/Git-Workflow-Guide>`_.

You will probably have to download some input data, see the `CICE wiki <https://github.com/cice-consortium/CICE/wiki>`_ or :ref:`force`.

Software requirements are noted in this :ref:`software` section.

Porting information can be found in the :ref:`porting` section.  A special porting section for personal computers 
is in the :ref:`laptops` section.

From your main CICE directory, execute::

  ./cice.setup -c ~/mycase1 -g gx3 -m testmachine -s diag1,thread -p 8x1
  cd ~/mycase1
  ./cice.build
  ./cice.submit

``testmachine`` is a generic machine name included with the cice scripts.
The local machine name will have to be substituted for ``testmachine`` and
there are working ports for several different machines.  If you need to
port, see the :ref:`porting` section as noted above.
:ref:`scripts` provides more information about 
how to use the cice.setup and cice.submit scripts.

Please cite any use of the CICE code. More information can be found at :ref:`citing`.