It is recommended that all CCSM development teams develop code with the help of a robust software configuration management (SCM) tool, such as CVS. The goal is to establish, document, control, and track the evolution of source code and related documentation throughout the software life cycle.
The CCSM Repository Access Policy
web page describes in greater detail the current access policy and
To request access to the CCSM code repository for development, please
see the CCSM Repository, Request for Access
web page. This site contains details about how to request access and
the current restrictions on access.
This section describes the specific procedures that apply to the central CCSM code repository and official releases of CCSM coupled models.
CCSM will maintain one coherent repository of all CCSM model codes at NCAR. This repository will contain a module that enables checkout of the complete system (the coupler and all active and data models).
CVS online documentation
cd /fs/cgd/csm/collections cvs co -d ccsm1\_5\_1 -r ccsm1\_5\_1 ccsm1
All access to the CCSM repository is via goldhill. Either run CVS directly on goldhill or via:
The later allows a user to access the repository on the CVS server on goldhill while logged into another machine.
CVSUMASK and CVSROOT must be set properly before check-in.
setenv CVSROOT /fs/cgd/csm/models/CVS.REPOS setenv CVSUMASK 002
Also set CVSEDITOR if you want to use a different editor when entering your commit log. This editor will also be used when editing the ChangeLog rather than the default X11 widgets (for the modules that manage Change-files).
To list all modules: cvs co -c:
|CVS.SCRIPTS||Scripts for managing the CCSM projects. Miscellaneous tasks such as checking authorization lists, and automatic editing of ChangeLogs when a tag is initiated. (Note: open only to the "cgdcvsadmin" UNIX sub-group, which should be the same as "ccsm-reps")|
|dev_guide||CCSM Developers Guide (this document).|
|ccsm2||The complete CCSM version 1 project. Contains all official CCSM models, run scripts and Makefiles.|
|csm_share||The module of code shared between CCSM components.|
|scripts||CCSM run scripts.|
|versions||ChangeLogs for CCSM and several major CCSM component models.|
|ccm||Community Climate Model. This module also contains the active land surface model "LSM" and "CLM2". Directory structure is modified from "ccsm2". Several submodules also exist.|
|lsm||Active Land Surface Model version 1.|
|lsm2||Active Land Surface Model version 2.|
|clm2||Community Land Model version 2.|
|ccm3lsm_doc||Users-Guide documentation for the CCM and LSM.|
|ccm_unit_testers||Unit-testers for ccm source code.|
|csim4aio||Community Ice Model and Active Ice model. This module also contains the coupler and necessary data models to run the stand-alone ice model. Directory structure modified from "ccsm2".|
|dice5||Data ice model.|
|dlnd5||Data land model.|
|docn5||Data ocean model.|
|latm||"Large" (as in Bill Large) data atmospheric model. Used for running with observational atmospheric datasets rather than model (ie. ccm) datasets.|
|pop||Parallel Ocean Model. Active Ocean model. Several submodules also exist.|
|timing||General set of timing utilities.|
|pilgrim||A generalized set of parallel-decomposition utilities.|
The following modules maintain a set of Change-files: ccsm2, ccm, pop, and csim4aio. In the simplest case there are two files: a ChangeSum and a ChangeLog. These are both kept in the repository for the given component and are accessible from the web. The ChangeSum gives a short one-line synopsis of changes between the current tag and the previous one, while the ChangeLog gives a more detailed description. Some projects also maintain a BranchSum and BranchLog that gives a short or log description of branch tags. These files are maintained outside the repository, but are also web-accessible. POP maintains a LANL_ChangeSum and LANL_ChangeLog kept in the repository to track the changes in LANL versions of POP.
The modules that maintain ChangeLogs use a set of scripts to help make this process easier. These scripts are automatically invoked when a "cvs tag" is invoked. On machines with Perl-Tk installed X11 widgets are used to answer relevant questions. The Change-files are brought up as templates in a simple editor. If the user wants to use a different editor for the Change-files they need to set the CVSEDITOR environment variable to their selected editor.
Major new versions of the CCSM are designated CCSM1.0, CCSM2.0, ... . Significantly new developmental versions are designated CCSM1.1, CCSM1.2, ... . Incremental development versions of the CCSM are designated CCSM2.0-beta01, CCSM2.0-beta02 ... . Development versions represent incremental improvements and developments on the system.
|Module||Tag||Branch Tag||Frozen Branch Tag|
|Note: Only ``ccsm-reps'' can commit changes here.|
|Note: Branches are used extensively and branch names are tracked in a BranchLog. Frozen releases along branch developments are tracked also in a BranchSum.|
|ccsm|| ccsm#_# or ccsm#_#_beta#
ex. ccsm1_5 or ccsm2_0_beta12
|Note: Only the CCSM Coordinator can tag new CCSM versions. Currently we are not allowing global CCSM branches. We may maintain bug-fix branches for major CCSM model releases.|
|Note: Branches are not currently being used, but may be in the future.|
|Note: Only "ccsm-reps" have the ability to commit changes here. Changes should be made on branches first - to allow full testing before incorporating changes on the trunk. Since, "csm_share" is used by all component models both stand-alone and coupled - it's important that changes here be carefully tested and monitored.|
|Note: The main trunk is straight LANL POP. The "ccsm_pop" branches are for local NCAR modifications needed for CCSM releases. Additional branches may be added.|
|Note: Only "ccsm-reps" can commit changes here.|
Notes: Versions with "[a-b] refers to alpha and beta versions of a model release. Versions with #_#_# can also be just two digits (for example ccm3_10) in this case they refer to a major version that has gone through more rigorous testing.