s_outp_pkgs/text/top_section.tex

% $Header: /u/gcmpack/mitgcmdoc/part7/part7.tex,v 1.3 2001/11/13 15:54:17 adcroft Exp $
% $Name:  $

\chapter{Diagnostics and tools}

There are numerous tools for pre-processing data, converting model
output and analysis written in Matlab, fortran (f77 and f90) and perl.
As yet they remain undocumented although many are self-documenting
(Matlab routines have "help" written into them).

Here we'll summarize what is available but this is an ever growing resource
so this may not cover everything that is out there:

\section{Utilities supplied with the model}

We supply some basic scripts with the model to facilitate conversion or reading
of data into analysis software.

\subsection{utils/scripts}

In the directory {\em utils/scripts} you will find {\em joinds} and {\em joinmds}:
these are perl scripts used from joining the multi-part files created by
MITgcm. {\bf Use {\em joinmds} always}. You will only need {\em joinds} if you
are working with output older than two years (prior to c23).

\subsection{utils/matlab}

In the directory {\em utils/matlab} you will find several Matlab scripts
(.m or dot-em files). The priniciple script is {\em rdmds.m} used for reading
the multi-part model output files in to matlab. Place the scripts in your
matlab path or change the path appropriately, then at the matlab prompt type:
\begin{verbatim}
  >> help rdmds
\end{verbatim}
to get help on how to use rdmds.

Another useful script scans the terminal output file for "monitor" information.

Most other scripts are for working in the curvilinear coordinate systems which
as yet are unpublished and undocumented.

\section{Pre-processing software}

There is a suite of pre-processing software for intepolating bathymetry
and forcing data, written by Adcroft and Biastoch. At some point,
these will be made available for download. If you are in need of such
software, contact one of them.
1	adcroft	1.4	% $Header: /u/gcmpack/mitgcmdoc/part7/part7.tex,v 1.3 2001/11/13 15:54:17 adcroft Exp $
2	cnh	1.2	% $Name: $
3	adcroft	1.1
4	cnh	1.2	\chapter{Diagnostics and tools}
5	adcroft	1.3
6			There are numerous tools for pre-processing data, converting model
7			output and analysis written in Matlab, fortran (f77 and f90) and perl.
8			As yet they remain undocumented although many are self-documenting
9			(Matlab routines have "help" written into them).
10
11			Here we'll summarize what is available but this is an ever growing resource
12			so this may not cover everything that is out there:
13
14			\section{Utilities supplied with the model}
15
16			We supply some basic scripts with the model to facilitate conversion or reading
17			of data into analysis software.
18
19			\subsection{utils/scripts}
20
21	adcroft	1.4	In the directory {\em utils/scripts} you will find {\em joinds} and {\em joinmds}:
22	adcroft	1.3	these are perl scripts used from joining the multi-part files created by
23			MITgcm. {\bf Use {\em joinmds} always}. You will only need {\em joinds} if you
24			are working with output older than two years (prior to c23).
25
26			\subsection{utils/matlab}
27
28			In the directory {\em utils/matlab} you will find several Matlab scripts
29			(.m or dot-em files). The priniciple script is {\em rdmds.m} used for reading
30			the multi-part model output files in to matlab. Place the scripts in your
31			matlab path or change the path appropriately, then at the matlab prompt type:
32			\begin{verbatim}
33			>> help rdmds
34			\end{verbatim}
35			to get help on how to use rdmds.
36
37			Another useful script scans the terminal output file for "monitor" information.
38
39			Most other scripts are for working in the curvilinear coordinate systems which
40			as yet are unpublished and undocumented.
41
42			\section{Pre-processing software}
43
44			There is a suite of pre-processing software for intepolating bathymetry
45			and forcing data, written by Adcroft and Biastoch. At some point,
46			these will be made available for download. If you are in need of such
47			software, contact one of them.