readme_phys

CCSM Research Tools: Community Atmosphere Model (CAM)

% $Id: README_PHYS,v 1.1.6.1 2002/04/24 03:25:23 erik Exp $

================================================================================
                                 README_PHYS
================================================================================

This file describes how to create a document that describes the physical  
aspects of a software component using a set of templates.  

The contents of this document will vary widely depending on the component
and so only a shell is included.  Brackets [] indicate that a part is optional.

--------------------------------------------------------------------------------
Part		Template File	    Description
--------------------------------------------------------------------------------
document	<comp>_physdoc.tex  Document shell 

[references]    <comp>.bib          References

--------------------------------------------------------------------------------

To create a physics document, fill in the template file.  In 
<comp>_physdoc.tex, be sure to comment out the \input of any files you aren't 
including and specify the \input filenames of files that you are including.

Build a dvi file from LaTeX documents:

	do_latex <comp> phys

Produce an html version of the documentation:

	do_l2h <comp> phys

The html files are placed in a directory called <comp>_physdoc.

The dvipdf tool can be used to produce a pdf:

	dvipdf <comp>_physdoc.dvi

================================================================================
C. DeLuca ([e-mail])                                      June 15, 2000