s_getstarted/text/testing.tex

% $Header: /u/u3/gcmpack/manual/part3/testing.tex,v 1.1 2004/01/29 17:36:26 edhill Exp $
% $Name:  $

\section{Testing}
\label{sect:testing}
\label{www:testing}

A script (\texttt{testreport}) for automated testing is included in
the model within the {\em verification} directory.  While intended
mostly for advanced users, the script can be helpful for beginners.

\subsection{Using \texttt{testreport}}

On many systems, the program can be run with the command:
\begin{verbatim}
% cd verification
% ./testreport -ieee
\end{verbatim}
which will do the following:
\begin{enumerate}
\item Locate all ``valid'' test directories.  Here, valid tests are
  defined to be those directories within the current directory (which
  is generally {\em verification}) that contain a subdirectory and
  file with the names {\em results/output.txt}.

\item Then within each valid test:
  \begin{enumerate}
  \item run \texttt{genmake2} to produce a {\em Makefile}
  \item build an executable
  \item run the executable
  \item compare and the output of the executable with the
    contents of certain variables within {\em
      TESTNAME/results/output.txt}
  \item print and, if requested (with the
    \texttt{-addr=EMAIL\_ADDRESS} option), send a MIME-encoded email
    with the testing results
  \end{enumerate}

\end{enumerate}

For further details, please see the MITgcm Developers' HOWTO at:
\begin{rawhtml} <A href=''http://mitgcm.org/docs.html'' target="idontexist"> \end{rawhtml}
\begin{verbatim}
http://mitgcm.org/docs.html
\end{verbatim}
\begin{rawhtml} </A> \end{rawhtml}


\subsection{Automated testing}

Automated testing results are produced on a regular basis and they can
be viewed at:
\begin{rawhtml} <A href=''http://mitgcm.org/testing.html'' target="idontexist"> \end{rawhtml}
\begin{verbatim}
http://mitgcm.org/testing.html
\end{verbatim}
\begin{rawhtml} </A> \end{rawhtml}
which also includes links to various scripts for batch job submission
on a variety of different machines.

1	edhill	1.2	% $Header: /u/u3/gcmpack/manual/part3/testing.tex,v 1.1 2004/01/29 17:36:26 edhill Exp $
2	edhill	1.1	% $Name: $
3
4			\section{Testing}
5			\label{sect:testing}
6			\label{www:testing}
7
8			A script (\texttt{testreport}) for automated testing is included in
9			the model within the {\em verification} directory. While intended
10	edhill	1.2	mostly for advanced users, the script can be helpful for beginners.
11	edhill	1.1
12			\subsection{Using \texttt{testreport}}
13
14	edhill	1.2	On many systems, the program can be run with the command:
15	edhill	1.1	\begin{verbatim}
16			% cd verification
17			% ./testreport -ieee
18			\end{verbatim}
19			which will do the following:
20			\begin{enumerate}
21	edhill	1.2	\item Locate all ``valid'' test directories. Here, valid tests are
22			defined to be those directories within the current directory (which
23			is generally {\em verification}) that contain a subdirectory and
24			file with the names {\em results/output.txt}.
25
26			\item Then within each valid test:
27			\begin{enumerate}
28			\item run \texttt{genmake2} to produce a {\em Makefile}
29			\item build an executable
30			\item run the executable
31			\item compare and the output of the executable with the
32			contents of certain variables within {\em
33			TESTNAME/results/output.txt}
34			\item print and, if requested (with the
35			\texttt{-addr=EMAIL\_ADDRESS} option), send a MIME-encoded email
36			with the testing results
37			\end{enumerate}
38
39	edhill	1.1	\end{enumerate}
40
41	edhill	1.2	For further details, please see the MITgcm Developers' HOWTO at:
42			\begin{rawhtml} <A href=''http://mitgcm.org/docs.html'' target="idontexist"> \end{rawhtml}
43			\begin{verbatim}
44			http://mitgcm.org/docs.html
45			\end{verbatim}
46			\begin{rawhtml} </A> \end{rawhtml}
47	edhill	1.1
48
49			\subsection{Automated testing}
50	edhill	1.2
51			Automated testing results are produced on a regular basis and they can
52			be viewed at:
53			\begin{rawhtml} <A href=''http://mitgcm.org/testing.html'' target="idontexist"> \end{rawhtml}
54			\begin{verbatim}
55			http://mitgcm.org/testing.html
56			\end{verbatim}
57			\begin{rawhtml} </A> \end{rawhtml}
58			which also includes links to various scripts for batch job submission
59			on a variety of different machines.
60	edhill	1.1