source: trunk/SRC/Documentation/xmldoc/getsaxo.html @ 144

Last change on this file since 144 was 144, checked in by pinsard, 18 years ago

add files for xxx documentation see mini_notice.html​
  • Property svn:keywords set to Id
File size: 18.7 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<meta name="generator" content=
5"HTML Tidy for Mac OS X (vers 1 September 2005), see www.w3.org">
6<meta http-equiv="Content-Type" content=
7"text/html; charset=us-ascii">
8<title>Get SAXO</title>
9<link rel="stylesheet" href="style.css" type="text/css">
10<link rel="stylesheet" href="saxo.css" type="text/css">
11<meta name="generator" content="DocBook XSL Stylesheets V1.70.1">
12<meta name="keywords" content="idl, SAXO">
13</head>
14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084"
15alink="#0000FF">
16<div class="article" lang="en">
17<div class="titlepage">
18<div>
19<div>
20<h2 class="title"><a name="d0e2" id="d0e2"></a> Get <span class=
21"application">SAXO</span></h2>
22</div>
23<div>
24<div class="authorgroup">
25<div class="author">
26<h3 class="author"><span class="firstname">S&eacute;bastien</span>
27<span class="surname">Masson</span> <code class=
28"email">&lt;<a href="mailto:Sebastien.Masson_at_locean-ipsl.upmc.fr">Sebastien.Masson_at_locean-ipsl.upmc.fr</a>&gt;</code></h3>
29</div>
30<div class="author">
31<h3 class="author"><span class="firstname">Fran&ccedil;oise</span>
32<span class="surname">Pinsard</span> <code class=
33"email">&lt;<a href=
34"mailto:Francoise.Pinsard_at_locean-ipsl.upmc.fr">Francoise.Pinsard_at_locean-ipsl.upmc.fr</a>&gt;</code></h3>
35</div>
36</div>
37</div>
38<div><span class="pubdate">svn Id of xml source file : $Id:
39getsaxo.xml 139 2006-07-12 16:08:41Z pinsard $<br>
40<br></span></div>
41<div>
42<div class="revhistory">
43<table border="1" width="100%" summary="Revision history">
44<tr>
45<th align="left" valign="top" colspan="2"><b>Revision
46History</b></th>
47</tr>
48<tr>
49<td align="left">Revision 0.0</td>
50<td align="left">May 2006</td>
51</tr>
52<tr>
53<td align="left" colspan="2">First draft</td>
54</tr>
55</table>
56</div>
57</div>
58</div>
59<hr></div>
60<div class="toc">
61<p><b>Table of Contents</b></p>
62<dl>
63<dt><span class="sect1"><a href="#create_saxo_env">1. Create
64<span class="application">SAXO</span> environment</a></span></dt>
65<dt><span class="sect1"><a href="#get_saxo_files">2. Get
66<span class="application">SAXO</span> files</a></span></dt>
67<dd>
68<dl>
69<dt><span class="sect2"><a href="#saxo_local">2.1. If you work at
70IDRIS, IPSL or LOCEAN</a></span></dt>
71<dt><span class="sect2"><a href="#saxo_svn">2.2. If <span class=
72"application">Subversion (svn)</span> is installed on your
73machine</a></span></dt>
74<dt><span class="sect2"><a href="#saxo_tar">2.3. Get <span class=
75"application">SAXO</span> from a tar file</a></span></dt>
76</dl>
77</dd>
78<dt><span class="sect1"><a href="#generate_init">3. Generate your
79init.pro file</a></span></dt>
80<dt><span class="sect1"><a href="#aftergetsaxo">4. After
81this</a></span></dt>
82</dl>
83</div>
84<div class="sect1" lang="en">
85<div class="titlepage">
86<div>
87<div>
88<h2 class="title" style="clear: both"><a name="create_saxo_env" id=
89"create_saxo_env"></a>1.&nbsp; Create <span class=
90"application">SAXO</span> environment</h2>
91</div>
92</div>
93</div>
94<p>To simplify the explanation, we suppose that we install
95<span class="application">SAXO</span> in your <code class=
96"filename"><code class="envar">${HOME}</code></code>. We need to
97create 2 directories:</p>
98<div class="itemizedlist">
99<ul type="disc">
100<li><code class="filename"><code class=
101"envar">${HOME}</code>/SAXO_DIR</code> that will contain the source
102files of <span class="application">SAXO</span>. It should not be
103modified by the user to simplify later updates</li>
104<li><code class="filename"><code class=
105"envar">${HOME}</code>/My_IDL</code> that will contain user
106personal files (including modified <span class=
107"application">SAXO</span> files, if needed).</li>
108</ul>
109</div>
110<pre class="screen">
111  <code class="prompt">$</code> <strong class=
112"userinput"><code><span><strong class=
113"command">cd</strong></span> <em class=
114"parameter"><code><code class=
115"envar">${HOME}</code></code></em></code></strong>
116  <code class="prompt">$</code> <strong class=
117"userinput"><code><span><strong class=
118"command">mkdir</strong></span> <em class=
119"parameter"><code>My_IDL</code></em></code></strong>
120     
121</pre></div>
122<div class="sect1" lang="en">
123<div class="titlepage">
124<div>
125<div>
126<h2 class="title" style="clear: both"><a name="get_saxo_files" id=
127"get_saxo_files"></a>2.&nbsp; Get <span class=
128"application">SAXO</span> files</h2>
129</div>
130</div>
131</div>
132<div class="sect2" lang="en">
133<div class="titlepage">
134<div>
135<div>
136<h3 class="title"><a name="saxo_local" id=
137"saxo_local"></a>2.1.&nbsp; If you work at IDRIS, IPSL or
138LOCEAN</h3>
139</div>
140</div>
141</div>
142<p><span class="application">SAXO</span> is already installed
143at</p>
144<div class="itemizedlist">
145<ul type="disc">
146<li>IDRIS, on <code class="systemitem">rhodes</code>: <code class=
147"filename">/home/rech/eee/reee217/SAXO_DIR</code></li>
148<li>IPSL: <code class="filename">/home/smlod/SAXO_DIR</code></li>
149<li>LOCEAN: <code class=
150"filename">/usr/home/smasson/SAXO_DIR</code></li>
151</ul>
152</div>
153<p>If you can access one of theses directories, there is no need to
154re-install <span class="application">SAXO</span> again! In that
155case, you only have to link <code class="filename"><code class=
156"envar">${HOME}</code>/SAXO_DIR</code> to the appropriate
157directory:</p>
158<div class="variablelist">
159<dl>
160<dt><span class="term"><span class=
161"bold"><strong>IDRIS</strong></span></span></dt>
162<dd>
163<pre class="screen">
164  <code class="prompt">$</code> <strong class=
165"userinput"><code><span><strong class=
166"command">ln</strong></span> <code class=
167"option">-s</code> <em class=
168"parameter"><code>/home/rech/eee/reee217/SAXO_DIR</code></em> <em class="parameter"><code><code class="envar">${HOME}</code>/SAXO_DIR</code></em></code></strong>
169         
170</pre></dd>
171<dt><span class="term"><span class=
172"bold"><strong>IPSL</strong></span></span></dt>
173<dd>
174<pre class="screen">
175  <code class="prompt">$</code> <strong class=
176"userinput"><code><span><strong class=
177"command">ln</strong></span> <code class=
178"option">-s</code> <em class=
179"parameter"><code>/home/smlod/SAXO_DIR</code></em> <em class=
180"parameter"><code><code class=
181"envar">${HOME}</code>/SAXO_DIR</code></em></code></strong>
182         
183</pre></dd>
184<dt><span class="term"><span class=
185"bold"><strong>LOCEAN</strong></span></span></dt>
186<dd>
187<pre class="screen">
188  <code class="prompt">$</code> <strong class=
189"userinput"><code><span><strong class=
190"command">ln</strong></span> <code class=
191"option">-s</code> <em class=
192"parameter"><code>/usr/home/smasson/SAXO_DIR</code></em> <em class=
193"parameter"><code><code class=
194"envar">${HOME}</code>/SAXO_DIR</code></em></code></strong>
195         
196</pre></dd>
197</dl>
198</div>
199</div>
200<div class="sect2" lang="en">
201<div class="titlepage">
202<div>
203<div>
204<h3 class="title"><a name="saxo_svn" id="saxo_svn"></a>2.2.&nbsp;
205If <a href="http://subversion.tigris.org/" target=
206"_top"><span class="application">Subversion (svn)</span></a> is
207installed on your machine</h3>
208</div>
209</div>
210</div>
211<div class="sect3" lang="en">
212<div class="titlepage">
213<div>
214<div>
215<h4 class="title"><a name="saxo_svn_users" id=
216"saxo_svn_users"></a>2.2.1.&nbsp; Regular users</h4>
217</div>
218</div>
219</div>
220<p>The <span class="bold"><strong>complete</strong></span> latest
221revision (source + tests data files: 780 Mb) can be checked out
222with the following command executed in your <code class=
223"envar">${HOME}</code>:</p>
224<pre class="screen">
225  <code class="prompt">$</code> <strong class=
226"userinput"><code><span><strong class=
227"command">svn</strong></span> <code class=
228"option">checkout</code> <em class=
229"parameter"><code>http://forge.ipsl.jussieu.fr/saxo/svn/trunk/</code></em> <em class="parameter"><code>SAXO_DIR</code></em></code></strong>
230       
231</pre>
232<p>The latest revision of the <span class="bold"><strong>source
233files</strong></span> (52 Mb) can be checked out with the following
234command:</p>
235<pre class="screen">
236  <code class="prompt">$</code> <strong class=
237"userinput"><code><span><strong class=
238"command">svn</strong></span> <code class=
239"option">checkout</code> <em class=
240"parameter"><code>http://forge.ipsl.jussieu.fr/saxo/svn/trunk/SRC</code></em> <em class="parameter"><code>SAXO_DIR/SRC</code></em></code></strong>
241       
242</pre>
243<p>The latest revision of the <span class="bold"><strong>NetCDF
244data files</strong></span> (728 Mb) used by the test programs can
245be checked out with the following command:</p>
246<pre class="screen">
247  <code class="prompt">$</code> <strong class=
248"userinput"><code><span><strong class=
249"command">svn</strong></span> <code class=
250"option">checkout</code> <em class=
251"parameter"><code>http://forge.ipsl.jussieu.fr/saxo/svn/trunk/DATA</code></em> <em class="parameter"><code>SAXO_DIR/DATA</code></em></code></strong>
252       
253</pre></div>
254<div class="sect3" lang="en">
255<div class="titlepage">
256<div>
257<div>
258<h4 class="title"><a name="saxo_svn_contributors" id=
259"saxo_svn_contributors"></a>2.2.2.&nbsp; Contributors</h4>
260</div>
261</div>
262</div>
263<p><span class="bold"><strong>Contributors</strong></span> should
264better use the following command (and replace login by your own
265login):</p>
266<pre class="screen">
267  <code class="prompt">$</code> <strong class=
268"userinput"><code><span><strong class=
269"command">svn</strong></span> <code class=
270"option">checkout</code> <em class=
271"parameter"><code>svn+ssh://<em class=
272"replaceable"><code>login</code></em>@forge.ipsl.jussieu.fr/ipsl/forge/projets/saxo/svn/trunk/</code></em> <em class="parameter"><code>SAXO_DIR</code></em></code></strong>
273       
274</pre></div>
275</div>
276<div class="sect2" lang="en">
277<div class="titlepage">
278<div>
279<div>
280<h3 class="title"><a name="saxo_tar" id="saxo_tar"></a>2.3.&nbsp;
281Get <span class="application">SAXO</span> from a tar file</h3>
282</div>
283</div>
284</div>
285<div class="sect3" lang="en">
286<div class="titlepage">
287<div>
288<div>
289<h4 class="title"><a name="saxo_src_tar" id=
290"saxo_src_tar"></a>2.3.1.&nbsp; Get <span class=
291"application">SAXO</span> source files (4.8M Mb)</h4>
292</div>
293</div>
294</div>
295<p>Create your <code class="filename"><code class=
296"envar">${HOME}</code>/SAXO_DIR</code> directory...</p>
297<pre class="screen">
298  <code class="prompt">$</code> <strong class=
299"userinput"><code><span><strong class=
300"command">cd</strong></span> <em class=
301"parameter"><code><code class=
302"envar">${HOME}</code></code></em></code></strong>
303  <code class="prompt">$</code> <strong class=
304"userinput"><code><span><strong class=
305"command">mkdir</strong></span> <em class=
306"parameter"><code>SAXO_DIR</code></em></code></strong>
307  <code class="prompt">$</code> <strong class=
308"userinput"><code><span><strong class=
309"command">cd</strong></span> <em class=
310"parameter"><code>SAXO_DIR</code></em></code></strong>
311         
312</pre>
313<p>... and download it the latest version of the sources tar file:
314<a href=
315"http://forge.ipsl.jussieu.fr/saxo/download/SAXO_SRC_20060628.tar.gz"
316target="_top">SAXO_SRC_20060628.tar.gz</a> (4.8M Mb). This tar.gz
317file could also be downloaded with</p>
318<div class="variablelist">
319<dl>
320<dt><span class="term"><span><strong class=
321"command">wget</strong></span></span></dt>
322<dd>
323<pre class="screen">
324  <code class="prompt">$</code> <strong class=
325"userinput"><code><span><strong class=
326"command">wget</strong></span> <em class=
327"parameter"><code>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_SRC_20060628.tar.gz</code></em></code></strong>
328         
329</pre></dd>
330<dt><span class="term"><span><strong class=
331"command">curl</strong></span></span></dt>
332<dd>
333<pre class="screen">
334  <code class="prompt">$</code> <strong class=
335"userinput"><code><span><strong class=
336"command">curl</strong></span> <code class=
337"option">-O</code> <em class=
338"parameter"><code>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_SRC_20060628.tar.gz</code></em></code></strong>
339         
340</pre></dd>
341</dl>
342</div>
343<p>Untar the file</p>
344<pre class="screen">
345  <code class="prompt">$</code> <strong class=
346"userinput"><code><span><strong class=
347"command">cd</strong></span> <em class=
348"parameter"><code><code class=
349"envar">${HOME}</code>/SAXO_DIR</code></em></code></strong>
350  <code class="prompt">$</code> <strong class=
351"userinput"><code><span><strong class=
352"command">tar</strong></span> <code class=
353"option">xvfz</code> <em class=
354"parameter"><code>SAXO_SRC_20060628.tar.gz</code></em></code></strong>
355  <code class="prompt">$</code> <strong class=
356"userinput"><code><span><strong class=
357"command">rm</strong></span> <em class=
358"parameter"><code>SAXO_SRC_20060628.tar.gz</code></em></code></strong>
359       
360</pre></div>
361<div class="sect3" lang="en">
362<div class="titlepage">
363<div>
364<div>
365<h4 class="title"><a name="saxo_data_tar" id=
366"saxo_data_tar"></a>2.3.2.&nbsp; Get <span class=
367"application">SAXO</span> tests data files (238M Mb)</h4>
368</div>
369</div>
370</div>
371<p>If you want to use the tests programs, you need to download the
372data tests files (<code class=
373"filename">SAXO_DATA_20060602.tar.gz</code>), You may download
374theses files in</p>
375<div class="itemizedlist">
376<ul type="disc">
377<li><code class="filename"><code class=
378"envar">${HOME}</code>/My_IDL</code>. This is the easiest solution
379but it could be inconvenient if your <code class=
380"envar">${HOME}</code> disk space is limited.</li>
381<li>any other Directory of your choice. In that case, when using
382IDL, you will need to define the variable <code class=
383"varname">iodir</code> to the Directory you choose in order to let
384IDL find the data tests files. This can be done either through the
385<code class="filename">init.pro</code> file (see <a href=
386"#generate_init" title=
387"3.&nbsp; Generate your init.pro file  ">Section&nbsp;3, &ldquo;
388Generate your init.pro file &rdquo;</a>) or directly within IDL
389with the following command: <code class="prompt">idl&gt;</code>
390<strong class="userinput"><code><span><strong class="command">iodir
391= <em class="replaceable"><code>the chosen
392directory</code></em></strong></span></code></strong></li>
393</ul>
394</div>
395<pre class="screen">
396  <code class="prompt">$</code> <strong class=
397"userinput"><code><span><strong class=
398"command">cd</strong></span> <em class=
399"parameter"><code><code class=
400"envar">${HOME}</code></code></em></code></strong>
401  <code class="prompt">$</code> <strong class=
402"userinput"><code><span><strong class=
403"command">mkdir</strong></span> <em class=
404"parameter"><code><em class=
405"replaceable"><code>CHOSEN_DIR</code></em></code></em></code></strong>
406  <code class="prompt">$</code> <strong class=
407"userinput"><code><span><strong class=
408"command">cd</strong></span> <em class="parameter"><code><em class=
409"replaceable"><code>CHOSEN_DIR</code></em></code></em></code></strong>
410       
411</pre>
412<p>Download <a href=
413"http://forge.ipsl.jussieu.fr/saxo/download/SAXO_DATA_20060602.tar.gz"
414target="_top">SAXO_DATA_20060602.tar.gz</a> (238M Mb) ... or
415with</p>
416<div class="variablelist">
417<dl>
418<dt><span class="term"><span><strong class=
419"command">wget</strong></span></span></dt>
420<dd>
421<pre class="screen">
422  <code class="prompt">$</code> <strong class=
423"userinput"><code><span><strong class=
424"command">wget</strong></span> <em class=
425"parameter"><code>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_DATA_20060602.tar.gz</code></em></code></strong>
426         
427</pre></dd>
428<dt><span class="term"><span><strong class=
429"command">curl</strong></span></span></dt>
430<dd>
431<pre class="screen">
432  <code class="prompt">$</code> <strong class=
433"userinput"><code><span><strong class=
434"command">curl</strong></span> <code class=
435"option">-O</code> <em class=
436"parameter"><code>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_DATA_20060602.tar.gz</code></em></code></strong>
437         
438</pre></dd>
439</dl>
440</div>
441</div>
442</div>
443</div>
444<div class="sect1" lang="en">
445<div class="titlepage">
446<div>
447<div>
448<h2 class="title" style="clear: both"><a name="generate_init" id=
449"generate_init"></a>3.&nbsp; Generate your init.pro file</h2>
450</div>
451</div>
452</div>
453<p>To use <span class="application">SAXO</span>, we need to build
454an idl script that we usually call "<code class=
455"filename">init.pro</code>". This file contains a set of IDL
456commands and default definitions (paths and variables of the common
457files) that are necessary to <span class="application">SAXO</span>.
458Once it has been created, <code class="filename">init.pro</code>
459should the first executed command when starting IDL session.</p>
460<pre class="screen">
461  <code class="prompt">$</code> <strong class=
462"userinput"><code><span><strong class=
463"command">cd</strong></span> <em class=
464"parameter"><code><code class=
465"envar">${HOME}</code>/SAXO_DIR/SRC</code></em></code></strong>
466  <code class="prompt">$</code> <strong class=
467"userinput"><code><span><strong class=
468"command">idl</strong></span></code></strong>
469  <code class=
470"computeroutput">IDL Version 6.0, Mac OS X (darwin ppc m32). (c) 2003, Research Systems, Inc.</code>
471
472  <code class="prompt">idl&gt;</code> <strong class=
473"userinput"><code><span><strong class=
474"command">buildinit</strong></span></code></strong>
475  <code class="computeroutput">% Compiled module: BUILDINIT.</code>
476       
477</pre>
478<p>You must then answer several questions:</p>
479<div class="itemizedlist">
480<ul type="disc">
481<li>give the path of <code class="filename"><code class=
482"envar">${HOME}</code>/My_IDL</code></li>
483<li>give the path of <code class="filename"><code class=
484"envar">${HOME}</code>/SAXO_DIR</code></li>
485<li>compatibility with the old version: No (except if you want to
486use old programs)</li>
487<li>give a default path for the data directory</li>
488<li>give a default path for the postscript directory</li>
489<li>give a default path for the images directory</li>
490<li>give a default path for the animation directory</li>
491<li>number of accessible printer and their configuration</li>
492<li>default color table</li>
493<li>default page orientation (portrait/landscape)</li>
494<li>default page size</li>
495<li>default window size</li>
496<li>postscript archiving options</li>
497<li>name of the init file (<code class=
498"filename">init.pro</code>)</li>
499</ul>
500</div>
501<pre class="screen">
502   <code class="computeroutput">% Compiled module: CW_FIELD.</code>
503   <code class="computeroutput">% Compiled module: XMANAGER.</code>
504   <code class="computeroutput">% Compiled module: LOADCT.</code>
505   <code class="computeroutput">% Compiled module: FILEPATH.</code>
506   <code class="computeroutput">% Compiled module: PATH_SEP.</code>
507   <code class="computeroutput">% Compiled module: CW_FIELD.</code>
508   <code class="computeroutput">% Compiled module: STRSPLIT.</code>
509   <code class="computeroutput">% Compiled module: CW_FIELD.</code>
510   <code class="computeroutput">% Compiled module: CW_FIELD.</code>
511   <code class="computeroutput">% Compiled module: CW_FIELD.</code>
512   <code class="prompt">idl&gt;</code> <strong class=
513"userinput"><code><span><strong class=
514"command">exit</strong></span></code></strong>
515       
516</pre>
517<p>There is an example of the kind of <a href=
518"idlfiles/init_example.pro?format=raw" target="_top"><code class=
519"filename">init.pro</code></a> you should get.</p>
520</div>
521<div class="sect1" lang="en">
522<div class="titlepage">
523<div>
524<div>
525<h2 class="title" style="clear: both"><a name="aftergetsaxo" id=
526"aftergetsaxo"></a>4.&nbsp;After this</h2>
527</div>
528</div>
529</div>
530<p>You are now ready to do your <a href=
531"firststeps.html?format=raw" target="_top">First steps with
532SAXO</a>.</p>
533</div>
534</div>
535</body>
536</html>
Note: See TracBrowser for help on using the repository browser.