--- mitgcm.org/front_content/using_cvs.xml 2005/09/29 12:17:13 1.9 +++ mitgcm.org/front_content/using_cvs.xml 2015/11/21 16:59:15 1.17 @@ -21,7 +21,7 @@ - +

Obtaining the MITgcm Source using CVS

@@ -34,12 +34,12 @@ mechanism for "committing" or "checking in" changes (please see below). Using CVS pserver from the command line requires just a three commands. Using a Bourne, "bash", or "sh-compatible" shell they are:

- +

   $ export CVSROOT=':pserver:cvsanon@mitgcm.org:/u/gcmpack'
-  $ cvs login 
+  $ cvs login
     ( enter the CVS password: "cvsanon" )
-  $ cvs co MITgcm
+  $ cvs co -P MITgcm

Using a "C", "csh", or "tcsh" shell the commands are:

@@ -48,37 +48,48 @@ $ setenv CVSROOT ':pserver:cvsanon@mitgcm.org:/u/gcmpack' $ cvs login ( enter the CVS password: "cvsanon" ) - $ cvs co MITgcm + $ cvs co -P MITgcm -

A large amount of additional (optional!) content can be obtained from the - MITgcm_contrib directory that can be checked out using: +

using the "-P" option to check-out ("cvs co -P") prevents + to download unnecessary empty directories.

+ +

A large amount of additional (optional!) content is available + from the MITgcm_contrib directory; much of it is specific to certain + setups (eg. high-res setups, in-development material that is not yet part + of the "main" code, etc ...). + But rather than checking out the full content of MITgcm_contrib + ("cvs co -P MITgcm_contrib"), which takes a long time to download + (particularly from remote locations), we recommend to download only the + specific part of interest, e.g.: "submesoscale" directory, + which can be checked out using:

-  $ cvs co MITgcm
+  $ cvs co -P MITgcm_contrib/submesoscale

- In general, we do not recommend checking out all of MITgcm_contrib since - it takes a long time to download (particularly from remote locations) and - much of it is specific to certain setups (eg. high-res setups, - in-development material that is not yet part of the "main" code, - etc.).

Note that you will only need to perform the "cvs login" once. And for convenience, you may want to add the CVSROOT variable to your shell's environment (that is, define it within your "~/.bashrc" or "~/.chsrc" files).

Also note that it is possible to checkout code without "cvs login" and + without setting any shell environment variables by specifying the + pserver name and password in one line, for example:

+ +

+  $ cvs -d :pserver:cvsanon:cvsanon@mitgcm.org:/u/gcmpack co -P MITgcm
+

Getting Parts of the Source "Tree"

The above commands demonstrate how to check out all of the MITgcm code - and the "contributed" (that is, unsupported by occasionally useful) - information within the "MITgcm_contrib" directory. In many cases, this is - overkill and can result in long download times. To reduce the volume of - information downloaded and thereby speedup the download times, one can - select one of the following pre-defined "aliases" that will provide a - sub-set of the entire MITgcm source "tree":

+ and the "contributed" (that is, unsupported but occasionally useful) + information within the "MITgcm_contrib" directory. In many cases, + this is overkill and can result in long download times. + To reduce the volume of information downloaded and thereby speedup the + download times, one can select one of the following pre-defined "aliases" + that will provide a sub-set of the entire MITgcm source "tree":

@@ -93,9 +104,19 @@ - + ("aim.5l_cs", "hs94.128x64x5", "ideal_2D_oce", "lab_sea", + "tutorial_baroclinic_gyre", "tutorial_global_oce_latlon" + and "tutorial_plume_on_slope"). + + + + + + + + + + + CVS Code Browser + , the MITgcm code is continuously undergoing updates. At points during the development (typically, after work has been done and the - source code has passed the verification + source code has passed the verification tests), a release or checkpoint "tag" is created. These tags are a convenient mechanism for referring to different times or points within the development. One can check out these versions using the "-r TAG_NAME" CVS option such as:

-  $ cvs co -r release1_p5 MITgcm
-  $ cvs co -r checkpoint52a_post MITgcm
+  $ cvs co -P -r release1_p5 MITgcm
+  $ cvs co -P -r checkpoint52a_post MITgcm

By default (that is, when no tag is specified), CVS will retrieve the - latest version of all files.

+ latest version of all files. To download an older version corresponding + to a specific time, e.g., May 1rst, 2008, at 5pm, one can use the "-D" + CVS option as follows:

+  $ cvs co -P -D "2008-05-01 17:00" MITgcm
+

Show changes that YOU have made

@@ -217,7 +239,7 @@

"cvs update" produces output to the terminal with the following meanings:

- +

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_tutorials	Source code plus all of the tutorials examples.
MITgcm_verif_all	Source code plus all of the verification examples.

@@ -260,14 +282,11 @@

Wow! CVS is so good, where can I learn more?

The basic - manual is a good reference. There is also an online - tutorial as well as an training - manual. For those who prefer the good old fashioned book there's "Open Source Development With - CVS".

The basic + manual is a good reference. + For those who prefer the good old fashioned book there's + "Open Source Development With CVS".