readme_arch

CCSM Research Tools: Community Atmosphere Model (CAM)

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

================================================================================
                            README_ARCH
================================================================================

This file describes how to create an architecture document using a set of 
templates.

An architecture document has the parts shown in the table below.  Brackets [] 
indicate that a part is optional.  

--------------------------------------------------------------------------------
Part		Template File       Description
--------------------------------------------------------------------------------
document	<comp>_archdoc.tex  Document shell, includes review status

synopsis        <comp>_syn.tex	    Brief description of the software 
                                    function 

[algorithms]    <comp>_alg.tex	    Description of the continuous and discrete
                                    scientific algorithms used in the software    

requirements	<comp>_req.tex	    Scientific and computational requirements

architecture    <comp>_arch.tex     Description of the computational 
                                    architecture, including layering strategy 
                                    and major internal components and classes

[glossary]      <comp>_glos.tex	    Definitions, acronyms, abbreviations

[references]    <comp>.bib          References

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

To create a new architecture document, fill in the template files.  In 
<comp>_archdoc.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> arch

Produce an html version of the documentation:

	do_l2h <comp> arch

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

The dvipdf tool can be used to produce a pdf:

	dvipdf <comp>_archdoc.dvi

================================================================================
C. DeLuca ([e-mail])                                      March 13, 2000