How to Use and Develop GLAST Code using CMT

Getting the Code - Installing, Building and Running the Code - Viewing the Code Documentation 

Developing the Code - Documenting the Code

Here you will find instructions on how to get your hands on and use the GLAST code. Also included are the steps involved in developing code.  It is possible that, by some freakish set of circumstances, the below instructions are not sufficient.  In cases where this applies, check out the Trouble Shooting page.

Getting at the Code Using cvs

You will need to have cvs installed.  For some basic concepts about the utility see cvs.

• You can browse the code via cvsweb 
• You can access the repository directly via cvs - PLEASE NOTE: all the instructions on this page assume that you are using the new cvs repository that resides at SLAC.  If you are not, you should follow the instructions in the preceding link to set cvs up. 

Installing, Building and Running the Code using CMT and VCMT

You will need to have CMT installed.  For some basic concepts about the utility see CMT.

Viewing the Code Documentation

There are several different types of documentation for Glast code.

• Doxygen documentation is available for tagged version of several checkout packages

Developing the Code

Preliminaries

• Before writing or modifying any code, please familiarize yourself with our coding standards.

Routine Operations  

• modifying a package and checking it back into the repository
• creating a new_package
• checking a new package into the repository
• updating the Admin package
• adding an external library

Checking changes to a package

• check cvs_web
• checking the ChangeLog file

Some Not-So-Routine Operations

• modifying the compiler settings

Documenting the Code

There are several aspects to consider vis-a-vis documenting GLAST code

• Please read the Code Recommendations document available from the Documentation Task Force Home Page.
• We are using Doxygen-style commments within the code.  A help page explains the basic Doxygen concepts, as well as certain GLAST conventions.

If all else fails, perhaps a poem (with hints of GLAST software development?) will sooth your soul.

Owner: R.Dubois 

Last Modified by T. Lindner: 08/04/2004 15:42