Getting started with CTSM in git

Contents

• 1   Getting started with using CTSM in git
  • 1.1   Quick start
  • 1.2   Details on these commands
• 2   Getting started with developing CTSM in git
  • 2.1   Setting up git
  • 2.2   Rerunning checkout_externals

1   Getting started with using CTSM in git

1.1   Quick start

To download and start using CTSM, pointing to the latest release code, execute the following commands:

git clone -b release-clm5.0 https://github.com/ESCOMP/ctsm.git clm5.0
cd clm5.0
./manage_externals/checkout_externals

If you later switch the version you have checked out by running git checkout, be sure to rerun ./manage_externals/checkout_externals in order to obtain the correct versions of the external components.

For further documentation, quick start, diagnostics, model output and references, see

http://www.cesm.ucar.edu/models/cesm2.0/land/

and

https://escomp.github.io/ctsm-docs/

1.2   Details on these commands

The above git clone command will checkout the release-clm5.0 branch (you can confirm this by running git branch from inside the clm5.0 directory). If you'd prefer to use the latest development version, you can leave off -b release-clm5.0; this will give you the master branch by default. The master branch is a good starting point for model development, but generally should not be used for scientific production runs. After cloning the code, you can also run git tag to see a list of available tags that you can check out. However, note that tags prior to clm4_5_18_r273 will not run (they are included only for historical reference).

The checkout_externals command will download the external components needed to build and run CTSM: CIME, MOSART, FATES, etc. For more details on this tool, including instructions for changing the versions of these externals, see the file README_EXTERNALS.rst at the top level of your CTSM directory.

2   Getting started with developing CTSM in git

2.1   Setting up git

First, make sure you have set up your GitHub and git environments, as described in Recommended git setup. If you have used GitHub and git for other projects, it's likely that you've already done everything necessary in this respect.

2.2   Rerunning checkout_externals

Rerun ``checkout_externals`` after (fill this in)