/[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.44 by jmc, Mon Aug 30 23:09:20 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{sec:whereToFindInfo}
18  \begin{rawhtml}  \begin{rawhtml}
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{sec:obtainingCode}
33  \begin{rawhtml}  \begin{rawhtml}
34  <!-- CMIREDIR:obtainingCode: -->  <!-- CMIREDIR:obtainingCode: -->
35  \end{rawhtml}  \end{rawhtml}
# Line 86  provide easy support for maintenance upd Line 63  provide easy support for maintenance upd
63  \end{enumerate}  \end{enumerate}
64    
65  \subsection{Method 1 - Checkout from CVS}  \subsection{Method 1 - Checkout from CVS}
66  \label{sect:cvs_checkout}  \label{sec:cvs_checkout}
67    
68  If CVS is available on your system, we strongly encourage you to use it. CVS  If CVS is available on your system, we strongly encourage you to use it. CVS
69  provides an efficient and elegant way of organizing your code and keeping  provides an efficient and elegant way of organizing your code and keeping
# 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/viewvc/MITgcm/MITgcm/" target="idontexist"> \end{rawhtml}
106  \begin{verbatim}  \begin{verbatim}
107  http://mitgcm.org/source_code.html  http://mitgcm.org/viewvc/MITgcm/MITgcm/
108  \end{verbatim}  \end{verbatim}
109  \begin{rawhtml} </A> \end{rawhtml}  \begin{rawhtml} </A> \end{rawhtml}
110    
# Line 162  track of your file versions with respect Line 139  track of your file versions with respect
139  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
140  updates.  More extensive information on using CVS for maintaining  updates.  More extensive information on using CVS for maintaining
141  MITgcm code can be found  MITgcm code can be found
142  \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}
143  here  here
144  \begin{rawhtml} </A> \end{rawhtml}  \begin{rawhtml} </A> \end{rawhtml}
145  .  .
# Line 175  they create can be changed to a differen Line 152  they create can be changed to a differen
152     %  mv MITgcm MITgcm_verif_basic     %  mv MITgcm MITgcm_verif_basic
153  \end{verbatim}  \end{verbatim}
154    
   
 \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.  
   
155  \subsubsection{Upgrading from an earlier version}  \subsubsection{Upgrading from an earlier version}
156    
157  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 218  that you may only have part of a patch.
218  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
219  with. So please be sure you understand what you're doing.  with. So please be sure you understand what you're doing.
220    
221    \subsection{Method 2 - Tar file download}
222    \label{sec:conventionalDownload}
223    
224    If you do not have CVS on your system, you can download the model as a
225    tar file from the web site at:
226    \begin{rawhtml} <A href=http://mitgcm.org/download/ target="idontexist"> \end{rawhtml}
227    \begin{verbatim}
228    http://mitgcm.org/download/
229    \end{verbatim}
230    \begin{rawhtml} </A> \end{rawhtml}
231    The tar file still contains CVS information which we urge you not to
232    delete; even if you do not use CVS yourself the information can help
233    us if you should need to send us your copy of the code.  If a recent
234    tar file does not exist, then please contact the developers through
235    the
236    \begin{rawhtml} <A href="mailto:MITgcm-support@mitgcm.org"> \end{rawhtml}
237    MITgcm-support@mitgcm.org
238    \begin{rawhtml} </A> \end{rawhtml}
239    mailing list.
240    
241  \section{Model and directory structure}  \section{Model and directory structure}
242  \begin{rawhtml}  \begin{rawhtml}
243  <!-- CMIREDIR:directory_structure: -->  <!-- CMIREDIR:directory_structure: -->
# Line 286  structure). Line 262  structure).
262    
263  \begin{itemize}  \begin{itemize}
264    
 \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.  
   
265  \item \texttt{doc}: contains brief documentation notes.  \item \texttt{doc}: contains brief documentation notes.
266        
267  \item \texttt{eesupp}: contains the execution environment source code.  \item \texttt{eesupp}: contains the execution environment source code.
268    Also subdivided into two subdirectories \texttt{inc} and    Also subdivided into two subdirectories \texttt{inc} and
269    \texttt{src}.    \texttt{src}.
270        
 \item \texttt{exe}: this directory is initially empty. It is the  
   default directory in which to execute the code.  
     
271  \item \texttt{model}: this directory contains the main source code.  \item \texttt{model}: this directory contains the main source code.
272    Also subdivided into two subdirectories \texttt{inc} and    Also subdivided into two subdirectories \texttt{inc} and
273    \texttt{src}.    \texttt{src}.
# Line 311  structure). Line 276  structure).
276    package corresponds to a subdirectory. For example, \texttt{gmredi}    package corresponds to a subdirectory. For example, \texttt{gmredi}
277    contains the code related to the Gent-McWilliams/Redi scheme,    contains the code related to the Gent-McWilliams/Redi scheme,
278    \texttt{aim} the code relative to the atmospheric intermediate    \texttt{aim} the code relative to the atmospheric intermediate
279    physics. The packages are described in detail in section 3.    physics. The packages are described in detail in chapter \ref{chap:packagesI}.
280        
281  \item \texttt{tools}: this directory contains various useful tools.  \item \texttt{tools}: this directory contains various useful tools.
282    For example, \texttt{genmake2} is a script written in csh (C-shell)    For example, \texttt{genmake2} is a script written in csh (C-shell)
283    that should be used to generate your makefile. The directory    that should be used to generate your makefile. The directory
284    \texttt{adjoint} contains the makefile specific to the Tangent    \texttt{adjoint} contains the makefile specific to the Tangent
285    linear and Adjoint Compiler (TAMC) that generates the adjoint code.    linear and Adjoint Compiler (TAMC) that generates the adjoint code.
286    The latter is described in details in part V.    The latter is described in detail in part \ref{chap.ecco}.
287      This directory also contains the subdirectory build\_options, which
288      contains the `optfiles' with the compiler options for the different
289      compilers and machines that can run MITgcm.
290        
291  \item \texttt{utils}: this directory contains various utilities. The  \item \texttt{utils}: this directory contains various utilities. The
292    subdirectory \texttt{knudsen2} contains code and a makefile that    subdirectory \texttt{knudsen2} contains code and a makefile that
# Line 327  structure). Line 295  structure).
295    \texttt{matlab} subdirectory contains matlab scripts for reading    \texttt{matlab} subdirectory contains matlab scripts for reading
296    model output directly into matlab. \texttt{scripts} contains C-shell    model output directly into matlab. \texttt{scripts} contains C-shell
297    post-processing scripts for joining processor-based and tiled-based    post-processing scripts for joining processor-based and tiled-based
298    model output.    model output. The subdirectory exch2 contains the code needed for
299      the exch2 package to work with different combinations of domain
300      decompositions.
301        
302  \item \texttt{verification}: this directory contains the model  \item \texttt{verification}: this directory contains the model
303    examples. See section \ref{sect:modelExamples}.    examples. See section \ref{sec:modelExamples}.
   
 \end{itemize}  
   
 \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.  
     
 \item \texttt{advect\_yz} Two-dimensional (vertical plane) passive  
   advection test on Cartesian grid.  
     
 \item \texttt{carbon} Simple passive tracer experiment. Includes  
   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}  
     
   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:  
304    
305    \begin{itemize}  \item \texttt{jobs}: contains sample job scripts for running MITgcm.
   \item \texttt{input/data}: this file, written as a namelist,  
     specifies the main parameters for the experiment.  
306        
307    \item \texttt{input/data.pkg}: contains parameters relative to the  \item \texttt{lsopt}: Line search code used for optimization.
     packages used in the experiment.  
308        
309    \item \texttt{input/eedata}: this file contains ``execution  \item \texttt{optim}: Interface between MITgcm and line search code.
     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}  
310        
   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.  
311  \end{itemize}  \end{itemize}
312    
 Once you have chosen the example you want to run, you are ready to  
 compile the code.  
   
313  \section[Building MITgcm]{Building the code}  \section[Building MITgcm]{Building the code}
314  \label{sect:buildingCode}  \label{sec:buildingCode}
315  \begin{rawhtml}  \begin{rawhtml}
316  <!-- CMIREDIR:buildingCode: -->  <!-- CMIREDIR:buildingCode: -->
317  \end{rawhtml}  \end{rawhtml}
# Line 515  To compile the code, we use the \texttt{ Line 320  To compile the code, we use the \texttt{
320  file (\texttt{Makefile}) that allows us to pre-process source files,  file (\texttt{Makefile}) that allows us to pre-process source files,
321  specify compiler and optimization options and also figures out any  specify compiler and optimization options and also figures out any
322  file dependencies. We supply a script (\texttt{genmake2}), described  file dependencies. We supply a script (\texttt{genmake2}), described
323  in section \ref{sect:genmake}, that automatically creates the  in section \ref{sec:genmake}, that automatically creates the
324  \texttt{Makefile} for you. You then need to build the dependencies and  \texttt{Makefile} for you. You then need to build the dependencies and
325  compile the code.  compile the code.
326    
# Line 590  where the ``2'' can be replaced with a n Line 395  where the ``2'' can be replaced with a n
395  number of CPUs available.  number of CPUs available.
396    
397  Now you are ready to run the model. General instructions for doing so are  Now you are ready to run the model. General instructions for doing so are
398  given in section \ref{sect:runModel}. Here, we can run the model by  given in section \ref{sec:runModel}. Here, we can run the model by
399  first creating links to all the input files:  first creating links to all the input files:
400  \begin{verbatim}  \begin{verbatim}
401  ln -s ../input/* .  ln -s ../input/* .
# Line 604  where we are re-directing the stream of Line 409  where we are re-directing the stream of
409    
410  \subsection{Building/compiling the code elsewhere}  \subsection{Building/compiling the code elsewhere}
411    
412  In the example above (section \ref{sect:buildingCode}) we built the  In the example above (section \ref{sec:buildingCode}) we built the
413  executable in the {\em input} directory of the experiment for  executable in the {\em input} directory of the experiment for
414  convenience. You can also configure and compile the code in other  convenience. You can also configure and compile the code in other
415  locations, for example on a scratch disk with out having to copy the  locations, for example on a scratch disk with out having to copy the
# Line 708  the one experiment: Line 513  the one experiment:
513    
514    
515  \subsection{Using \texttt{genmake2}}  \subsection{Using \texttt{genmake2}}
516  \label{sect:genmake}  \label{sec:genmake}
517    
518  To compile the code, first use the program \texttt{genmake2} (located  To compile the code, first use the program \texttt{genmake2} (located
519  in the \texttt{tools} directory) to generate a Makefile.  in the \texttt{tools} directory) to generate a Makefile.
520  \texttt{genmake2} is a shell script written to work with all  \texttt{genmake2} is a shell script written to work with all
521  ``sh''--compatible shells including bash v1, bash v2, and Bourne.  ``sh''--compatible shells including bash v1, bash v2, and Bourne.
522  Internally, \texttt{genmake2} determines the locations of needed  %Internally, \texttt{genmake2} determines the locations of needed
523  files, the compiler, compiler options, libraries, and Unix tools.  It  %files, the compiler, compiler options, libraries, and Unix tools.  It
524  relies upon a number of ``optfiles'' located in the  %relies upon a number of ``optfiles'' located in the
525  \texttt{tools/build\_options} directory.  %\texttt{tools/build\_options} directory.
526    \texttt{genmake2} parses information from the following sources:
527    \begin{description}
528    \item[-] a {\em gemake\_local} file if one is found in the current
529      directory
530    \item[-] command-line options
531    \item[-] an "options file" as specified by the command-line option
532      \texttt{--optfile=/PATH/FILENAME}
533    \item[-] a {\em packages.conf} file (if one is found) with the
534      specific list of packages to compile. The search path for
535      file {\em packages.conf} is, first, the current directory and
536      then each of the "MODS" directories in the given order (see below).
537    \end{description}
538    
539    \subsubsection{Optfiles in \texttt{tools/build\_options} directory:}
540    
541  The purpose of the optfiles is to provide all the compilation options  The purpose of the optfiles is to provide all the compilation options
542  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 609  for inclusion.  Please send the file to
609  \begin{rawhtml} </A> \end{rawhtml}  \begin{rawhtml} </A> \end{rawhtml}
610  mailing list.  mailing list.
611    
612    \subsubsection{Command-line options:}
613    
614  In addition to the optfiles, \texttt{genmake2} supports a number of  In addition to the optfiles, \texttt{genmake2} supports a number of
615  helpful command-line options.  A complete list of these options can be  helpful command-line options.  A complete list of these options can be
616  obtained from:  obtained from:
# Line 812  The most important command-line options Line 633  The most important command-line options
633    the user's path.  When these three items have been identified,    the user's path.  When these three items have been identified,
634    genmake2 will try to find an optfile that has a matching name.    genmake2 will try to find an optfile that has a matching name.
635        
636  \item[\texttt{--pdefault='PKG1 PKG2 PKG3 ...'}] specifies the default  \item[\texttt{--mods='DIR1 DIR2 DIR3 ...'}] specifies a list of
637    set of packages to be used.  The normal order of precedence for    directories containing ``modifications''.  These directories contain
638    packages is as follows:    files with names that may (or may not) exist in the main MITgcm
639    \begin{enumerate}    source tree but will be overridden by any identically-named sources
640    \item If available, the command line (\texttt{--pdefault}) settings    within the ``MODS'' directories.
641      over-rule any others.    
642      The order of precedence for this "name-hiding" is as follows:
643    \item Next, \texttt{genmake2} will look for a file named    \begin{itemize}
644      ``\texttt{packages.conf}'' in the local directory or in any of the    \item ``MODS'' directories (in the order given)
645      directories specified with the \texttt{--mods} option.    \item Packages either explicitly specified or provided by default
646            (in the order given)
647    \item Finally, if neither of the above are available,    \item Packages included due to package dependencies (in the order
648      \texttt{genmake2} will use the \texttt{/pkg/pkg\_default} file.      that that package dependencies are parsed)
649    \end{enumerate}    \item The "standard dirs" (which may have been specified by the
650        ``-standarddirs'' option)
651      \end{itemize}
652        
653    \item[\texttt{--pgroups=/PATH/FILENAME}] specifies the file
654      where package groups are defined. If not set, the package-groups
655      definition will be read from {\em pkg/pkg\_groups}.
656      It also contains the default list of packages (defined
657      as the group ``{\it default\_pkg\_list}'' which is used
658      when no specific package list ({\em packages.conf})
659      is found in current directory or in any "MODS" directory.
660    
661  \item[\texttt{--pdepend=/PATH/FILENAME}] specifies the dependency file  \item[\texttt{--pdepend=/PATH/FILENAME}] specifies the dependency file
662    used for packages.    used for packages.
663        
# Line 851  The most important command-line options Line 682  The most important command-line options
682    "STAF" compiler.  As with any compilers, it is helpful to have their    "STAF" compiler.  As with any compilers, it is helpful to have their
683    directories listed in your {\tt \$PATH} environment variable.    directories listed in your {\tt \$PATH} environment variable.
684        
 \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}  
     
685  \item[\texttt{--mpi}] This option enables certain MPI features (using  \item[\texttt{--mpi}] This option enables certain MPI features (using
686    CPP \texttt{\#define}s) within the code and is necessary for MPI    CPP \texttt{\#define}s) within the code and is necessary for MPI
687    builds (see Section \ref{sect:mpi-build}).    builds (see Section \ref{sec:mpi-build}).
688        
689  \item[\texttt{--make=/path/to/gmake}] Due to the poor handling of  \item[\texttt{--make=/path/to/gmake}] Due to the poor handling of
690    soft-links and other bugs common with the \texttt{make} versions    soft-links and other bugs common with the \texttt{make} versions
# Line 893  The most important command-line options Line 707  The most important command-line options
707    
708    
709  \subsection{Building with MPI}  \subsection{Building with MPI}
710  \label{sect:mpi-build}  \label{sec:mpi-build}
711    
712  Building MITgcm to use MPI libraries can be complicated due to the  Building MITgcm to use MPI libraries can be complicated due to the
713  variety of different MPI implementations available, their dependencies  variety of different MPI implementations available, their dependencies
# Line 908  The steps for building MITgcm with MPI s Line 722  The steps for building MITgcm with MPI s
722        
723  \item Determine the locations of your MPI-enabled compiler and/or MPI  \item Determine the locations of your MPI-enabled compiler and/or MPI
724    libraries and put them into an options file as described in Section    libraries and put them into an options file as described in Section
725    \ref{sect:genmake}.  One can start with one of the examples in:    \ref{sec:genmake}.  One can start with one of the examples in:
726    \begin{rawhtml} <A    \begin{rawhtml} <A
727      href="http://mitgcm.org/cgi-bin/viewcvs.cgi/MITgcm/tools/build_options/">      href="http://mitgcm.org/viewvc/MITgcm/MITgcm/tools/build_options/">
728    \end{rawhtml}    \end{rawhtml}
729    \begin{center}    \begin{center}
730      \texttt{MITgcm/tools/build\_options/}      \texttt{MITgcm/tools/build\_options/}
# Line 943  The steps for building MITgcm with MPI s Line 757  The steps for building MITgcm with MPI s
757    \end{itemize}    \end{itemize}
758        
759  \item Build the code with the \texttt{genmake2} \texttt{-mpi} option  \item Build the code with the \texttt{genmake2} \texttt{-mpi} option
760    (see Section \ref{sect:genmake}) using commands such as:    (see Section \ref{sec:genmake}) using commands such as:
761  {\footnotesize \begin{verbatim}  {\footnotesize \begin{verbatim}
762    %  ../../../tools/genmake2 -mods=../code -mpi -of=YOUR_OPTFILE    %  ../../../tools/genmake2 -mods=../code -mpi -of=YOUR_OPTFILE
763    %  make depend    %  make depend
# Line 961  The steps for building MITgcm with MPI s Line 775  The steps for building MITgcm with MPI s
775    library and a job scheduling and queueing system such as PBS,    library and a job scheduling and queueing system such as PBS,
776    LoadLeveller, Condor, or any of a number of similar tools.  A few    LoadLeveller, Condor, or any of a number of similar tools.  A few
777    example scripts (those used for our \begin{rawhtml} <A    example scripts (those used for our \begin{rawhtml} <A
778      href="http://mitgcm.org/testing.html"> \end{rawhtml}regular      href="http://mitgcm.org/public/testing.html"> \end{rawhtml}regular
779    verification runs\begin{rawhtml} </A> \end{rawhtml}) are available    verification runs\begin{rawhtml} </A> \end{rawhtml}) are available
780    at:    at:
781    \begin{rawhtml} <A    \begin{rawhtml} <A
782      href="http://mitgcm.org/cgi-bin/viewcvs.cgi/MITgcm_contrib/test_scripts/">      href="http://mitgcm.org/viewvc/MITgcm/MITgcm/tools/example_scripts/">
783    \end{rawhtml}    \end{rawhtml}
784    {\footnotesize \tt    {\footnotesize \tt
785      http://mitgcm.org/cgi-bin/viewcvs.cgi/MITgcm\_contrib/test\_scripts/ }      http://mitgcm.org/viewvc/MITgcm/MITgcm/tools/example\_scripts/ }
786      \begin{rawhtml} </A> \end{rawhtml}
787      or at:
788      \begin{rawhtml} <A
789        href="http://mitgcm.org/viewvc/MITgcm/MITgcm_contrib/test_scripts/">
790      \end{rawhtml}
791      {\footnotesize \tt
792        http://mitgcm.org/viewvc/MITgcm/MITgcm\_contrib/test\_scripts/ }
793    \begin{rawhtml} </A> \end{rawhtml}    \begin{rawhtml} </A> \end{rawhtml}
794    
795  \end{enumerate}  \end{enumerate}
# Line 990  the GNU g77 compiler and the mpich MPI l Line 811  the GNU g77 compiler and the mpich MPI l
811  \end{verbatim} }  \end{verbatim} }
812    
813  \section[Running MITgcm]{Running the model in prognostic mode}  \section[Running MITgcm]{Running the model in prognostic mode}
814  \label{sect:runModel}  \label{sec:runModel}
815  \begin{rawhtml}  \begin{rawhtml}
816  <!-- CMIREDIR:runModel: -->  <!-- CMIREDIR:runModel: -->
817  \end{rawhtml}  \end{rawhtml}
818    
819  If compilation finished succesfully (section \ref{sect:buildingCode})  If compilation finished succesfully (section \ref{sec:buildingCode})
820  then an executable called \texttt{mitgcmuv} will now exist in the  then an executable called \texttt{mitgcmuv} will now exist in the
821  local directory.  local directory.
822    
# Line 1087  as the pickup files but are named differ Line 908  as the pickup files but are named differ
908  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
909  output to save disk space during long integrations.  output to save disk space during long integrations.
910    
   
   
911  \subsubsection{MNC output files}  \subsubsection{MNC output files}
912    
913  Unlike the \texttt{mdsio} output, the \texttt{mnc}--generated output  Unlike the \texttt{mdsio} output, the \texttt{mnc}--generated output
914  is usually (though not necessarily) placed within a subdirectory with  is usually (though not necessarily) placed within a subdirectory with
915  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}  
   
916    
917  \subsection{Looking at the output}  \subsection{Looking at the output}
918    
# Line 1163  Some examples of reading and visualizing Line 948  Some examples of reading and visualizing
948  Similar scripts for netCDF output (\texttt{rdmnc.m}) are available and  Similar scripts for netCDF output (\texttt{rdmnc.m}) are available and
949  they are described in Section \ref{sec:pkg:mnc}.  they are described in Section \ref{sec:pkg:mnc}.
950    
951    The MNC output files are all in the ``self-describing'' netCDF
952    format and can thus be browsed and/or plotted using tools such as:
953    \begin{itemize}
954    \item \texttt{ncdump} is a utility which is typically included
955      with every netCDF install:
956      \begin{rawhtml} <A href="http://www.unidata.ucar.edu/packages/netcdf/"> \end{rawhtml}
957    \begin{verbatim}
958    http://www.unidata.ucar.edu/packages/netcdf/
959    \end{verbatim}
960      \begin{rawhtml} </A> \end{rawhtml} and it converts the netCDF
961      binaries into formatted ASCII text files.
962    
963    \item \texttt{ncview} utility is a very convenient and quick way
964      to plot netCDF data and it runs on most OSes:
965      \begin{rawhtml} <A href="http://meteora.ucsd.edu/~pierce/ncview_home_page.html"> \end{rawhtml}
966    \begin{verbatim}
967    http://meteora.ucsd.edu/~pierce/ncview_home_page.html
968    \end{verbatim}
969      \begin{rawhtml} </A> \end{rawhtml}
970      
971    \item MatLAB(c) and other common post-processing environments provide
972      various netCDF interfaces including:
973      \begin{rawhtml} <A href="http://mexcdf.sourceforge.net/"> \end{rawhtml}
974    \begin{verbatim}
975    http://mexcdf.sourceforge.net/
976    \end{verbatim}
977      \begin{rawhtml} </A> \end{rawhtml}
978      \begin{rawhtml} <A href="http://woodshole.er.usgs.gov/staffpages/cdenham/public_html/MexCDF/nc4ml5.html"> \end{rawhtml}
979    \begin{verbatim}
980    http://woodshole.er.usgs.gov/staffpages/cdenham/public_html/MexCDF/nc4ml5.html
981    \end{verbatim}
982      \begin{rawhtml} </A> \end{rawhtml}
983    \end{itemize}
984    

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

  ViewVC Help
Powered by ViewVC 1.1.22