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

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

add ?format=raw at the end of URL in .xml files when files are in saxo svn repository
File size: 20.1 KB
Line 
1<html><head>
2      <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3   <title>
4    Get SAXO
5  </title><link rel="stylesheet" href="saxo.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.69.1"><meta name="keywords" content="idl, SAXO"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="d0e1"></a>
6    Get <span class="application">SAXO</span>
7  </h2></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">S&eacute;bastien</span> <span class="surname">Masson</span></h3><code class="email">&lt;<a href="mailto:smasson@lodyc.jussieu.fr">smasson@lodyc.jussieu.fr</a>&gt;</code></div><div class="author"><h3 class="author"><span class="firstname">Fran&ccedil;oise</span> <span class="surname">Pinsard</span></h3><code class="email">&lt;<a href="mailto:fplod@lodyc.jussieu.fr">fplod@lodyc.jussieu.fr</a>&gt;</code></div></div></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><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></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.
8      Create <span class="application">SAXO</span> environment
9    </a></span></dt><dt><span class="sect1"><a href="#get_saxo_files">2.
10      Get <span class="application">SAXO</span> files
11    </a></span></dt><dd><dl><dt><span class="sect2"><a href="#saxo_local">2.1.
12        If you work at IDRIS or LOCEAN
13      </a></span></dt><dt><span class="sect2"><a href="#saxo_svn">2.2.
14        If <span class="application"> Subversion (svn)</span> is installed on your machine
15      </a></span></dt><dt><span class="sect2"><a href="#saxo_tar">2.3.
16        Get <span class="application">SAXO</span> from a tar file
17      </a></span></dt></dl></dd><dt><span class="sect1"><a href="#generate_init">3.
18        Generate your init.pro file
19      </a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="create_saxo_env"></a>1.&nbsp;
20      Create <span class="application">SAXO</span> environment
21    </h2></div></div></div><p>
22      To simplify the explanation, we suppose that we install <span class="application">SAXO</span> in your <code class="filename"><code class="envar">${HOME}</code></code>.
23      We need to create 2 directories:
24      </p><div class="itemizedlist"><ul type="disc"><li><code class="filename"><code class="envar">${HOME}</code>/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</li><li><code class="filename"><code class="envar">${HOME}</code>/My_IDL</code> that will contain user personal files (including modified <span class="application">SAXO</span> files, if needed).</li></ul></div><p>
25    </p><p>
26      </p><pre class="screen">
27  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd</strong></span> <em class="parameter"><code><code class="envar">${HOME}</code></code></em></code></strong>
28  <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>
29      </pre><p>
30    </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="get_saxo_files"></a>2.&nbsp;
31      Get <span class="application">SAXO</span> files
32    </h2></div></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="saxo_local"></a>2.1.&nbsp;
33        If you work at IDRIS or LOCEAN
34      </h3></div></div></div><p>
35        <span class="application">SAXO</span> is already installed at
36        </p><div class="itemizedlist"><ul type="disc"><li>IDRIS, on rhodes: <code class="filename">/home/rech/eee/reee217/SAXO_DIR</code></li><li>LOCEAN: <code class="filename">/usr/home/smasson/SAXO_DIR</code></li></ul></div><p>
37        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"><code class="envar">${HOME}</code>/SAXO_DIR</code> to the appropiate directory:
38        </p><div class="variablelist"><dl><dt><span class="term"><span><strong class="command">IDRIS</strong></span></span></dt><dd><pre class="screen">
39  <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><code class="envar">${HOME}</code>/SAXO_DIR</code></em></code></strong>
40          </pre></dd><dt><span class="term"><span><strong class="command">LOCEAN</strong></span></span></dt><dd><pre class="screen">
41  <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><code class="envar">${HOME}</code>/SAXO_DIR</code></em></code></strong>
42          </pre></dd></dl></div><p>
43      </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="saxo_svn"></a>2.2.&nbsp;
44        If <a href="http://subversion.tigris.org/" target="_top"><span class="application"> Subversion (svn)</span></a> is installed on your machine
45      </h3></div></div></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="saxo_svn_users"></a>2.2.1.&nbsp;
46          Regular users
47        </h4></div></div></div><p>
48        The <span class="bold"><strong>complete</strong></span> latest revision (source + tests data files: ~750 Mb) can be checked out with the following command executed in your <code class="envar">${HOME}</code>:
49        </p><pre class="screen">
50  <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>
51        </pre><p>
52      </p><p>
53        The latest revision of the <span><strong class="command">source files</strong></span> (~25 Mb) can be checked out with the following command:
54        </p><pre class="screen">
55  <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>
56        </pre><p>
57      </p><p>
58        The latest revision of the <span><strong class="command">NetCDF data files</strong></span> (~725 Mb) used by the test programs can be checked out with the following command:
59        </p><pre class="screen">
60  <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>
61        </pre><p>
62      </p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="saxo_svn_contributors"></a>2.2.2.&nbsp;
63          Contributors
64        </h4></div></div></div><p>
65        <span><strong class="command">Contributors</strong></span> should better use the following command :
66        </p><pre class="screen">
67  <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>
68        </pre><p>
69      </p></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="saxo_tar"></a>2.3.&nbsp;
70        Get <span class="application">SAXO</span> from a tar file
71      </h3></div></div></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="saxo_src_tar"></a>2.3.1.&nbsp;
72          Get <span class="application">SAXO</span> source files (... Mb)
73        </h4></div></div></div><p>
74          Create your <code class="filename"><code class="envar">${HOME}</code>/SAXO_DIR</code> directory...
75          </p><pre class="screen">
76  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd</strong></span> <em class="parameter"><code><code class="envar">${HOME}</code></code></em></code></strong>
77  <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>
78  <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>
79          </pre><p>
80          ... and download it the latest version of the sources tar file: <a href="http://www.lodyc.jussieu.fr/~smasson/SAXO/SRC/SAXO_DIR_.tar.gz" target="_top">SAXO_DIR_.tar.gz</a> ( Mb). This tar.gzip file could also be downloaded with
81        </p><div class="variablelist"><dl><dt><span class="term"><span><strong class="command">wget</strong></span></span></dt><dd><pre class="screen">
82  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">wget</strong></span> <em class="parameter"><code>http://www.lodyc.jussieu.fr/~smasson/SAXO/SRC/SAXO_DIR_.tar.gz</code></em></code></strong>
83          </pre></dd><dt><span class="term"><span><strong class="command">curl</strong></span></span></dt><dd><pre class="screen">
84  <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://www.lodyc.jussieu.fr/~smasson/SAXO/SRC/SAXO_DIR_.tar.gz</code></em></code></strong>
85          </pre></dd></dl></div><p>     
86        Untar the file
87        </p><pre class="screen">
88  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd</strong></span> <em class="parameter"><code><code class="envar">${HOME}</code>/SAXO_DIR</code></em></code></strong>
89  <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_DIR_*.tar.gz</code></em></code></strong>
90  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">rm</strong></span> <em class="parameter"><code>SAXO_DIR_*.tar.gz</code></em></code></strong>
91        </pre><p>
92        </p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="saxo_data_tar"></a>2.3.2.&nbsp;
93          Get <span class="application">SAXO</span> tests data files (... Mb)
94        </h4></div></div></div><p>
95        If you want to use the tests programs, you need to download the data tests files (<code class="filename">TestsData_.tar.gz</code>), You may download theses files in
96        </p><div class="itemizedlist"><ul type="disc"><li><code class="filename"><code class="envar">${HOME}</code>/My_IDL</code>. This is the easiest solution but it could be unconvenient if your <code class="envar">${HOME}</code> disk space is limited.</li><li>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 init.pro file (see <a href="#generate_init" title="3.&nbsp;&#xA;Generate your init.pro file&#xA;      "><a href="#generate_init" title="3.&nbsp;&#xA;Generate your init.pro file&#xA;      ">Section&nbsp;3, &#8220;
97        Generate your init.pro file
98      &#8221;</a></a>) or directly within IDL with the following commad: <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">iodir = "the chosen directory"</strong></span></code></strong></li></ul></div><p>
99        </p><pre class="screen">
100  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd</strong></span> <em class="parameter"><code><code class="envar">${HOME}</code></code></em></code></strong>
101  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">mkdir</strong></span> <em class="parameter"><code>"CHOSEN_DIR"</code></em></code></strong>
102  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd</strong></span> <em class="parameter"><code>"CHOSEN_DIR"</code></em></code></strong>
103        </pre><p>
104        Download the files through thoses links...
105        </p><div class="itemizedlist"><ul type="disc"><li><a href="http://forge.ipsl.jussieu.fr/saxo/svn/trunk/DATA/Levitus98_1m_01_12_Temperature_Pot_1x1.nc" target="_top">http://forge.ipsl.jussieu.fr/saxo/svn/trunk/DATA/Levitus98_1m_01_12_Temperature_Pot_1x1.nc</a> (49 Mb)</li><li><a href="http://forge.ipsl.jussieu.fr/saxo/svn/trunk/DATA/Levitus98_1m_01_12_Temperature_Pot_ORCA2.nc" target="_top">http://forge.ipsl.jussieu.fr/saxo/svn/trunk/DATA/Levitus98_1m_01_12_Temperature_Pot_ORCA2.nc</a> (19 Mb)</li><li><a href="http://forge.ipsl.jussieu.fr/saxo/svn/trunk/DATA/Levitus98_1m_01_12_Temperature_Pot_ORCA05.nc" target="_top">http://forge.ipsl.jussieu.fr/saxo/svn/trunk/DATA/Levitus98_1m_01_12_Temperature_Pot_ORCA05.nc</a> (264 Mb)</li><li><a href="http://forge.ipsl.jussieu.fr/saxo/svn/trunk/DATA/micromeshmaskORCA2.nc" target="_top">http://forge.ipsl.jussieu.fr/saxo/svn/trunk/DATA/micromeshmaskORCA2.nc</a> (27 Mb)</li><li><a href="http://forge.ipsl.jussieu.fr/saxo/svn/trunk/DATA/micromeshmaskORCA05.nc" target="_top">http://forge.ipsl.jussieu.fr/saxo/svn/trunk/DATA/micromeshmaskORCA05.nc</a> (2 Mb)</li></ul></div><p>
106        ... or with
107        </p><div class="variablelist"><dl><dt><span class="term"><span><strong class="command">wget</strong></span></span></dt><dd><pre class="screen">
108  <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/svn/trunk/DATA/Levitus98_1m_01_12_Temperature_Pot_1x1.nc</code></em></code></strong>
109  <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/svn/trunk/DATA/Levitus98_1m_01_12_Temperature_Pot_ORCA2.nc</code></em></code></strong>
110  <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/svn/trunk/DATA/Levitus98_1m_01_12_Temperature_Pot_ORCA05.nc</code></em></code></strong>
111  <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/svn/trunk/DATA/micromeshmaskORCA2.nc</code></em></code></strong>
112  <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/svn/trunk/DATA/micromeshmaskORCA05.nc</code></em></code></strong>
113          </pre></dd><dt><span class="term"><span><strong class="command">curl</strong></span></span></dt><dd><pre class="screen">
114  <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/svn/trunk/DATA/Levitus98_1m_01_12_Temperature_Pot_1x1.nc</code></em></code></strong>
115  <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/svn/trunk/DATA/Levitus98_1m_01_12_Temperature_Pot_ORCA2.nc</code></em></code></strong>
116  <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/svn/trunk/DATA/Levitus98_1m_01_12_Temperature_Pot_ORCA05.nc</code></em></code></strong>
117  <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/svn/trunk/DATA/micromeshmaskORCA2.nc</code></em></code></strong>
118  <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/svn/trunk/DATA/micromeshmaskORCA05.nc</code></em></code></strong>
119          </pre></dd></dl></div><p>
120        </p></div></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="generate_init"></a>3.&nbsp;
121        Generate your init.pro file
122      </h2></div></div></div><p>
123        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 ben created, <code class="filename">init.pro</code> should the first executed command when starting IDL session.
124      </p><p>
125        </p><pre class="screen">
126  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd <code class="envar">${HOME}</code>/SAXO_DIR</strong></span></code></strong>
127  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">idl</strong></span></code></strong>
128  <code class="computeroutput">IDL Version 6.0, Mac OS X (darwin ppc m32). (c) 2003, Research Systems, Inc.</code>
129
130  <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">buildinit</strong></span></code></strong>
131  <code class="computeroutput">% Compiled module: BUILDINIT.</code>
132        </pre><p>
133        You must then answer several questions:
134
135        </p><div class="itemizedlist"><ul type="disc"><li>give the path of <code class="filename"><code class="envar">${HOME}</code>/My_IDL</code></li><li>give the path of <code class="filename"><code class="envar">${HOME}</code>/SAXO_DIR</code></li><li>compatibility with the old version: No (except if you want to use old programs)</li><li>give a default path for the data directory</li><li>give a default path for the postscript directory</li><li>give a default path for the images directory</li><li>give a default path for the animation directory</li><li>number of accessible printer and their configuration</li><li>default color table</li><li>default page orientation (portrait/landscape)</li><li>default page size</li><li>default window size</li><li>postscript archiving options</li><li>name of the init file (<code class="filename">init.pro</code>)</li></ul></div><p>
136        </p><pre class="screen">
137   <code class="computeroutput">% Compiled module: CW_FIELD.</code>
138   <code class="computeroutput">% Compiled module: XMANAGER.</code>
139   <code class="computeroutput">% Compiled module: LOADCT.</code>
140   <code class="computeroutput">% Compiled module: FILEPATH.</code>
141   <code class="computeroutput">% Compiled module: PATH_SEP.</code>
142   <code class="computeroutput">% Compiled module: CW_FIELD.</code>
143   <code class="computeroutput">% Compiled module: STRSPLIT.</code>
144   <code class="computeroutput">% Compiled module: CW_FIELD.</code>
145   <code class="computeroutput">% Compiled module: CW_FIELD.</code>
146   <code class="computeroutput">% Compiled module: CW_FIELD.</code>
147   <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">exit</strong></span></code></strong>
148        </pre><p>
149        There is an example of the kind of <a href="idlfiles/init_example.pro?format=raw" target="_top"> <code class="filename">init.pro</code></a> you should get.
150      </p></div></div></body></html>
Note: See TracBrowser for help on using the repository browser.