readme_req

CCSM Research Tools: Community Atmosphere Model (CAM)

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

================================================================================
                                 README_REQ
================================================================================

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

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

--------------------------------------------------------------------------------
Part		Template File      Description
--------------------------------------------------------------------------------
document	<comp>_reqdoc.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

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

[references]    <comp>.bib         References

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

To create a new requirements document, fill in the template files.  In 
<comp>_reqdoc.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> req

Produce an html version of the documentation:

	do_l2h <comp> req

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

The dvipdf tool can be used to produce a pdf:

	dvipdf <comp>_reqdoc.dvi


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