3.2.1 Method 1 - Checkout from CVS

About

Installation

Download

Compilation

Running the model

Customization

Tutorials

Documentation

Browse Code

Next: 3.2.2 Method 2 - Up: 3.2 Obtaining the code Previous: 3.2 Obtaining the code Contents

3.2.1 Method 1 - Checkout from CVS

If CVS is available on your system, we strongly encourage you to use it. CVS provides an efficient and elegant way of organizing your code and keeping track of your changes. If CVS is not available on your machine, you can also download a tar file.

Before you can use CVS, the following environment variable(s) should be set within your shell. For a csh or tcsh shell, put the following

% setenv CVSROOT :pserver:cvsanon@mitgcm.org:/u/gcmpack

in your .cshrc or .tcshrc file. For bash or sh shells, put:

% export CVSROOT=':pserver:cvsanon@mitgcm.org:/u/gcmpack'

in your .profile or .bashrc file.

To get MITgcm through CVS, first register with the MITgcm CVS server using command:

% cvs login ( CVS password: cvsanon )

You only need to do a ``cvs login'' once.

To obtain the latest sources type:

% cvs co MITgcm

or to get a specific release type:

% cvs co -P -r checkpoint52i_post  MITgcm

The MITgcm web site contains further directions concerning the source code and CVS. It also contains a web interface to our CVS archive so that one may easily view the state of files, revisions, and other development milestones:

http://mitgcm.org/source_code.html

As a convenience, the MITgcm CVS server contains aliases which are named subsets of the codebase. These aliases can be especially helpful when used over slow internet connections or on machines with restricted storage space. Table 3.1 contains a list of CVS aliases

Alias Name	Information (directories) Contained
`MITgcm_code`	Only the source code - none of the verification examples.
`MITgcm_verif_basic`	Source code plus a small set of the verification examples (`global_ocean.90x40x15`, `aim.5l_cs`, `hs94.128x64x5`, `front_relax`, and `plume_on_slope`).
`MITgcm_verif_atmos`	Source code plus all of the atmospheric examples.
`MITgcm_verif_ocean`	Source code plus all of the oceanic examples.
`MITgcm_verif_all`	Source code plus all of the verification examples.

The checkout process creates a directory called MITgcm. If the directory MITgcm exists this command updates your code based on the repository. Each directory in the source tree contains a directory CVS. This information is required by CVS to keep track of your file versions with respect to the repository. Don't edit the files in CVS! You can also use CVS to download code updates. More extensive information on using CVS for maintaining MITgcm code can be found here . It is important to note that the CVS aliases in Table 3.1 cannot be used in conjunction with the CVS -d DIRNAME option. However, the MITgcm directories they create can be changed to a different name following the check-out:

   %  cvs co MITgcm_verif_basic
   %  mv MITgcm MITgcm_verif_basic

Next: 3.2.2 Method 2 - Up: 3.2 Obtaining the code Previous: 3.2 Obtaining the code Contents

mitgcm-support@dev.mitgcm.org