timemgmt_refdoc.tex

CCSM Research Tools: Community Atmosphere Model (CAM)

\documentclass[]{article}
\usepackage{html}
\usepackage[T1]{fontenc}

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

\begin{titlepage}

\begin{latexonly}
\noindent {\bf Community Climate System Model} \\
\noindent National Center for Atmospheric Research, Boulder, CO \\
\vspace{2in}
\end{latexonly}

\begin{center}
{\Large\bf Time Management Library Reference} \\
{\bf Alpha Version} \\
\medskip
{\it Brian Eaton, Cecelia DeLuca}
\end{center}

\end{titlepage}

\tableofcontents

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

%\section{General Usage}
\input{TimeMgmt_usage}

%\section{Architecture}
%\input{TimeMgmt_arch}

\newpage
\section{Time Class}

%\subsection{Description}
\input{Time_desc}

\subsection{Use and Examples}
\input{../../src/LowLevelUtils/TimeMgmt/examples/F90/MFM_TimeEx.F}

\newpage
\section{Date Class}

%\subsection{Description}
\input{Date_desc}

\subsection{Use and Examples}
\input{../../src/LowLevelUtils/TimeMgmt/examples/F90/MFM_DateEx.F}

\newpage
\section{TimeMgr Class}

%\subsection{Description}
\input{TimeMgr_desc}

\subsection{Use and Examples}
\input{../../src/LowLevelUtils/TimeMgmt/examples/F90/MFM_TimeMgrEx.F}

\newpage
\section{Alarm Class}

%\subsection{Description}
\input{Alarm_desc}

\subsection{Use and Examples}
\input{../../src/LowLevelUtils/TimeMgmt/examples/F90/MFM_AlarmEx.F}

\section{Installation}

Currently the following environment variables need to be set:
\begin{verbatim}
  MF_DIR      top-level MF directory
  MF_ARCH     platform and compiler configuration
\end{verbatim}

\noindent The following configurations are supported:

\begin{tabular}{lll}
{\tt MF\_ARCH}     & {\tt alpha}      &  OSF1, Native compilers. \\
                  & {\tt IRIX64}     &  IRIX64, MIPSpro/mpt 64 bit compilers. \\
                  & {\tt IRIX}       &  IRIX64, MIPSpro/mpt n32 abi compilers. \\
                  & {\tt rs6000\_sp}  &  AIX, mpxlf90\_r, mpcc\_r, and mpCC\_r.  \\
                  & {\tt linux\_gnupgf90} & Linux, pgf90, gcc and g++.  \\
                  & {\tt linux\_pgi}  &  Linux, pgf90, pgcc, pgCC. \\
                  & {\tt linux\_lf95} &  Linux, lf95, gcc, g++. \\
                  & {\tt sun}        &  SunOs, SUNWspro compilers. \\
                  & {\tt sun\_hpc}        &  SunOs, SUNWhpc compilers. \\
\end{tabular}

\smallskip

The library requires {\tt gmake} to build.  Simultaneous multiple architecture builds are supported, with
one restriction; the test cases may only be run on one platform at a time. 

\smallskip

\noindent Build the library with the command:
\begin{verbatim}
  gmake BOPT=g  
\end{verbatim}
  for a debug version or
\begin{verbatim}
  gmake BOPT=O  
\end{verbatim}
  for an optimized version.

\noindent To build and run C tests:
\begin{verbatim}
  gmake BOPT=g test_c
\end{verbatim}

\noindent To build and run F90 tests:
\begin{verbatim}
  gmake BOPT=g test_f90
\end{verbatim}

Output files from the test examples will be directed to files 
in {\tt */examples/output} directories. \\

\noindent To build documentation:
\begin{verbatim}
  gmake doc
\end{verbatim}

Please note that in order to run the tests the standard
environment variables for the platform must be set by the user; 
e.g., {\tt MP\_NODES, MP\_TASKS\_PER\_NODE} for an IBM SP.  It's suggested
that the user run the tests as a single task, since output from
multiple tasks running the same test suite currently spills into a single 
file.

To use the library from C/C++, link with the library executable and include
the {\tt ``MF.h''} file.

To use the library from Fortran, link with the library executable and
create links to the library modules {\tt mfm\_timemgmt.mod}
and {\tt mfm\_timemgmttypes.mod} in your build directory.  These are
in the top level {\tt mod} directory under the appropriate architecture.
To include the library in application modules, {\tt USE} the
module {\tt MFM\_TimeMgmt}.  

%\section{Glossary}
\input{TimeMgmt_glos}

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

\setcounter{section}{1}

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

\subsection{MFM\_Time Interface}
\input{MFM_Time}

\subsection{MFM\_Date Interface}
\input{MFM_Date}

\subsection{MFM\_TimeMgr Interface}
\input{MFM_TimeMgr}

\subsection{MFM\_Alarm Interface}
\input{MFM_Alarm}

\end{document}