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. |
118 |
|
|
119 |
|
\paragraph*{Upgrading from an earlier version} |
120 |
|
|
121 |
|
If you already have an earlier version of the code you can ``upgrade'' |
122 |
|
your copy instead of downloading the entire repository again. First, |
123 |
|
``cd'' (change directory) to the top of your working copy: |
124 |
|
\begin{verbatim} |
125 |
|
% cd MITgcm |
126 |
|
\end{verbatim} |
127 |
|
and then issue the cvs update command: |
128 |
|
\begin{verbatim} |
129 |
|
% cvs -q update -r release1_beta1 -d -P |
130 |
|
\end{verbatim} |
131 |
|
This will update the ``tag'' to ``release1\_beta1'', add any new |
132 |
|
directories (-d) and remove any empty directories (-P). The -q option |
133 |
|
means be quiet which will reduce the number of messages you'll see in |
134 |
|
the terminal. If you have modified the code prior to upgrading, CVS |
135 |
|
will try to merge your changes with the upgrades. If there is a |
136 |
|
conflict between your modifications and the upgrade, it will report |
137 |
|
that file with a ``C'' in front, e.g.: |
138 |
|
\begin{verbatim} |
139 |
|
C model/src/ini_parms.F |
140 |
|
\end{verbatim} |
141 |
|
If the list of conflicts scrolled off the screen, you can re-issue the |
142 |
|
cvs update command and it will report the conflicts. Conflicts are |
143 |
|
indicated in the code by the delimites ``<<<<<<<'', ``======='' and |
144 |
|
``>>>>>>>''. For example, |
145 |
|
\begin{verbatim} |
146 |
|
<<<<<<< ini_parms.F |
147 |
|
& bottomDragLinear,myOwnBottomDragCoefficient, |
148 |
|
======= |
149 |
|
& bottomDragLinear,bottomDragQuadratic, |
150 |
|
>>>>>>> 1.18 |
151 |
|
\end{verbatim} |
152 |
|
means that you added ``myOwnBottomDragCoefficient'' to a namelist at |
153 |
|
the same time and place that we added ``bottomDragQuadratic''. You |
154 |
|
need to resolve this conflict and in this case the line should be |
155 |
|
changed to: |
156 |
|
\begin{verbatim} |
157 |
|
& bottomDragLinear,bottomDragQuadratic,myOwnBottomDragCoefficient, |
158 |
|
\end{verbatim} |
159 |
|
and the lines with the delimiters (<<<<<<,======,>>>>>>) be deleted. |
160 |
|
Unless you are making modifications which exactly parallel |
161 |
|
developments we make, these types of conflicts should be rare. |
162 |
|
|
163 |
|
\paragraph*{Upgrading to the current pre-release version} |
164 |
|
|
165 |
|
We don't make a ``release'' for every little patch and bug fix in |
166 |
|
order to keep the frequency of upgrades to a minimum. However, if you |
167 |
|
have run into a problem for which ``we have already fixed in the |
168 |
|
latest code'' and we haven't made a ``tag'' or ``release'' since that |
169 |
|
patch then you'll need to get the latest code: |
170 |
|
\begin{verbatim} |
171 |
|
% cvs -q update -A -d -P |
172 |
|
\end{verbatim} |
173 |
|
Unlike, the ``check-out'' and ``update'' procedures above, there is no |
174 |
|
``tag'' or release name. The -A tells CVS to upgrade to the |
175 |
|
very latest version. As a rule, we don't recommend this since you |
176 |
|
might upgrade while we are in the processes of checking in the code so |
177 |
|
that you may only have part of a patch. Using this method of updating |
178 |
|
also means we can't tell what version of the code you are working |
179 |
|
with. So please be sure you understand what you're doing. |
180 |
|
|
181 |
\section{Model and directory structure} |
\section{Model and directory structure} |
182 |
|
|
183 |
The ``numerical'' model is contained within a execution environment support |
The ``numerical'' model is contained within a execution environment |
184 |
wrapper. This wrapper is designed to provide a general framework for |
support wrapper. This wrapper is designed to provide a general |
185 |
grid-point models. MITgcmUV is a specific numerical model that uses the |
framework for grid-point models. MITgcmUV is a specific numerical |
186 |
framework. Under this structure the model is split into execution |
model that uses the framework. Under this structure the model is split |
187 |
environment support code and conventional numerical model code. The |
into execution environment support code and conventional numerical |
188 |
execution environment support code is held under the \textit{eesupp} |
model code. The execution environment support code is held under the |
189 |
directory. The grid point model code is held under the \textit{model} |
\textit{eesupp} directory. The grid point model code is held under the |
190 |
directory. Code execution actually starts in the \textit{eesupp} routines |
\textit{model} directory. Code execution actually starts in the |
191 |
and not in the \textit{model} routines. For this reason the top-level |
\textit{eesupp} routines and not in the \textit{model} routines. For |
192 |
|
this reason the top-level |
193 |
\textit{MAIN.F} is in the \textit{eesupp/src} directory. In general, |
\textit{MAIN.F} is in the \textit{eesupp/src} directory. In general, |
194 |
end-users should not need to worry about this level. The top-level routine |
end-users should not need to worry about this level. The top-level routine |
195 |
for the numerical part of the code is in \textit{model/src/THE\_MODEL\_MAIN.F% |
for the numerical part of the code is in \textit{model/src/THE\_MODEL\_MAIN.F% |