/[MITgcm]/manual/s_getstarted/text/getting_started.tex
ViewVC logotype

Diff of /manual/s_getstarted/text/getting_started.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.35 by molod, Thu Apr 20 22:09:08 2006 UTC revision 1.42 by jmc, Fri May 28 02:09:59 2010 UTC
# Line 3  Line 3 
3    
4  %\section{Getting started}  %\section{Getting started}
5    
6  In this section, we describe how to use the model. In the first  We believe the best way to familiarize yourself with the
 section, we provide enough information to help you get started with  
 the model. We believe the best way to familiarize yourself with the  
7  model is to run the case study examples provided with the base  model is to run the case study examples provided with the base
8  version. Information on how to obtain, compile, and run the code is  version. Information on how to obtain, compile, and run the code is
9  found there as well as a brief description of the model structure  found here as well as a brief description of the model structure
10  directory and the case study examples.  The latter and the code  directory and the case study examples. Information is also provided
11  structure are described more fully in chapters  here on how to customize the code when you are ready to try implementing
12  \ref{chap:discretization} and \ref{chap:sarch}, respectively. Here, in  the configuration you have in mind.  The code and algorithm
13  this section, we provide information on how to customize the code when  are described more fully in chapters \ref{chap:discretization} and
14  you are ready to try implementing the configuration you have in mind.  \ref{chap:sarch}.
15    
16  \section{Where to find information}  \section{Where to find information}
17  \label{sect:whereToFindInfo}  \label{sect:whereToFindInfo}
# Line 21  you are ready to try implementing the co Line 19  you are ready to try implementing the co
19  <!-- CMIREDIR:whereToFindInfo: -->  <!-- CMIREDIR:whereToFindInfo: -->
20  \end{rawhtml}  \end{rawhtml}
21    
22  A web site is maintained for release 2 (``Pelican'') of MITgcm:  There is a web-archived support mailing list for the model that
 \begin{rawhtml} <A href=http://mitgcm.org/pelican/ target="idontexist"> \end{rawhtml}  
 \begin{verbatim}  
 http://mitgcm.org/pelican  
 \end{verbatim}  
 \begin{rawhtml} </A> \end{rawhtml}  
 Here you will find an on-line version of this document, a  
 ``browsable'' copy of the code and a searchable database of the model  
 and site, as well as links for downloading the model and  
 documentation, to data-sources, and other related sites.  
   
 There is also a web-archived support mailing list for the model that  
23  you can email at \texttt{MITgcm-support@mitgcm.org} or browse at:  you can email at \texttt{MITgcm-support@mitgcm.org} or browse at:
24  \begin{rawhtml} <A href=http://mitgcm.org/mailman/listinfo/mitgcm-support/ target="idontexist"> \end{rawhtml}  \begin{rawhtml} <A href=http://mitgcm.org/mailman/listinfo/mitgcm-support/ target="idontexist"> \end{rawhtml}
25  \begin{verbatim}  \begin{verbatim}
# Line 40  http://mitgcm.org/mailman/listinfo/mitgc Line 27  http://mitgcm.org/mailman/listinfo/mitgc
27  http://mitgcm.org/pipermail/mitgcm-support/  http://mitgcm.org/pipermail/mitgcm-support/
28  \end{verbatim}  \end{verbatim}
29  \begin{rawhtml} </A> \end{rawhtml}  \begin{rawhtml} </A> \end{rawhtml}
 Essentially all of the MITgcm web pages can be searched using a  
 popular web crawler such as Google or through our own search facility:  
 \begin{rawhtml} <A href=http://mitgcm.org/mailman/htdig/ target="idontexist"> \end{rawhtml}  
 \begin{verbatim}  
 http://mitgcm.org/htdig/  
 \end{verbatim}  
 \begin{rawhtml} </A> \end{rawhtml}  
 %%% http://www.google.com/search?q=hydrostatic+site%3Amitgcm.org  
   
   
30    
31  \section{Obtaining the code}  \section{Obtaining the code}
32  \label{sect:obtainingCode}  \label{sect:obtainingCode}
# Line 125  The MITgcm web site contains further dir Line 102  The MITgcm web site contains further dir
102  code and CVS.  It also contains a web interface to our CVS archive so  code and CVS.  It also contains a web interface to our CVS archive so
103  that one may easily view the state of files, revisions, and other  that one may easily view the state of files, revisions, and other
104  development milestones:  development milestones:
105  \begin{rawhtml} <A href="http://mitgcm.org/download" target="idontexist"> \end{rawhtml}  %\begin{rawhtml} <A href="http://mitgcm.org/download" target="idontexist"> \end{rawhtml}
106    \begin{rawhtml} <A href="http://mitgcm.org/viewvc/MITgcm/MITgcm/" target="idontexist"> \end{rawhtml}
107  \begin{verbatim}  \begin{verbatim}
108  http://mitgcm.org/source_code.html  http://mitgcm.org/source_code.html
109  \end{verbatim}  \end{verbatim}
# Line 162  track of your file versions with respect Line 140  track of your file versions with respect
140  the files in \texttt{CVS}!  You can also use CVS to download code  the files in \texttt{CVS}!  You can also use CVS to download code
141  updates.  More extensive information on using CVS for maintaining  updates.  More extensive information on using CVS for maintaining
142  MITgcm code can be found  MITgcm code can be found
143  \begin{rawhtml} <A href="http://mitgcm.org/usingcvstoget.html" target="idontexist"> \end{rawhtml}  \begin{rawhtml} <A href="http://mitgcm.org/public/using_cvs.html" target="idontexist"> \end{rawhtml}
144  here  here
145  \begin{rawhtml} </A> \end{rawhtml}  \begin{rawhtml} </A> \end{rawhtml}
146  .  .
# Line 175  they create can be changed to a differen Line 153  they create can be changed to a differen
153     %  mv MITgcm MITgcm_verif_basic     %  mv MITgcm MITgcm_verif_basic
154  \end{verbatim}  \end{verbatim}
155    
   
 \subsection{Method 2 - Tar file download}  
 \label{sect:conventionalDownload}  
   
 If you do not have CVS on your system, you can download the model as a  
 tar file from the web site at:  
 \begin{rawhtml} <A href=http://mitgcm.org/download target="idontexist"> \end{rawhtml}  
 \begin{verbatim}  
 http://mitgcm.org/download/  
 \end{verbatim}  
 \begin{rawhtml} </A> \end{rawhtml}  
 The tar file still contains CVS information which we urge you not to  
 delete; even if you do not use CVS yourself the information can help  
 us if you should need to send us your copy of the code.  If a recent  
 tar file does not exist, then please contact the developers through  
 the  
 \begin{rawhtml} <A href="mailto:MITgcm-support@mitgcm.org"> \end{rawhtml}  
 MITgcm-support@mitgcm.org  
 \begin{rawhtml} </A> \end{rawhtml}  
 mailing list.  
   
156  \subsubsection{Upgrading from an earlier version}  \subsubsection{Upgrading from an earlier version}
157    
158  If you already have an earlier version of the code you can ``upgrade''  If you already have an earlier version of the code you can ``upgrade''
# Line 262  that you may only have part of a patch. Line 219  that you may only have part of a patch.
219  also means we can't tell what version of the code you are working  also means we can't tell what version of the code you are working
220  with. So please be sure you understand what you're doing.  with. So please be sure you understand what you're doing.
221    
222    \subsection{Method 2 - Tar file download}
223    \label{sect:conventionalDownload}
224    
225    If you do not have CVS on your system, you can download the model as a
226    tar file from the web site at:
227    \begin{rawhtml} <A href=http://mitgcm.org/download/ target="idontexist"> \end{rawhtml}
228    \begin{verbatim}
229    http://mitgcm.org/download/
230    \end{verbatim}
231    \begin{rawhtml} </A> \end{rawhtml}
232    The tar file still contains CVS information which we urge you not to
233    delete; even if you do not use CVS yourself the information can help
234    us if you should need to send us your copy of the code.  If a recent
235    tar file does not exist, then please contact the developers through
236    the
237    \begin{rawhtml} <A href="mailto:MITgcm-support@mitgcm.org"> \end{rawhtml}
238    MITgcm-support@mitgcm.org
239    \begin{rawhtml} </A> \end{rawhtml}
240    mailing list.
241    
242  \section{Model and directory structure}  \section{Model and directory structure}
243  \begin{rawhtml}  \begin{rawhtml}
244  <!-- CMIREDIR:directory_structure: -->  <!-- CMIREDIR:directory_structure: -->
# Line 286  structure). Line 263  structure).
263    
264  \begin{itemize}  \begin{itemize}
265    
 \item \texttt{bin}: this directory is initially empty. It is the  
   default directory in which to compile the code.  
     
 \item \texttt{diags}: contains the code relative to time-averaged  
   diagnostics. It is subdivided into two subdirectories \texttt{inc}  
   and \texttt{src} that contain include files (\texttt{*.h} files) and  
   Fortran subroutines (\texttt{*.F} files), respectively.  
   
266  \item \texttt{doc}: contains brief documentation notes.  \item \texttt{doc}: contains brief documentation notes.
267        
268  \item \texttt{eesupp}: contains the execution environment source code.  \item \texttt{eesupp}: contains the execution environment source code.
269    Also subdivided into two subdirectories \texttt{inc} and    Also subdivided into two subdirectories \texttt{inc} and
270    \texttt{src}.    \texttt{src}.
271        
 \item \texttt{exe}: this directory is initially empty. It is the  
   default directory in which to execute the code.  
     
272  \item \texttt{model}: this directory contains the main source code.  \item \texttt{model}: this directory contains the main source code.
273    Also subdivided into two subdirectories \texttt{inc} and    Also subdivided into two subdirectories \texttt{inc} and
274    \texttt{src}.    \texttt{src}.
# Line 311  structure). Line 277  structure).
277    package corresponds to a subdirectory. For example, \texttt{gmredi}    package corresponds to a subdirectory. For example, \texttt{gmredi}
278    contains the code related to the Gent-McWilliams/Redi scheme,    contains the code related to the Gent-McWilliams/Redi scheme,
279    \texttt{aim} the code relative to the atmospheric intermediate    \texttt{aim} the code relative to the atmospheric intermediate
280    physics. The packages are described in detail in section 3.    physics. The packages are described in detail in chapter \ref{chap.packagesI}.
281        
282  \item \texttt{tools}: this directory contains various useful tools.  \item \texttt{tools}: this directory contains various useful tools.
283    For example, \texttt{genmake2} is a script written in csh (C-shell)    For example, \texttt{genmake2} is a script written in csh (C-shell)
284    that should be used to generate your makefile. The directory    that should be used to generate your makefile. The directory
285    \texttt{adjoint} contains the makefile specific to the Tangent    \texttt{adjoint} contains the makefile specific to the Tangent
286    linear and Adjoint Compiler (TAMC) that generates the adjoint code.    linear and Adjoint Compiler (TAMC) that generates the adjoint code.
287    The latter is described in details in part V.    The latter is described in detail in part \ref{chap.ecco}.
288      This directory also contains the subdirectory build\_options, which
289      contains the `optfiles' with the compiler options for the different
290      compilers and machines that can run MITgcm.
291        
292  \item \texttt{utils}: this directory contains various utilities. The  \item \texttt{utils}: this directory contains various utilities. The
293    subdirectory \texttt{knudsen2} contains code and a makefile that    subdirectory \texttt{knudsen2} contains code and a makefile that
# Line 327  structure). Line 296  structure).
296    \texttt{matlab} subdirectory contains matlab scripts for reading    \texttt{matlab} subdirectory contains matlab scripts for reading
297    model output directly into matlab. \texttt{scripts} contains C-shell    model output directly into matlab. \texttt{scripts} contains C-shell
298    post-processing scripts for joining processor-based and tiled-based    post-processing scripts for joining processor-based and tiled-based
299    model output.    model output. The subdirectory exch2 contains the code needed for
300      the exch2 package to work with different combinations of domain
301      decompositions.
302        
303  \item \texttt{verification}: this directory contains the model  \item \texttt{verification}: this directory contains the model
304    examples. See section \ref{sect:modelExamples}.    examples. See section \ref{sect:modelExamples}.
305    
306  \end{itemize}  \item \texttt{jobs}: contains sample job scripts for running MITgcm.
   
 \section[MITgcm Example Experiments]{Example experiments}  
 \label{sect:modelExamples}  
 \begin{rawhtml}  
 <!-- CMIREDIR:modelExamples: -->  
 \end{rawhtml}  
   
 %% a set of twenty-four pre-configured numerical experiments  
   
 The full MITgcm distribution comes with more than a dozen  
 pre-configured numerical experiments. Some of these example  
 experiments are tests of individual parts of the model code, but many  
 are fully fledged numerical simulations. A few of the examples are  
 used for tutorial documentation in sections \ref{sect:eg-baro} -  
 \ref{sect:eg-global}.  The other examples follow the same general  
 structure as the tutorial examples. However, they only include brief  
 instructions in a text file called {\it README}.  The examples are  
 located in subdirectories under the directory \texttt{verification}.  
 Each example is briefly described below.  
   
 \subsection{Full list of model examples}  
   
 \begin{enumerate}  
     
 \item \texttt{exp0} - single layer, ocean double gyre (barotropic with  
   free-surface). This experiment is described in detail in section  
   \ref{sect:eg-baro}.  
   
 \item \texttt{exp1} - Four layer, ocean double gyre. This experiment  
   is described in detail in section \ref{sect:eg-baroc}.  
     
 \item \texttt{exp2} - 4x4 degree global ocean simulation with steady  
   climatological forcing. This experiment is described in detail in  
   section \ref{sect:eg-global}.  
     
 \item \texttt{exp4} - Flow over a Gaussian bump in open-water or  
   channel with open boundaries.  
     
 \item \texttt{exp5} - Inhomogenously forced ocean convection in a  
   doubly periodic box.  
   
 \item \texttt{front\_relax} - Relaxation of an ocean thermal front (test for  
 Gent/McWilliams scheme). 2D (Y-Z).  
   
 \item \texttt{internal wave} - Ocean internal wave forced by open  
   boundary conditions.  
     
 \item \texttt{natl\_box} - Eastern subtropical North Atlantic with KPP  
   scheme; 1 month integration  
     
 \item \texttt{hs94.1x64x5} - Zonal averaged atmosphere using Held and  
   Suarez '94 forcing.  
     
 \item \texttt{hs94.128x64x5} - 3D atmosphere dynamics using Held and  
   Suarez '94 forcing.  
     
 \item \texttt{hs94.cs-32x32x5} - 3D atmosphere dynamics using Held and  
   Suarez '94 forcing on the cubed sphere.  
     
 \item \texttt{aim.5l\_zon-ave} - Intermediate Atmospheric physics.  
   Global Zonal Mean configuration, 1x64x5 resolution.  
     
 \item \texttt{aim.5l\_XZ\_Equatorial\_Slice} - Intermediate  
   Atmospheric physics, equatorial Slice configuration.  2D (X-Z).  
     
 \item \texttt{aim.5l\_Equatorial\_Channel} - Intermediate Atmospheric  
   physics. 3D Equatorial Channel configuration.  
     
 \item \texttt{aim.5l\_LatLon} - Intermediate Atmospheric physics.  
   Global configuration, on latitude longitude grid with 128x64x5 grid  
   points ($2.8^\circ$ resolution).  
     
 \item \texttt{adjustment.128x64x1} Barotropic adjustment problem on  
   latitude longitude grid with 128x64 grid points ($2.8^\circ$ resolution).  
     
 \item \texttt{adjustment.cs-32x32x1} Barotropic adjustment problem on  
   cube sphere grid with 32x32 points per face (roughly $2.8^\circ$  
   resolution).  
     
 \item \texttt{advect\_cs} Two-dimensional passive advection test on  
   cube sphere grid.  
     
 \item \texttt{advect\_xy} Two-dimensional (horizontal plane) passive  
   advection test on Cartesian grid.  
307        
308  \item \texttt{advect\_yz} Two-dimensional (vertical plane) passive  \item \texttt{lsopt}: Line search code used for optimization.
   advection test on Cartesian grid.  
309        
310  \item \texttt{carbon} Simple passive tracer experiment. Includes  \item \texttt{optim}: Interface between MITgcm and line search code.
   derivative calculation. Described in detail in section  
   \ref{sect:eg-carbon-ad}.  
   
 \item \texttt{flt\_example} Example of using float package.  
     
 \item \texttt{global\_ocean.90x40x15} Global circulation with GM, flux  
   boundary conditions and poles.  
   
 \item \texttt{global\_ocean\_pressure} Global circulation in pressure  
   coordinate (non-Boussinesq ocean model). Described in detail in  
   section \ref{sect:eg-globalpressure}.  
     
 \item \texttt{solid-body.cs-32x32x1} Solid body rotation test for cube  
   sphere grid.  
   
 \end{enumerate}  
   
 \subsection{Directory structure of model examples}  
   
 Each example directory has the following subdirectories:  
   
 \begin{itemize}  
 \item \texttt{code}: contains the code particular to the example. At a  
   minimum, this directory includes the following files:  
   
   \begin{itemize}  
   \item \texttt{code/packages.conf}: declares the list of packages or  
     package groups to be used.  If not included, the default version  
     is located in \texttt{pkg/pkg\_default}.  Package groups are  
     simply convenient collections of commonly used packages which are  
     defined in \texttt{pkg/pkg\_default}.  Some packages may require  
     other packages or may require their absence (that is, they are  
     incompatible) and these package dependencies are listed in  
     \texttt{pkg/pkg\_depend}.  
   
   \item \texttt{code/CPP\_EEOPTIONS.h}: declares CPP keys relative to  
     the ``execution environment'' part of the code. The default  
     version is located in \texttt{eesupp/inc}.  
     
   \item \texttt{code/CPP\_OPTIONS.h}: declares CPP keys relative to  
     the ``numerical model'' part of the code. The default version is  
     located in \texttt{model/inc}.  
     
   \item \texttt{code/SIZE.h}: declares size of underlying  
     computational grid.  The default version is located in  
     \texttt{model/inc}.  
   \end{itemize}  
311        
   In addition, other include files and subroutines might be present in  
   \texttt{code} depending on the particular experiment. See Section 2  
   for more details.  
     
 \item \texttt{input}: contains the input data files required to run  
   the example. At a minimum, the \texttt{input} directory contains the  
   following files:  
   
   \begin{itemize}  
   \item \texttt{input/data}: this file, written as a namelist,  
     specifies the main parameters for the experiment.  
     
   \item \texttt{input/data.pkg}: contains parameters relative to the  
     packages used in the experiment.  
     
   \item \texttt{input/eedata}: this file contains ``execution  
     environment'' data. At present, this consists of a specification  
     of the number of threads to use in $X$ and $Y$ under multithreaded  
     execution.  
   \end{itemize}  
     
   In addition, you will also find in this directory the forcing and  
   topography files as well as the files describing the initial state  
   of the experiment.  This varies from experiment to experiment. See  
   section 2 for more details.  
   
 \item \texttt{results}: this directory contains the output file  
   \texttt{output.txt} produced by the simulation example. This file is  
   useful for comparison with your own output when you run the  
   experiment.  
312  \end{itemize}  \end{itemize}
313    
 Once you have chosen the example you want to run, you are ready to  
 compile the code.  
   
314  \section[Building MITgcm]{Building the code}  \section[Building MITgcm]{Building the code}
315  \label{sect:buildingCode}  \label{sect:buildingCode}
316  \begin{rawhtml}  \begin{rawhtml}
# Line 714  To compile the code, first use the progr Line 520  To compile the code, first use the progr
520  in the \texttt{tools} directory) to generate a Makefile.  in the \texttt{tools} directory) to generate a Makefile.
521  \texttt{genmake2} is a shell script written to work with all  \texttt{genmake2} is a shell script written to work with all
522  ``sh''--compatible shells including bash v1, bash v2, and Bourne.  ``sh''--compatible shells including bash v1, bash v2, and Bourne.
523  Internally, \texttt{genmake2} determines the locations of needed  %Internally, \texttt{genmake2} determines the locations of needed
524  files, the compiler, compiler options, libraries, and Unix tools.  It  %files, the compiler, compiler options, libraries, and Unix tools.  It
525  relies upon a number of ``optfiles'' located in the  %relies upon a number of ``optfiles'' located in the
526  \texttt{tools/build\_options} directory.  %\texttt{tools/build\_options} directory.
527    \texttt{genmake2} parses information from the following sources:
528    \begin{description}
529    \item[-] a {\em gemake\_local} file if one is found in the current
530      directory
531    \item[-] command-line options
532    \item[-] an "options file" as specified by the command-line option
533      \texttt{--optfile=/PATH/FILENAME}
534    \item[-] a {\em packages.conf} file (if one is found) with the
535      specific list of packages to compile. The search path for
536      file {\em packages.conf} is, first, the current directory and
537      then each of the "MODS" directories in the given order (see below).
538    \end{description}
539    
540    \subsubsection{Optfiles in \texttt{tools/build\_options} directory:}
541    
542  The purpose of the optfiles is to provide all the compilation options  The purpose of the optfiles is to provide all the compilation options
543  for particular ``platforms'' (where ``platform'' roughly means the  for particular ``platforms'' (where ``platform'' roughly means the
# Line 790  for inclusion.  Please send the file to Line 610  for inclusion.  Please send the file to
610  \begin{rawhtml} </A> \end{rawhtml}  \begin{rawhtml} </A> \end{rawhtml}
611  mailing list.  mailing list.
612    
613    \subsubsection{Command-line options:}
614    
615  In addition to the optfiles, \texttt{genmake2} supports a number of  In addition to the optfiles, \texttt{genmake2} supports a number of
616  helpful command-line options.  A complete list of these options can be  helpful command-line options.  A complete list of these options can be
617  obtained from:  obtained from:
# Line 812  The most important command-line options Line 634  The most important command-line options
634    the user's path.  When these three items have been identified,    the user's path.  When these three items have been identified,
635    genmake2 will try to find an optfile that has a matching name.    genmake2 will try to find an optfile that has a matching name.
636        
637  \item[\texttt{--pdefault='PKG1 PKG2 PKG3 ...'}] specifies the default  \item[\texttt{--mods='DIR1 DIR2 DIR3 ...'}] specifies a list of
638    set of packages to be used.  The normal order of precedence for    directories containing ``modifications''.  These directories contain
639    packages is as follows:    files with names that may (or may not) exist in the main MITgcm
640    \begin{enumerate}    source tree but will be overridden by any identically-named sources
641    \item If available, the command line (\texttt{--pdefault}) settings    within the ``MODS'' directories.
642      over-rule any others.    
643      The order of precedence for this "name-hiding" is as follows:
644    \item Next, \texttt{genmake2} will look for a file named    \begin{itemize}
645      ``\texttt{packages.conf}'' in the local directory or in any of the    \item ``MODS'' directories (in the order given)
646      directories specified with the \texttt{--mods} option.    \item Packages either explicitly specified or provided by default
647            (in the order given)
648    \item Finally, if neither of the above are available,    \item Packages included due to package dependencies (in the order
649      \texttt{genmake2} will use the \texttt{/pkg/pkg\_default} file.      that that package dependencies are parsed)
650    \end{enumerate}    \item The "standard dirs" (which may have been specified by the
651        ``-standarddirs'' option)
652      \end{itemize}
653        
654    \item[\texttt{--pgroups=/PATH/FILENAME}] specifies the file
655      where package groups are defined. If not set, the package-groups
656      definition will be read from {\em pkg/pkg\_groups}.
657      It also contains the default list of packages (defined
658      as the group ``{\it default\_pkg\_list}'' which is used
659      when no specific package list ({\em packages.conf})
660      is found in current directory or in any "MODS" directory.
661    
662  \item[\texttt{--pdepend=/PATH/FILENAME}] specifies the dependency file  \item[\texttt{--pdepend=/PATH/FILENAME}] specifies the dependency file
663    used for packages.    used for packages.
664        
# Line 851  The most important command-line options Line 683  The most important command-line options
683    "STAF" compiler.  As with any compilers, it is helpful to have their    "STAF" compiler.  As with any compilers, it is helpful to have their
684    directories listed in your {\tt \$PATH} environment variable.    directories listed in your {\tt \$PATH} environment variable.
685        
 \item[\texttt{--mods='DIR1 DIR2 DIR3 ...'}] specifies a list of  
   directories containing ``modifications''.  These directories contain  
   files with names that may (or may not) exist in the main MITgcm  
   source tree but will be overridden by any identically-named sources  
   within the ``MODS'' directories.  
     
   The order of precedence for this "name-hiding" is as follows:  
   \begin{itemize}  
   \item ``MODS'' directories (in the order given)  
   \item Packages either explicitly specified or provided by default  
     (in the order given)  
   \item Packages included due to package dependencies (in the order  
     that that package dependencies are parsed)  
   \item The "standard dirs" (which may have been specified by the  
     ``-standarddirs'' option)  
   \end{itemize}  
     
686  \item[\texttt{--mpi}] This option enables certain MPI features (using  \item[\texttt{--mpi}] This option enables certain MPI features (using
687    CPP \texttt{\#define}s) within the code and is necessary for MPI    CPP \texttt{\#define}s) within the code and is necessary for MPI
688    builds (see Section \ref{sect:mpi-build}).    builds (see Section \ref{sect:mpi-build}).
# Line 910  The steps for building MITgcm with MPI s Line 725  The steps for building MITgcm with MPI s
725    libraries and put them into an options file as described in Section    libraries and put them into an options file as described in Section
726    \ref{sect:genmake}.  One can start with one of the examples in:    \ref{sect:genmake}.  One can start with one of the examples in:
727    \begin{rawhtml} <A    \begin{rawhtml} <A
728      href="http://mitgcm.org/cgi-bin/viewcvs.cgi/MITgcm/tools/build_options/">      href="http://mitgcm.org/viewvc/MITgcm/MITgcm/tools/build_options/">
729    \end{rawhtml}    \end{rawhtml}
730    \begin{center}    \begin{center}
731      \texttt{MITgcm/tools/build\_options/}      \texttt{MITgcm/tools/build\_options/}
# Line 961  The steps for building MITgcm with MPI s Line 776  The steps for building MITgcm with MPI s
776    library and a job scheduling and queueing system such as PBS,    library and a job scheduling and queueing system such as PBS,
777    LoadLeveller, Condor, or any of a number of similar tools.  A few    LoadLeveller, Condor, or any of a number of similar tools.  A few
778    example scripts (those used for our \begin{rawhtml} <A    example scripts (those used for our \begin{rawhtml} <A
779      href="http://mitgcm.org/testing.html"> \end{rawhtml}regular      href="http://mitgcm.org/public/testing.html"> \end{rawhtml}regular
780    verification runs\begin{rawhtml} </A> \end{rawhtml}) are available    verification runs\begin{rawhtml} </A> \end{rawhtml}) are available
781    at:    at:
782    \begin{rawhtml} <A    \begin{rawhtml} <A
783      href="http://mitgcm.org/cgi-bin/viewcvs.cgi/MITgcm_contrib/test_scripts/">      href="http://mitgcm.org/viewvc/MITgcm/MITgcm/tools/example_scripts/">
784    \end{rawhtml}    \end{rawhtml}
785    {\footnotesize \tt    {\footnotesize \tt
786      http://mitgcm.org/cgi-bin/viewcvs.cgi/MITgcm\_contrib/test\_scripts/ }      http://mitgcm.org/viewvc/MITgcm/MITgcm/tools/example\_scripts/ }
787      \begin{rawhtml} </A> \end{rawhtml}
788      or at:
789      \begin{rawhtml} <A
790        href="http://mitgcm.org/viewvc/MITgcm/MITgcm_contrib/test_scripts/">
791      \end{rawhtml}
792      {\footnotesize \tt
793        http://mitgcm.org/viewvc/MITgcm/MITgcm\_contrib/test\_scripts/ }
794    \begin{rawhtml} </A> \end{rawhtml}    \begin{rawhtml} </A> \end{rawhtml}
795    
796  \end{enumerate}  \end{enumerate}
# Line 1087  as the pickup files but are named differ Line 909  as the pickup files but are named differ
909  used to restart the model but are overwritten every other time they are  used to restart the model but are overwritten every other time they are
910  output to save disk space during long integrations.  output to save disk space during long integrations.
911    
   
   
912  \subsubsection{MNC output files}  \subsubsection{MNC output files}
913    
914  Unlike the \texttt{mdsio} output, the \texttt{mnc}--generated output  Unlike the \texttt{mdsio} output, the \texttt{mnc}--generated output
915  is usually (though not necessarily) placed within a subdirectory with  is usually (though not necessarily) placed within a subdirectory with
916  a name such as \texttt{mnc\_test\_\${DATE}\_\${SEQ}}.  The files  a name such as \texttt{mnc\_test\_\${DATE}\_\${SEQ}}.  
 within this subdirectory are all in the ``self-describing'' netCDF  
 format and can thus be browsed and/or plotted using tools such as:  
 \begin{itemize}  
 \item \texttt{ncdump} is a utility which is typically included  
   with every netCDF install:  
   \begin{rawhtml} <A href="http://www.unidata.ucar.edu/packages/netcdf/"> \end{rawhtml}  
 \begin{verbatim}  
 http://www.unidata.ucar.edu/packages/netcdf/  
 \end{verbatim}  
   \begin{rawhtml} </A> \end{rawhtml} and it converts the netCDF  
   binaries into formatted ASCII text files.  
   
 \item \texttt{ncview} utility is a very convenient and quick way  
   to plot netCDF data and it runs on most OSes:  
   \begin{rawhtml} <A href="http://meteora.ucsd.edu/~pierce/ncview_home_page.html"> \end{rawhtml}  
 \begin{verbatim}  
 http://meteora.ucsd.edu/~pierce/ncview_home_page.html  
 \end{verbatim}  
   \begin{rawhtml} </A> \end{rawhtml}  
     
 \item MatLAB(c) and other common post-processing environments provide  
   various netCDF interfaces including:  
   \begin{rawhtml} <A href="http://mexcdf.sourceforge.net/"> \end{rawhtml}  
 \begin{verbatim}  
 http://mexcdf.sourceforge.net/  
 \end{verbatim}  
   \begin{rawhtml} </A> \end{rawhtml}  
   \begin{rawhtml} <A href="http://woodshole.er.usgs.gov/staffpages/cdenham/public_html/MexCDF/nc4ml5.html"> \end{rawhtml}  
 \begin{verbatim}  
 http://woodshole.er.usgs.gov/staffpages/cdenham/public_html/MexCDF/nc4ml5.html  
 \end{verbatim}  
   \begin{rawhtml} </A> \end{rawhtml}  
 \end{itemize}  
   
917    
918  \subsection{Looking at the output}  \subsection{Looking at the output}
919    
# Line 1163  Some examples of reading and visualizing Line 949  Some examples of reading and visualizing
949  Similar scripts for netCDF output (\texttt{rdmnc.m}) are available and  Similar scripts for netCDF output (\texttt{rdmnc.m}) are available and
950  they are described in Section \ref{sec:pkg:mnc}.  they are described in Section \ref{sec:pkg:mnc}.
951    
952    The MNC output files are all in the ``self-describing'' netCDF
953    format and can thus be browsed and/or plotted using tools such as:
954    \begin{itemize}
955    \item \texttt{ncdump} is a utility which is typically included
956      with every netCDF install:
957      \begin{rawhtml} <A href="http://www.unidata.ucar.edu/packages/netcdf/"> \end{rawhtml}
958    \begin{verbatim}
959    http://www.unidata.ucar.edu/packages/netcdf/
960    \end{verbatim}
961      \begin{rawhtml} </A> \end{rawhtml} and it converts the netCDF
962      binaries into formatted ASCII text files.
963    
964    \item \texttt{ncview} utility is a very convenient and quick way
965      to plot netCDF data and it runs on most OSes:
966      \begin{rawhtml} <A href="http://meteora.ucsd.edu/~pierce/ncview_home_page.html"> \end{rawhtml}
967    \begin{verbatim}
968    http://meteora.ucsd.edu/~pierce/ncview_home_page.html
969    \end{verbatim}
970      \begin{rawhtml} </A> \end{rawhtml}
971      
972    \item MatLAB(c) and other common post-processing environments provide
973      various netCDF interfaces including:
974      \begin{rawhtml} <A href="http://mexcdf.sourceforge.net/"> \end{rawhtml}
975    \begin{verbatim}
976    http://mexcdf.sourceforge.net/
977    \end{verbatim}
978      \begin{rawhtml} </A> \end{rawhtml}
979      \begin{rawhtml} <A href="http://woodshole.er.usgs.gov/staffpages/cdenham/public_html/MexCDF/nc4ml5.html"> \end{rawhtml}
980    \begin{verbatim}
981    http://woodshole.er.usgs.gov/staffpages/cdenham/public_html/MexCDF/nc4ml5.html
982    \end{verbatim}
983      \begin{rawhtml} </A> \end{rawhtml}
984    \end{itemize}
985    

Legend:
Removed from v.1.35  
changed lines
  Added in v.1.42

  ViewVC Help
Powered by ViewVC 1.1.22