comp_refdoc.tex

CCSM Research Tools: Community Atmosphere Model (CAM)

% $Id: comp_refdoc.tex,v 1.1.6.1 2002/04/24 03:25:27 erik Exp $

\documentclass[]{article}

\usepackage{epsf}
\usepackage{html}
\usepackage[T1]{fontenc}

\textwidth 6.5in
\textheight 8.5in
\addtolength{\oddsidemargin}{-.75in}

\begin{document}

\bodytext{BGCOLOR=white LINK=#083194 VLINK=#21004A}

\begin{titlepage}

\begin{center}
{\Large Earth System Modeling Framework } \\
\vspace{.25in}
{\Large {\bf <Module, Library, Component or Model Name> <Language> Reference}} \\
\vspace{.25in}
{\large {\it Authors}}
\vspace{.5in}
\end{center}

\begin{latexonly}
\vspace{5.5in}
\begin{tabular}{p{5in}p{.9in}}
\hrulefill \\
\noindent {\bf NASA High Performance Computing and Communications Program} \\
\noindent Earth and Space Sciences Project \\
\noindent CAN 00-OES-01 \\
\noindent http://www.esmf.ucar.edu \\
\end{tabular}
\end{latexonly}

\end{titlepage}

\tableofcontents

\newpage
%\section{Synopsis}
\input{comp_syn}

\section{Installation and General Usage}
See the \htmladdnormallink{ESMF User's Guide}{http://www.esmf.ucar.edu/esmf_docs/ESMF_usrdoc/} for installation instructions and a discussion of overall 
usage of the ESMF libraries.

%\section{Architecture}
\input{comp_arch}

\newpage
\section{<Name1> Class}

\subsection{Description}
\input{class_desc}

\subsection{Restrictions}
input{class_rest}

\subsection{Use and Examples}
\input{class_ex} 

\newpage
\section{<Name2> Class} ...

%\section{Glossary}
\input{comp_glos}

%\section{Bibliography}
\bibliography{comp} 
\bibliographystyle{plain}
\addcontentsline{toc}{section}{Bibliography}

\newpage
\setcounter{section}{1}
\renewcommand{\thesection}{\Alph{section}}
\renewcommand{\thesubsection}{\thesection\arabic{subsection}}

\section*{Appendix A:  Fortran Interface}
\addcontentsline{toc}{section}{Appendix A:  Fortran Interface}

%\input{<Name1>}

\newpage
\setcounter{section}{2}
\renewcommand{\thesection}{\Alph{section}}
\renewcommand{\thesubsection}{\thesection\arabic{subsection}}

\section*{Appendix B:  Class Implementations}
\addcontentsline{toc}{section}{Appendix B:  Class Implementations}

\subsection{Public Classes}

%\input{<Name1>}

\subsection{Private Classes}

%\input{<Name2>}

\end{document}