1 | <?xml version="1.0" encoding="utf-8"?> |
---|
2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
---|
3 | <html xmlns="http://www.w3.org/1999/xhtml"> |
---|
4 | <head> |
---|
5 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
---|
6 | <title>Get SAXO</title> |
---|
7 | <link rel="stylesheet" href="style.css" type="text/css" /> |
---|
8 | <link rel="stylesheet" href="saxo.css" type="text/css" /> |
---|
9 | <link rev="made" href="mailto:saxo-dev_at_forge.ipsl.jussieu.fr" /> |
---|
10 | <meta name="generator" content="DocBook XSL Stylesheets V1.74.3" /> |
---|
11 | <meta name="keywords" content="IDL, SAXO" /> |
---|
12 | </head> |
---|
13 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
---|
14 | <div class="article" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="getsaxo" id="getsaxo"></a>Get <span class="application">SAXO</span></h2></div><div><div class="authorgroup"> |
---|
15 | <div class="author"><h3 class="author"><span class="firstname">Sébastien</span> <span class="surname">Masson</span> <code class="email"><<a class="email" href="mailto:Sebastien.Masson_at_locean-ipsl.upmc.fr">Sebastien.Masson_at_locean-ipsl.upmc.fr</a>></code></h3></div> |
---|
16 | <div class="author"><h3 class="author"><span class="firstname">Françoise</span> <span class="surname">Pinsard</span> <code class="email"><<a class="email" href="mailto:Francoise.Pinsard_at_locean-ipsl.upmc.fr">Francoise.Pinsard_at_locean-ipsl.upmc.fr</a>></code></h3></div> |
---|
17 | </div></div><div><span class="pubdate">svn Id of xml source file : $Id$<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> |
---|
18 | <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> |
---|
19 | <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> |
---|
20 | </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 SAXO environment </a></span></dt><dt><span class="sect1"><a href="#get_saxo_files">2. Get SAXO 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 ??? is installed on your machine </a></span></dt><dt><span class="sect2"><a href="#saxo_tar">2.3. Get SAXO 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> |
---|
21 | |
---|
22 | |
---|
23 | |
---|
24 | |
---|
25 | |
---|
26 | |
---|
27 | |
---|
28 | <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"></a>1. Create <span class="application">SAXO</span> environment </h2></div></div></div> |
---|
29 | |
---|
30 | <p> |
---|
31 | To simplify the explanation, we suppose that we install <span class="application">SAXO</span> in your <code class="filename">${HOME}</code>. |
---|
32 | We need to create 2 directories: |
---|
33 | </p><div class="itemizedlist"><ul type="disc"><li> |
---|
34 | <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. |
---|
35 | |
---|
36 | </li><li> |
---|
37 | <code class="filename">${HOME}/My_IDL</code> that will contain user personal files (including modified <span class="application">SAXO</span> files, if needed). |
---|
38 | |
---|
39 | </li></ul></div><p> |
---|
40 | </p> |
---|
41 | <p> |
---|
42 | </p><pre class="screen"> |
---|
43 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>cd</strong></span> <em class="parameter"><code>${HOME}</code></em></code></strong> |
---|
44 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>mkdir</strong></span> <em class="parameter"><code>My_IDL</code></em></code></strong> |
---|
45 | </pre><p> |
---|
46 | </p> |
---|
47 | </div> |
---|
48 | |
---|
49 | |
---|
50 | |
---|
51 | <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"></a>2. Get <span class="application">SAXO</span> files </h2></div></div></div> |
---|
52 | |
---|
53 | |
---|
54 | |
---|
55 | |
---|
56 | <div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="saxo_local" id="saxo_local"></a>2.1. If you work at IDRIS, IPSL or LOCEAN </h3></div></div></div> |
---|
57 | |
---|
58 | <p> |
---|
59 | <span class="application">SAXO</span> is already installed at |
---|
60 | </p><div class="itemizedlist"><ul type="disc"><li> |
---|
61 | IDRIS, on <code class="systemitem">rhodes</code>: <code class="filename">/home/rech/eee/reee217/SAXO_DIR</code> |
---|
62 | |
---|
63 | </li><li> |
---|
64 | IPSL: <code class="filename">/home/smlod/SAXO_DIR</code> |
---|
65 | |
---|
66 | </li><li> |
---|
67 | LOCEAN: <code class="filename">/usr/home/smasson/SAXO_DIR</code> |
---|
68 | |
---|
69 | </li></ul></div><p> |
---|
70 | If you can access one of these 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: |
---|
71 | </p><div class="variablelist"><dl><dt><span class="term">IDRIS</span></dt><dd><pre class="screen"> |
---|
72 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>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> |
---|
73 | </pre> |
---|
74 | </dd><dt><span class="term">IPSL</span></dt><dd><pre class="screen"> |
---|
75 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>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> |
---|
76 | </pre> |
---|
77 | </dd><dt><span class="term">LOCEAN</span></dt><dd><pre class="screen"> |
---|
78 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>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> |
---|
79 | </pre> |
---|
80 | </dd></dl></div><p> |
---|
81 | </p> |
---|
82 | </div> |
---|
83 | |
---|
84 | |
---|
85 | |
---|
86 | <div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="saxo_svn" id="saxo_svn"></a>2.2. If <a class="link" href="http://subversion.tigris.org/" target="_top"><span class="application"> Subversion (svn)</span></a> is installed on your machine </h3></div></div></div> |
---|
87 | |
---|
88 | |
---|
89 | <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"></a>2.2.1. Regular users </h4></div></div></div> |
---|
90 | |
---|
91 | <p> |
---|
92 | The <span class="bold"><strong>complete</strong></span> latest revision (source + tests data files: 762 Mb) can be checked out with the following command executed in your <code class="envar">${HOME}</code>: |
---|
93 | </p><pre class="screen"> |
---|
94 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>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> |
---|
95 | </pre><p> |
---|
96 | </p> |
---|
97 | <p> |
---|
98 | The latest revision of the <span class="bold"><strong>source files</strong></span> (35 Mb) can be checked out with the following command: |
---|
99 | </p><pre class="screen"> |
---|
100 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>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> |
---|
101 | </pre><p> |
---|
102 | </p> |
---|
103 | <p> |
---|
104 | The latest revision of the <span class="bold"><strong>NetCDF data files</strong></span> (727 Mb) used by the test programs can be checked out with the following command: |
---|
105 | </p><pre class="screen"> |
---|
106 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>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> |
---|
107 | </pre><p> |
---|
108 | </p> |
---|
109 | </div> |
---|
110 | |
---|
111 | <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"></a>2.2.2. Contributors </h4></div></div></div> |
---|
112 | |
---|
113 | <p> |
---|
114 | <span class="bold"><strong>Contributors</strong></span> should better use the following command (and replace login by their own login): |
---|
115 | </p><pre class="screen"> |
---|
116 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>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> |
---|
117 | </pre><p> |
---|
118 | </p> |
---|
119 | </div> |
---|
120 | </div> |
---|
121 | |
---|
122 | |
---|
123 | |
---|
124 | <div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="saxo_tar" id="saxo_tar"></a>2.3. Get <span class="application">SAXO</span> from a tar file </h3></div></div></div> |
---|
125 | |
---|
126 | |
---|
127 | <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"></a>2.3.1. Get <span class="application">SAXO</span> source files ( Mb) </h4></div></div></div> |
---|
128 | |
---|
129 | <p> |
---|
130 | Create your <code class="filename">${HOME}/SAXO_DIR</code> directory ⊠|
---|
131 | </p><pre class="screen"> |
---|
132 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>cd</strong></span> <em class="parameter"><code>${HOME}</code></em></code></strong> |
---|
133 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>mkdir</strong></span> <em class="parameter"><code>SAXO_DIR</code></em></code></strong> |
---|
134 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>cd</strong></span> <em class="parameter"><code>SAXO_DIR</code></em></code></strong> |
---|
135 | </pre><p> |
---|
136 | </p> |
---|
137 | <p> |
---|
138 | ⊠and download it the latest version of the sources tar file: <a class="link" href="http://forge.ipsl.jussieu.fr/saxo/download/SAXO_SRC_.tar.gz" target="_top">SAXO_SRC_.tar.gz</a> ( Mb). |
---|
139 | </p> |
---|
140 | <p> |
---|
141 | This tar.gz file could also be downloaded with <span class="command"><strong>wget</strong></span> or <span class="command"><strong>curl</strong></span> |
---|
142 | </p><div class="variablelist"><dl><dt><span class="term"><span class="command"><strong>wget</strong></span></span></dt><dd><pre class="screen"> |
---|
143 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>wget</strong></span> <em class="parameter"><code>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_SRC_.tar.gz</code></em></code></strong> |
---|
144 | </pre> |
---|
145 | </dd><dt><span class="term"><span class="command"><strong>curl</strong></span></span></dt><dd><pre class="screen"> |
---|
146 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>curl</strong></span> <code class="option">-O</code> <em class="parameter"><code>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_SRC_.tar.gz</code></em></code></strong> |
---|
147 | </pre> |
---|
148 | </dd></dl></div><p> |
---|
149 | Untar the file |
---|
150 | </p><pre class="screen"> |
---|
151 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>cd</strong></span> <em class="parameter"><code>${HOME}/SAXO_DIR</code></em></code></strong> |
---|
152 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>tar</strong></span> <code class="option">xvfz</code> <em class="parameter"><code>SAXO_SRC_.tar.gz</code></em></code></strong> |
---|
153 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>rm</strong></span> <em class="parameter"><code>SAXO_SRC_.tar.gz</code></em></code></strong> |
---|
154 | </pre><p> |
---|
155 | </p> |
---|
156 | |
---|
157 | </div> |
---|
158 | |
---|
159 | <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"></a>2.3.2. Get <span class="application">SAXO</span> tests data files (238M Mb) </h4></div></div></div> |
---|
160 | |
---|
161 | <p> |
---|
162 | 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 these files in |
---|
163 | </p><div class="itemizedlist"><ul type="disc"><li> |
---|
164 | <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. |
---|
165 | |
---|
166 | </li><li> |
---|
167 | <p>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 class="xref" href="#generate_init" title="3. Generate your init.pro file">Section 3, â Generate your init.pro file â</a>) or directly within IDL with the following command: |
---|
168 | </p><pre class="screen"> |
---|
169 | <code class="prompt">idl></code> <strong class="userinput"><code><span class="command"><strong>iodir = <em class="replaceable"><code>the chosen directory</code></em></strong></span></code></strong> |
---|
170 | </pre><p> |
---|
171 | </p> |
---|
172 | </li></ul></div><p> |
---|
173 | </p><pre class="screen"> |
---|
174 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>cd</strong></span> <em class="parameter"><code>${HOME}</code></em></code></strong> |
---|
175 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>mkdir</strong></span> <em class="parameter"><code><em class="replaceable"><code>CHOSEN_DIR</code></em></code></em></code></strong> |
---|
176 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>cd</strong></span> <em class="parameter"><code><em class="replaceable"><code>CHOSEN_DIR</code></em></code></em></code></strong> |
---|
177 | </pre><p> |
---|
178 | Download <a class="link" href="http://forge.ipsl.jussieu.fr/saxo/download/SAXO_DATA_20060602.tar.gz" target="_top">SAXO_DATA_20060602.tar.gz</a> (238M Mb) |
---|
179 | or with <span class="command"><strong>wget</strong></span> or <span class="command"><strong>curl</strong></span> ⊠|
---|
180 | </p><div class="variablelist"><dl><dt><span class="term"><span class="command"><strong>wget</strong></span></span></dt><dd><pre class="screen"> |
---|
181 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>wget</strong></span> <em class="parameter"><code>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_DATA_20060602.tar.gz</code></em></code></strong> |
---|
182 | </pre> |
---|
183 | </dd><dt><span class="term"><span class="command"><strong>curl</strong></span></span></dt><dd><pre class="screen"> |
---|
184 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>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> |
---|
185 | </pre> |
---|
186 | </dd></dl></div><p> |
---|
187 | </p> |
---|
188 | </div> |
---|
189 | </div> |
---|
190 | </div> |
---|
191 | |
---|
192 | <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"></a>3. Generate your init.pro file </h2></div></div></div> |
---|
193 | |
---|
194 | <p> |
---|
195 | 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. |
---|
196 | </p> |
---|
197 | <p> |
---|
198 | </p><pre class="screen"> |
---|
199 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>cd</strong></span> <em class="parameter"><code>${HOME}/SAXO_DIR/SRC</code></em></code></strong> |
---|
200 | <code class="prompt">$</code> <strong class="userinput"><code><span class="command"><strong>idl</strong></span></code></strong> |
---|
201 | <code class="computeroutput">IDL Version 6.0, Mac OS X (darwin ppc m32). (c) 2003, Research Systems, Inc.</code> |
---|
202 | |
---|
203 | <code class="prompt">idl></code> <strong class="userinput"><code><span class="command"><strong>buildinit</strong></span></code></strong> |
---|
204 | <code class="computeroutput">% Compiled module: BUILDINIT.</code> |
---|
205 | </pre><p> |
---|
206 | </p> |
---|
207 | <p> |
---|
208 | You must then answer several questions: |
---|
209 | |
---|
210 | </p><div class="itemizedlist"><ul type="disc"><li> |
---|
211 | give the path of <code class="filename">${HOME}/My_IDL</code> |
---|
212 | </li><li> |
---|
213 | give the path of <code class="filename">${HOME}/SAXO_DIR</code> |
---|
214 | </li><li> |
---|
215 | compatibility with the old version: No (except if you want to use old programs) |
---|
216 | </li><li> |
---|
217 | give a default path for the data directory |
---|
218 | </li><li> |
---|
219 | give a default path for the postscript directory |
---|
220 | </li><li> |
---|
221 | give a default path for the images directory |
---|
222 | </li><li> |
---|
223 | give a default path for the animation directory |
---|
224 | </li><li> |
---|
225 | number of accessible printer and their configuration |
---|
226 | </li><li> |
---|
227 | default color table |
---|
228 | </li><li> |
---|
229 | default page orientation (portrait/landscape) |
---|
230 | </li><li> |
---|
231 | default page size |
---|
232 | </li><li> |
---|
233 | default window size |
---|
234 | </li><li> |
---|
235 | postscript archiving options |
---|
236 | </li><li> |
---|
237 | name of the init file (<code class="filename">init.pro</code>) |
---|
238 | </li></ul></div><p> |
---|
239 | </p> |
---|
240 | <p> |
---|
241 | </p><pre class="screen"> |
---|
242 | <code class="computeroutput">% Compiled module: CW_FIELD.</code> |
---|
243 | <code class="computeroutput">% Compiled module: XMANAGER.</code> |
---|
244 | <code class="computeroutput">% Compiled module: LOADCT.</code> |
---|
245 | <code class="computeroutput">% Compiled module: FILEPATH.</code> |
---|
246 | <code class="computeroutput">% Compiled module: PATH_SEP.</code> |
---|
247 | <code class="computeroutput">% Compiled module: CW_FIELD.</code> |
---|
248 | <code class="computeroutput">% Compiled module: STRSPLIT.</code> |
---|
249 | <code class="computeroutput">% Compiled module: CW_FIELD.</code> |
---|
250 | <code class="computeroutput">% Compiled module: CW_FIELD.</code> |
---|
251 | <code class="computeroutput">% Compiled module: CW_FIELD.</code> |
---|
252 | <code class="prompt">idl></code> <strong class="userinput"><code><span class="command"><strong>exit</strong></span></code></strong> |
---|
253 | </pre><p> |
---|
254 | </p> |
---|
255 | <p> |
---|
256 | There is an example of the kind of <a class="link" href="idlfiles/init_example.pro" target="_top"> <code class="filename">init.pro</code></a> you should get. |
---|
257 | </p> |
---|
258 | </div> |
---|
259 | <div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="aftergetsaxo" id="aftergetsaxo"></a>4. After this</h2></div></div></div> |
---|
260 | |
---|
261 | <p> |
---|
262 | You are now ready to do your |
---|
263 | <a class="link" href="./firststeps.html" target="_top">First steps with SAXO</a>. |
---|
264 | </p> |
---|
265 | </div> |
---|
266 | </div> |
---|
267 | </body> |
---|
268 | </html> |
---|