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

Last change on this file since 259 was 255, checked in by pinsard, 17 years ago

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