/[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.4 by adcroft, Mon Oct 15 19:35:11 2001 UTC revision 1.7 by cnh, Sun Oct 21 04:19:40 2001 UTC
# Line 36  A mail to the email list will reach all Line 36  A mail to the email list will reach all
36  on the newsgroup. A users email list will be established at some time  on the newsgroup. A users email list will be established at some time
37  in the future.  in the future.
38    
   
39  \section{Obtaining the code}  \section{Obtaining the code}
40  \label{sect:obtainingCode}  \label{sect:obtainingCode}
41    
42    MITgcm can be downloaded from our system by following
43    the instructions below. As a courtesy we ask that you send e-mail to us at
44    \begin{rawhtml} <A href=mailto:support@mitgcm.org> \end{rawhtml}
45    support@mitgcm.org
46    \begin{rawhtml} </A> \end{rawhtml}
47    to enable us to keep track of who's using the model and in what application.
48    You can download the model two ways:
49    
50    \begin{enumerate}
51    \item Using CVS software. CVS is a freely available source code managment
52    tool. To use CVS you need to have the software installed. Many systems
53    come with CVS pre-installed, otherwise good places to look for
54    the software for a particular platform are
55    \begin{rawhtml} <A href=http://www.cvshome.org/ target="idontexist"> \end{rawhtml}
56    cvshome.org
57    \begin{rawhtml} </A> \end{rawhtml}
58    and
59    \begin{rawhtml} <A href=http://www.wincvs.org/ target="idontexist"> \end{rawhtml}
60    wincvs.org
61    \begin{rawhtml} </A> \end{rawhtml}
62    .
63    
64    \item Using a tar file. This method is simple and does not
65    require any special software. However, this method does not
66    provide easy support for maintenance updates.
67    
68    \end{enumerate}
69    
70  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
71  provides an efficient and elegant way of organizing your code and keeping  provides an efficient and elegant way of organizing your code and keeping
72  track of your changes. If CVS is not available on your machine, you can also  track of your changes. If CVS is not available on your machine, you can also
# Line 49  Before you can use CVS, the following en Line 76  Before you can use CVS, the following en
76  your .cshrc or .tcshrc:  your .cshrc or .tcshrc:
77  \begin{verbatim}  \begin{verbatim}
78  % setenv CVSROOT :pserver:cvsanon@mitgcm.org:/u/u0/gcmpack  % setenv CVSROOT :pserver:cvsanon@mitgcm.org:/u/u0/gcmpack
79    \end{verbatim}
80    
81    To start using CVS, register with the MITgcm CVS server using command:
82    \begin{verbatim}
83  % cvs login ( CVS password: cvsanon )  % cvs login ( CVS password: cvsanon )
84  \end{verbatim}  \end{verbatim}
85    You only need to do ``cvs login'' once.
86    
87  You only need to do ``cvs login'' once. To obtain the source for the release:  To obtain the sources for release1 type:
88  \begin{verbatim}  \begin{verbatim}
89  % cvs co -d directory -P -r release1 MITgcmUV  % cvs co -d directory -P -r release1 MITgcmUV
90  \end{verbatim}  \end{verbatim}
# Line 61  This creates a directory called \textit{ Line 93  This creates a directory called \textit{
93  exists this command updates your code based on the repository. Each  exists this command updates your code based on the repository. Each
94  directory in the source tree contains a directory \textit{CVS}. This  directory in the source tree contains a directory \textit{CVS}. This
95  information is required by CVS to keep track of your file versions with  information is required by CVS to keep track of your file versions with
96  respect to the repository. Don't edit the files in \textit{CVS}! To obtain a  respect to the repository. Don't edit the files in \textit{CVS}!
97  different \textit{version} that is not the latest source:  You can also use CVS to download code updates.  More extensive
98  \begin{verbatim}  information on using CVS for maintaining MITgcm code can be found
99  % cvs co -d directory -P -r version MITgcm  \begin{rawhtml} <A href=http://mitgcm.org/usingcvstoget.html target="idontexist"> \end{rawhtml}
100  \end{verbatim}  here
101  or the latest development version:  \begin{rawhtml} </A> \end{rawhtml}
102  \begin{verbatim}  .
103  % cvs co -d directory -P MITgcm  
 \end{verbatim}  
104    
105  \paragraph*{Conventional download method}  \paragraph*{Conventional download method}
106  \label{sect:conventionalDownload}  \label{sect:conventionalDownload}
107    
108  If you do not have CVS on your system, you can download the model as a  If you do not have CVS on your system, you can download the model as a
109  tar file from the reference web site at:  tar file from the reference web site at:
110    \begin{rawhtml} <A href=http://mitgcm.org/download target="idontexist"> \end{rawhtml}
111  \begin{verbatim}  \begin{verbatim}
112  http://mitgcm.org/download/  http://mitgcm.org/download/
113  \end{verbatim}  \end{verbatim}
114    \begin{rawhtml} </A> \end{rawhtml}
115  The tar file still contains CVS information which we urge you not to  The tar file still contains CVS information which we urge you not to
116  delete; even if you do not use CVS yourself the information can help  delete; even if you do not use CVS yourself the information can help
117  us if you should need to send us your copy of the code.  us if you should need to send us your copy of the code.
# Line 639  relative to the ''numerical model'' part Line 672  relative to the ''numerical model'' part
672  the ''execution environment'' part is covered in the parallel implementation  the ''execution environment'' part is covered in the parallel implementation
673  section) and on the variables and parameters that you are likely to change.  section) and on the variables and parameters that you are likely to change.
674    
675  \subsection{\protect\bigskip Configuration and setup}  \subsection{Configuration and setup}
676    
677  The CPP keys relative to the ''numerical model'' part of the code are all  The CPP keys relative to the ''numerical model'' part of the code are all
678  defined and set in the file \textit{CPP\_OPTIONS.h }in the directory \textit{%  defined and set in the file \textit{CPP\_OPTIONS.h }in the directory \textit{%
Legend:
Removed from v.1.4  
changed lines
  Added in v.1.7
  ViewVC Help
Powered by ViewVC 1.1.22