Downloading CESM2 Instructions

Downloading the code & scripts

Starting with CESM2, releases are available through a public GitHub repository.
Earth System Community Modeling Portal CESM repository

Access to the code requires both git and Subversion client software in place that is compatible with GitHub and our Subversion server software. You will need access to the command line clients, git (v1.8 or greater) and svn (v1.8 or greater but less than v1.11). Currently, our Subversion server software is at version 1.8.17. For more information or to download open source tools, visit Subversion and git downloads.

With valid git and svn clients installed on the machine where CESM will be built and run, the user may download the latest development or production release by running one of the following commands:

To download the latest CESM development release:
git clone -b release-cesm2.2.0 https://github.com/ESCOMP/CESM.git my_cesm_sandbox
cd my_cesm_sandbox
To download the latest CESM production release:
git clone -b release-cesm2.1.3 https://github.com/ESCOMP/CESM.git my_cesm_sandbox
cd my_cesm_sandbox

Using a previous version of CESM

* You should use the most recent version of the model that is available unless you are trying to replicate previous results or create a branch run from a previous experiment.

First view the available versions:

git tag --list 'release-cesm2*'

Then to checkout a specific CESM release tag type, for example CESM2.0.1:

git checkout release-cesm2.0.1

To checkout all the individual model components, run the checkout_externals script:

./manage_externals/checkout_externals

The checkout_externals script will read the configuration file called Externals.cfg and will download all the external component models and CIME.

Warning

When contacting the Subversion server for the first time, you may need to accept an authentication certification. If you experience problems such as checkout_externals hanging, run:

svn ls https://svn-ccsm-models.cgd.ucar.edu/ww3/release_tags

Permanently accepting the certificate when prompted, then retry the CESM download starting over at the top of these instructions.


If a problem was encountered during checkout_externals, which may happen with an older version of the svn client software, it may appear to have downloaded successfully, but in fact only a partial checkout has occurred.

Details regarding the CESM checkout process are available in the CESM GitHub repo README , to see more details regarding the checkout_externals script from the command line, type:

./manage_externals/checkout_externals --help

To confirm a successful download of all components, you can run checkout_externals with the status flag to show the status of the externals:

./manage_externals/checkout_externals -S

If there were problems obtaining an external, you might see something like:

e-  ./components/cam

This might happen if there was an unexpected interruption while downloading. First try rerunning ./manage_externals/checkout_externals If there is still a problem, try running with logging turned on:

./manage_externals/checkout_externals --logging

Check the manage_externals.log file to see what errors are reported.

Example below showing a clean status output for all externals after running checkout_externals with the status flag, note there are no characters in the first two columns of output.

Note
Your output may vary depending on which version of CESM you are using
Processing externals description file : Externals.cfg
Processing externals description file : Externals_CLM.cfg
Processing externals description file : Externals_POP.cfg
Processing externals description file : Externals_CISM.cfg
Checking status of externals: clm, fates, ptclm, mosart, ww3, cime, cice, pop, cvmix, marbl, cism, source_cism, rtm, cam,
    ./cime
    ./components/cam
    ./components/cice
    ./components/cism
    ./components/cism/source_cism
    ./components/clm
    ./components/clm/src/fates
    ./components/clm/tools/PTCLM
    ./components/mosart
    ./components/pop
    ./components/pop/externals/CVMix
    ./components/pop/externals/MARBL
    ./components/rtm
    ./components/ww3

You should now have a complete copy of CESM2!

Downloading input data

Input datasets are needed to run the model. CESM input data are available through a separate Subversion input data repository.

Warning

Do not attempt to download the whole input data repository, it is currently over 20 TB

Datasets can be downloaded on a case by case basis as needed and CESM provides tools to check and download input data automatically.

A local input data directory should exist on the local disk, and it also needs to be set in the CESM scripts via the variable $DIN_LOC_ROOT. For supported machines, this variable is preset. For generic machines, this variable is set via the --input-dir argument to create_newcase. It is recommended that all users of a given filesystem share the same $DIN_LOC_ROOT directory.

The files in the subdirectories of $DIN_LOC_ROOT should be write-protected. This prevents these files from being accidentally modified or deleted. The directories in $DIN_LOC_ROOT should generally be group writable, so the directory can be shared among multiple users.

As part of the process of generating the CESM executable, the utility, check_input_data located in each case directory is called, and it attempts to locate all required input data for the case based upon file lists generated by components. If the required data is not found on local disk in $DIN_LOC_ROOT, then the data will be downloaded automatically by the scripts or it can be downloaded by the user by invoking check_input_data with the --download command argument. If you want to download the input data manually you should do it before you build CESM.

It is possible for users to download the data using svn subcommands directly, but use of the check_input_data script is highly recommended to ensure that only the required datasets are downloaded.

For more information: