source: trunk/SRC/Documentation/xmldoc/wiki/GetSaxo @ 350

Last change on this file since 350 was 350, checked in by pinsard, 16 years ago

improve links in wiki files
File size: 18.8 KB
Line 
1{{{
2#!html
3<div xmlns="http://www.w3.org/1999/xhtml" class="article" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="getsaxo" id="getsaxo"/>Get <span class="application">SAXO</span></h2></div><div><div class="authorgroup">
4      <div class="author"><h3 class="author"><span class="firstname">Sébastien</span> <span class="surname">Masson</span> <code class="email">&lt;<a href="mailto:Sebastien.Masson_at_locean-ipsl.upmc.fr">Sebastien.Masson_at_locean-ipsl.upmc.fr</a>&gt;</code></h3></div>
5      <div class="author"><h3 class="author"><span class="firstname">Françoise</span> <span class="surname">Pinsard</span> <code class="email">&lt;<a href="mailto:Francoise.Pinsard_at_locean-ipsl.upmc.fr">Francoise.Pinsard_at_locean-ipsl.upmc.fr</a>&gt;</code></h3></div>
6    </div></div><div><span class="pubdate">svn Id of xml source file : $Id: getsaxo.html 348 2008-04-16 13:02:27Z pinsard $<br/><br/></span></div><div><div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="2"><b>Revision History</b></th></tr>
7      <tr><td align="left">Revision 0.0</td><td align="left">May 2006</td></tr><tr><td align="left" colspan="2">First draft</td></tr>
8      <tr><td align="left">Revision 0.1</td><td align="left">April 2008</td></tr><tr><td align="left" colspan="2">migration from DocBook 4.2 to Docbook 5.0</td></tr>
9    </table></div></div></div><hr/></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#create_saxo_env">1.  Create <span class="application">SAXO</span> environment </a></span></dt><dt><span class="sect1"><a href="#get_saxo_files">2.  Get <span class="application">SAXO</span> files </a></span></dt><dd><dl><dt><span class="sect2"><a href="#saxo_local">2.1.  If you work at IDRIS, IPSL or LOCEAN </a></span></dt><dt><span class="sect2"><a href="#saxo_svn">2.2.  If <span class="application"> Subversion (svn)</span> is installed on your machine </a></span></dt><dt><span class="sect2"><a href="#saxo_tar">2.3.  Get <span class="application">SAXO</span> from a tar file </a></span></dt></dl></dd><dt><span class="sect1"><a href="#generate_init">3.  Generate your init.pro file </a></span></dt><dt><span class="sect1"><a href="#aftergetsaxo">4. After this</a></span></dt></dl></div>
10
11 
12
13 
14
15 
16
17  <div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="create_saxo_env" id="create_saxo_env"/>1.  Create <span class="application">SAXO</span> environment </h2></div></div></div>
18   
19    <p>
20      To simplify the explanation, we suppose that we install <span class="application">SAXO</span> in your <code class="filename">${HOME}</code>.
21      We need to create 2 directories:
22      </p><div class="itemizedlist"><ul type="disc"><li>
23         <code class="filename">${HOME}/SAXO_DIR</code> that will contain the source files of <span class="application">SAXO</span>. It should not be modified by the user to simplify later updates
24         
25        </li><li>
26         <code class="filename">${HOME}/My_IDL</code> that will contain user personal files (including modified <span class="application">SAXO</span> files, if needed).
27         
28       </li></ul></div><p>
29    </p>
30    <p>
31      </p><pre class="screen">
32  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd</strong></span> <em class="parameter"><code>${HOME}</code></em></code></strong>
33  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">mkdir</strong></span> <em class="parameter"><code>My_IDL</code></em></code></strong>
34      </pre><p>
35    </p>
36  </div>
37
38 
39
40 <div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="get_saxo_files" id="get_saxo_files"/>2.  Get <span class="application">SAXO</span> files </h2></div></div></div>
41   
42
43 
44
45    <div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="saxo_local" id="saxo_local"/>2.1.  If you work at IDRIS, IPSL or LOCEAN </h3></div></div></div>
46     
47      <p>
48        <span class="application">SAXO</span> is already installed at
49        </p><div class="itemizedlist"><ul type="disc"><li>
50           IDRIS, on <code class="systemitem">rhodes</code>: <code class="filename">/home/rech/eee/reee217/SAXO_DIR</code>
51           
52          </li><li>
53           IPSL: <code class="filename">/home/smlod/SAXO_DIR</code>
54           
55          </li><li>
56           LOCEAN: <code class="filename">/usr/home/smasson/SAXO_DIR</code>
57           
58         </li></ul></div><p>
59        If you can access one of theses directories, there is no need to re-install <span class="application">SAXO</span> again! In that case, you only have to link <code class="filename">${HOME}/SAXO_DIR</code> to the appropriate directory:
60        </p><div class="variablelist"><dl><dt><span class="term"><span class="bold"><strong>IDRIS</strong></span></span></dt><dd><pre class="screen">
61  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">ln</strong></span> <code class="option">-s</code> <em class="parameter"><code>/home/rech/eee/reee217/SAXO_DIR</code></em> <em class="parameter"><code>${HOME}/SAXO_DIR</code></em></code></strong>
62          </pre>
63         </dd><dt><span class="term"><span class="bold"><strong>IPSL</strong></span></span></dt><dd><pre class="screen">
64  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">ln</strong></span> <code class="option">-s</code> <em class="parameter"><code>/home/smlod/SAXO_DIR</code></em> <em class="parameter"><code>${HOME}/SAXO_DIR</code></em></code></strong>
65          </pre>
66           </dd><dt><span class="term"><span class="bold"><strong>LOCEAN</strong></span></span></dt><dd><pre class="screen">
67  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">ln</strong></span> <code class="option">-s</code> <em class="parameter"><code>/usr/home/smasson/SAXO_DIR</code></em> <em class="parameter"><code>${HOME}/SAXO_DIR</code></em></code></strong>
68          </pre>
69           </dd></dl></div><p>
70      </p>
71    </div>
72
73 
74
75    <div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="saxo_svn" id="saxo_svn"/>2.2.  If <a href="http://subversion.tigris.org/" target="_top"><span class="application"> Subversion (svn)</span></a> is installed on your machine </h3></div></div></div>
76     
77 
78      <div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="saxo_svn_users" id="saxo_svn_users"/>2.2.1.  Regular users </h4></div></div></div>
79       
80      <p>
81        The <span class="bold"><strong>complete</strong></span> latest revision (source + tests data files: 772 Mb) can be checked out with the following command executed in your <code class="envar">${HOME}</code>:
82        </p><pre class="screen">
83  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">svn</strong></span> <code class="option">checkout</code> <em class="parameter"><code>http://forge.ipsl.jussieu.fr/saxo/svn/trunk/</code></em> <em class="parameter"><code>SAXO_DIR</code></em></code></strong>
84        </pre><p>
85      </p>
86      <p>
87        The latest revision of the <span class="bold"><strong>source files</strong></span> (45 Mb) can be checked out with the following command:
88        </p><pre class="screen">
89  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">svn</strong></span> <code class="option">checkout</code> <em class="parameter"><code>http://forge.ipsl.jussieu.fr/saxo/svn/trunk/SRC</code></em> <em class="parameter"><code>SAXO_DIR/SRC</code></em></code></strong>
90        </pre><p>
91      </p>
92      <p>
93        The latest revision of the <span class="bold"><strong>NetCDF data files</strong></span> (728 Mb) used by the test programs can be checked out with the following command:
94        </p><pre class="screen">
95  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">svn</strong></span> <code class="option">checkout</code> <em class="parameter"><code>http://forge.ipsl.jussieu.fr/saxo/svn/trunk/DATA</code></em> <em class="parameter"><code>SAXO_DIR/DATA</code></em></code></strong>
96        </pre><p>
97      </p>
98      </div>
99
100      <div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="saxo_svn_contributors" id="saxo_svn_contributors"/>2.2.2.  Contributors </h4></div></div></div>
101       
102      <p>
103        <span class="bold"><strong>Contributors</strong></span> should better use the following command (and replace login by your own login):
104        </p><pre class="screen">
105  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">svn</strong></span> <code class="option">checkout</code> <em class="parameter"><code>svn+ssh://<em class="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>
106        </pre><p>
107      </p>
108      </div>
109    </div>
110
111 
112
113    <div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="saxo_tar" id="saxo_tar"/>2.3.  Get <span class="application">SAXO</span> from a tar file </h3></div></div></div>
114     
115 
116      <div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="saxo_src_tar" id="saxo_src_tar"/>2.3.1.  Get <span class="application">SAXO</span> source files (5.8M Mb) </h4></div></div></div>
117       
118        <p>
119          Create your <code class="filename">${HOME}/SAXO_DIR</code> directory 

120          </p><pre class="screen">
121  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd</strong></span> <em class="parameter"><code>${HOME}</code></em></code></strong>
122  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">mkdir</strong></span> <em class="parameter"><code>SAXO_DIR</code></em></code></strong>
123  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd</strong></span> <em class="parameter"><code>SAXO_DIR</code></em></code></strong>
124          </pre><p>
125          
 and download it the latest version of the sources tar file: <a href="http://forge.ipsl.jussieu.fr/saxo/download/SAXO_SRC_20080321r339.tar.gz" target="_top">SAXO_SRC_20080321r339.tar.gz</a> (5.8M Mb). This tar.gz file could also be downloaded with
126        </p><div class="variablelist"><dl><dt><span class="term"><span><strong class="command">wget</strong></span></span></dt><dd><pre class="screen">
127  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">wget</strong></span> <em class="parameter"><code>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_SRC_20080321r339.tar.gz</code></em></code></strong>
128          </pre>
129           </dd><dt><span class="term"><span><strong class="command">curl</strong></span></span></dt><dd><pre class="screen">
130  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">curl</strong></span> <code class="option">-O</code> <em class="parameter"><code>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_SRC_20080321r339.tar.gz</code></em></code></strong>
131          </pre>
132           </dd></dl></div><p> 
133        Untar the file
134        </p><pre class="screen">
135  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd</strong></span> <em class="parameter"><code>${HOME}/SAXO_DIR</code></em></code></strong>
136  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">tar</strong></span> <code class="option">xvfz</code> <em class="parameter"><code>SAXO_SRC_20080321r339.tar.gz</code></em></code></strong>
137  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">rm</strong></span> <em class="parameter"><code>SAXO_SRC_20080321r339.tar.gz</code></em></code></strong>
138        </pre><p>
139        </p>
140
141      </div>
142 
143      <div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="saxo_data_tar" id="saxo_data_tar"/>2.3.2.  Get <span class="application">SAXO</span> tests data files (238M Mb) </h4></div></div></div>
144       
145        <p>
146        If you want to use the tests programs, you need to download the data tests files (<code class="filename">SAXO_DATA_20060602.tar.gz</code>), You may download theses files in
147        </p><div class="itemizedlist"><ul type="disc"><li>
148           <code class="filename">${HOME}/My_IDL</code>. This is the easiest solution but it could be inconvenient if your <code class="envar">${HOME}</code> disk space is limited.
149           
150          </li><li>
151           any other Directory of your choice. In that case, when using IDL, you will need to define the variable <code class="varname">iodir</code> to the Directory you choose in order to let IDL find the data tests files. This can be done either through the <code class="filename">init.pro</code> file (see <a href="#generate_init" title="3.&#xA0; Generate your init.pro file ">Section 3, “ Generate your init.pro file ”</a>) or directly within IDL with the following command: <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">iodir = <em class="replaceable"><code>the chosen directory</code></em></strong></span></code></strong>
152           
153          </li></ul></div><p>
154        </p><pre class="screen">
155  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd</strong></span> <em class="parameter"><code>${HOME}</code></em></code></strong>
156  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">mkdir</strong></span> <em class="parameter"><code><em class="replaceable"><code>CHOSEN_DIR</code></em></code></em></code></strong>
157  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd</strong></span> <em class="parameter"><code><em class="replaceable"><code>CHOSEN_DIR</code></em></code></em></code></strong>
158        </pre><p>
159        Download <a href="http://forge.ipsl.jussieu.fr/saxo/download/SAXO_DATA_20060602.tar.gz" target="_top">SAXO_DATA_20060602.tar.gz</a> (238M Mb)
160        
 or with
161        </p><div class="variablelist"><dl><dt><span class="term"><span><strong class="command">wget</strong></span></span></dt><dd><pre class="screen">
162  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">wget</strong></span> <em class="parameter"><code>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_DATA_20060602.tar.gz</code></em></code></strong>
163          </pre>
164           </dd><dt><span class="term"><span><strong class="command">curl</strong></span></span></dt><dd><pre class="screen">
165  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">curl</strong></span> <code class="option">-O</code> <em class="parameter"><code>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_DATA_20060602.tar.gz</code></em></code></strong>
166          </pre>
167            </dd></dl></div><p>
168        </p>
169      </div>
170    </div>
171  </div>
172 
173    <div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="generate_init" id="generate_init"/>3.  Generate your init.pro file </h2></div></div></div>
174     
175      <p>
176        To use <span class="application">SAXO</span>, we need to build an IDL script that we usually call "<code class="filename">init.pro</code>". This file contains a set of IDL commands and default definitions (paths and variables of the common files) that are necessary to <span class="application">SAXO</span>. Once it has been created, <code class="filename">init.pro</code> should the first executed command when starting IDL session.
177      </p>
178      <p>
179        </p><pre class="screen">
180  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd</strong></span> <em class="parameter"><code>${HOME}/SAXO_DIR/SRC</code></em></code></strong>
181  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">idl</strong></span></code></strong>
182  <code class="computeroutput">IDL Version 6.0, Mac OS X (darwin ppc m32). (c) 2003, Research Systems, Inc.</code>
183
184  <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">buildinit</strong></span></code></strong>
185  <code class="computeroutput">% Compiled module: BUILDINIT.</code>
186        </pre><p>
187        You must then answer several questions:
188
189        </p><div class="itemizedlist"><ul type="disc"><li>
190           give the path of <code class="filename">${HOME}/My_IDL</code>
191           
192          </li><li>
193           give the path of <code class="filename">${HOME}/SAXO_DIR</code>
194           
195          </li><li>
196           compatibility with the old version: No (except if you want to use old programs)
197           
198          </li><li>
199           give a default path for the data directory
200           
201          </li><li>
202           give a default path for the postscript directory
203           
204          </li><li>
205           give a default path for the images directory
206           
207          </li><li>
208           give a default path for the animation directory
209           
210          </li><li>
211           number of accessible printer and their configuration
212           
213          </li><li>
214           default color table
215           
216          </li><li>
217           default page orientation (portrait/landscape)
218           
219          </li><li>
220           default page size
221           
222          </li><li>
223           default window size
224           
225          </li><li>
226           postscript archiving options
227           
228          </li><li>
229           name of the init file (<code class="filename">init.pro</code>)
230           
231          </li></ul></div><p>
232        </p><pre class="screen">
233   <code class="computeroutput">% Compiled module: CW_FIELD.</code>
234   <code class="computeroutput">% Compiled module: XMANAGER.</code>
235   <code class="computeroutput">% Compiled module: LOADCT.</code>
236   <code class="computeroutput">% Compiled module: FILEPATH.</code>
237   <code class="computeroutput">% Compiled module: PATH_SEP.</code>
238   <code class="computeroutput">% Compiled module: CW_FIELD.</code>
239   <code class="computeroutput">% Compiled module: STRSPLIT.</code>
240   <code class="computeroutput">% Compiled module: CW_FIELD.</code>
241   <code class="computeroutput">% Compiled module: CW_FIELD.</code>
242   <code class="computeroutput">% Compiled module: CW_FIELD.</code>
243   <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">exit</strong></span></code></strong>
244        </pre><p>
245        There is an example of the kind of <a href="idlfiles/init_example.pro" target="_top"> <code class="filename">init.pro</code></a> you should get.
246      </p>
247    </div>
248<div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="aftergetsaxo" id="aftergetsaxo"/>4. After this</h2></div></div></div>
249
250<p>
251You are now ready to do your
252<a href="./FirstSteps" target="_top">First steps with SAXO</a>.
253</p>
254</div>
255</div>
256
257}}}
Note: See TracBrowser for help on using the repository browser.