1 | <?xml version='1.0' encoding='iso-8859-1'?> |
---|
2 | <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
---|
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" |
---|
4 | [ |
---|
5 | <!ENTITY promptidl "idl>"> |
---|
6 | <!ENTITY numb1 '<inlinemediaobject><imageobject><imagedata fileref="images/callouts/1.png" format="PNG"/></imageobject><textobject><phrase>1</phrase></textobject></inlinemediaobject>'> |
---|
7 | <!ENTITY numb2 '<inlinemediaobject><imageobject><imagedata fileref="images/callouts/2.png" format="PNG"/></imageobject><textobject><phrase>2</phrase></textobject></inlinemediaobject>'> |
---|
8 | <!ENTITY showfig '<inlinemediaobject><imageobject><imagedata fileref="images/showfig.png" format="PNG"/></imageobject><textobject><phrase>show result</phrase></textobject></inlinemediaobject>'> |
---|
9 | ]> |
---|
10 | |
---|
11 | |
---|
12 | <article lang="en"> |
---|
13 | <title> |
---|
14 | Get <application>SAXO</application> |
---|
15 | </title> |
---|
16 | |
---|
17 | <articleinfo> |
---|
18 | <authorgroup> |
---|
19 | <author><firstname>Sébastien</firstname><surname>Masson</surname><email>smasson_at_lodyc.jussieu.fr</email></author> |
---|
20 | <author><firstname>Françoise</firstname><surname>Pinsard</surname><email>fplod_at_lodyc.jussieu.fr</email></author> |
---|
21 | </authorgroup> |
---|
22 | <keywordset> |
---|
23 | <keyword>idl</keyword> |
---|
24 | <keyword>SAXO</keyword> |
---|
25 | </keywordset> |
---|
26 | <revhistory> |
---|
27 | <revision> |
---|
28 | <revnumber>0.0</revnumber> |
---|
29 | <date>May 2006</date> |
---|
30 | <revremark>First draft</revremark> |
---|
31 | </revision> |
---|
32 | </revhistory> |
---|
33 | </articleinfo> |
---|
34 | |
---|
35 | <!-- 1st part --> |
---|
36 | |
---|
37 | <sect1 id="create_saxo_env"> |
---|
38 | <title> |
---|
39 | Create <application>SAXO</application> environment |
---|
40 | </title> |
---|
41 | <para> |
---|
42 | To simplify the explanation, we suppose that we install <application>SAXO</application> in your <filename class='directory'><envar>${HOME}</envar></filename>. |
---|
43 | We need to create 2 directories: |
---|
44 | <itemizedlist> |
---|
45 | <listitem><simpara><filename class='directory'><envar>${HOME}</envar>/SAXO_DIR</filename> that will contain the source files of <application>SAXO</application>. It should not be modified by the user to simplify later updates</simpara></listitem> |
---|
46 | <listitem><simpara><filename class='directory'><envar>${HOME}</envar>/My_IDL</filename> that will contain user personal files (including modified <application>SAXO</application> files, if needed).</simpara></listitem> |
---|
47 | </itemizedlist> |
---|
48 | </para> |
---|
49 | <para> |
---|
50 | <screen format="linespecific"> |
---|
51 | <prompt>$</prompt> <userinput><command>cd</command> <parameter><envar>${HOME}</envar></parameter></userinput> |
---|
52 | <prompt>$</prompt> <userinput><command>mkdir</command> <parameter>My_IDL</parameter></userinput> |
---|
53 | </screen> |
---|
54 | </para> |
---|
55 | </sect1> |
---|
56 | |
---|
57 | <!-- 2nd part --> |
---|
58 | |
---|
59 | <sect1 id="get_saxo_files"> |
---|
60 | <title> |
---|
61 | Get <application>SAXO</application> files |
---|
62 | </title> |
---|
63 | |
---|
64 | <!-- 2.1 --> |
---|
65 | |
---|
66 | <sect2 id="saxo_local"> |
---|
67 | <title> |
---|
68 | If you work at IDRIS, IPSL or LOCEAN |
---|
69 | </title> |
---|
70 | <para> |
---|
71 | <application>SAXO</application> is already installed at |
---|
72 | <itemizedlist> |
---|
73 | <listitem><simpara>IDRIS, on rhodes: <filename class='directory'>/home/rech/eee/reee217/SAXO_DIR</filename></simpara></listitem> |
---|
74 | <listitem><simpara>IPSL: <filename class='directory'>/home/smlod/SAXO_DIR</filename></simpara></listitem> |
---|
75 | <listitem><simpara>LOCEAN: <filename class='directory'>/usr/home/smasson/SAXO_DIR</filename></simpara></listitem> |
---|
76 | </itemizedlist> |
---|
77 | If you can access one of theses directories, there is no need to re-install <application>SAXO</application> again! In that case, you only have to link <filename class='directory'><envar>${HOME}</envar>/SAXO_DIR</filename> to the appropiate directory: |
---|
78 | <variablelist> |
---|
79 | <varlistentry><term><command>IDRIS</command></term> |
---|
80 | <listitem><screen> |
---|
81 | <prompt>$</prompt> <userinput><command>ln</command> <option>-s</option> <parameter>/home/rech/eee/reee217/SAXO_DIR</parameter> <parameter><envar>${HOME}</envar>/SAXO_DIR</parameter></userinput> |
---|
82 | </screen></listitem> |
---|
83 | </varlistentry> |
---|
84 | <varlistentry><term><command>IPSL</command></term> |
---|
85 | <listitem><screen> |
---|
86 | <prompt>$</prompt> <userinput><command>ln</command> <option>-s</option> <parameter>/home/smlod/SAXO_DIR</parameter> <parameter><envar>${HOME}</envar>/SAXO_DIR</parameter></userinput> |
---|
87 | </screen></listitem> |
---|
88 | </varlistentry> |
---|
89 | <varlistentry><term><command>LOCEAN</command></term> |
---|
90 | <listitem><screen> |
---|
91 | <prompt>$</prompt> <userinput><command>ln</command> <option>-s</option> <parameter>/usr/home/smasson/SAXO_DIR</parameter> <parameter><envar>${HOME}</envar>/SAXO_DIR</parameter></userinput> |
---|
92 | </screen></listitem> |
---|
93 | </varlistentry> |
---|
94 | </variablelist> |
---|
95 | </para> |
---|
96 | </sect2> |
---|
97 | |
---|
98 | <!-- 2.2 --> |
---|
99 | |
---|
100 | <sect2 id="saxo_svn"> |
---|
101 | <title> |
---|
102 | If <ulink url="http://subversion.tigris.org/"><application> Subversion (svn)</application></ulink> is installed on your machine |
---|
103 | </title> |
---|
104 | <!-- 2.2.1 --> |
---|
105 | <sect3 id="saxo_svn_users"> |
---|
106 | <title> |
---|
107 | Regular users |
---|
108 | </title> |
---|
109 | <para> |
---|
110 | The <emphasis role="bold">complete</emphasis> latest revision (source + tests data files: &szallsvn; Mb) can be checked out with the following command executed in your <envar>${HOME}</envar>: |
---|
111 | <screen format="linespecific"> |
---|
112 | <prompt>$</prompt> <userinput><command>svn</command> <option>checkout</option> <parameter>http://forge.ipsl.jussieu.fr/saxo/svn/trunk/</parameter> <parameter>SAXO_DIR</parameter></userinput> |
---|
113 | </screen> |
---|
114 | </para> |
---|
115 | <para> |
---|
116 | The latest revision of the <command>source files</command> (&szsrcsvn; Mb) can be checked out with the following command: |
---|
117 | <screen format="linespecific"> |
---|
118 | <prompt>$</prompt> <userinput><command>svn</command> <option>checkout</option> <parameter>http://forge.ipsl.jussieu.fr/saxo/svn/trunk/SRC</parameter> <parameter>SAXO_DIR/SRC</parameter></userinput> |
---|
119 | </screen> |
---|
120 | </para> |
---|
121 | <para> |
---|
122 | The latest revision of the <command>NetCDF data files</command> (&szdatasvn; Mb) used by the test programs can be checked out with the following command: |
---|
123 | <screen format="linespecific"> |
---|
124 | <prompt>$</prompt> <userinput><command>svn</command> <option>checkout</option> <parameter>http://forge.ipsl.jussieu.fr/saxo/svn/trunk/DATA</parameter> <parameter>SAXO_DIR/DATA</parameter></userinput> |
---|
125 | </screen> |
---|
126 | </para> |
---|
127 | </sect3> |
---|
128 | <!-- 2.2.2 --> |
---|
129 | <sect3 id="saxo_svn_contributors"> |
---|
130 | <title> |
---|
131 | Contributors |
---|
132 | </title> |
---|
133 | <para> |
---|
134 | <command>Contributors</command> should better use the following command (and replace login by your own login): |
---|
135 | <screen format="linespecific"> |
---|
136 | <prompt>$</prompt> <userinput><command>svn</command> <option>checkout</option> <parameter>svn+ssh://<replaceable>login</replaceable>@forge.ipsl.jussieu.fr/ipsl/forge/projets/saxo/svn/trunk/</parameter> <parameter>SAXO_DIR</parameter></userinput> |
---|
137 | </screen> |
---|
138 | </para> |
---|
139 | </sect3> |
---|
140 | </sect2> |
---|
141 | |
---|
142 | <!-- 2.3 --> |
---|
143 | |
---|
144 | <sect2 id="saxo_tar"> |
---|
145 | <title> |
---|
146 | Get <application>SAXO</application> from a tar file |
---|
147 | </title> |
---|
148 | <!-- 2.3.1 --> |
---|
149 | <sect3 id="saxo_src_tar"> |
---|
150 | <title> |
---|
151 | Get <application>SAXO</application> source files (&szsrc; Mb) |
---|
152 | </title> |
---|
153 | <para> |
---|
154 | Create your <filename class='directory'><envar>${HOME}</envar>/SAXO_DIR</filename> directory... |
---|
155 | <screen format="linespecific"> |
---|
156 | <prompt>$</prompt> <userinput><command>cd</command> <parameter><envar>${HOME}</envar></parameter></userinput> |
---|
157 | <prompt>$</prompt> <userinput><command>mkdir</command> <parameter>SAXO_DIR</parameter></userinput> |
---|
158 | <prompt>$</prompt> <userinput><command>cd</command> <parameter>SAXO_DIR</parameter></userinput> |
---|
159 | </screen> |
---|
160 | ... and download it the latest version of the sources tar file: <ulink url="http://forge.ipsl.jussieu.fr/saxo/download/SAXO_SRC_&date;.tar.gz">SAXO_SRC_&date;.tar.gz</ulink> (&szsrc; Mb). This tar.gz file could also be downloaded with |
---|
161 | <variablelist> |
---|
162 | <varlistentry><term><command>wget</command></term> |
---|
163 | <listitem><screen> |
---|
164 | <prompt>$</prompt> <userinput><command>wget</command> <parameter>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_SRC_&date;.tar.gz</parameter></userinput> |
---|
165 | </screen></listitem> |
---|
166 | </varlistentry> |
---|
167 | <varlistentry><term><command>curl</command></term> |
---|
168 | <listitem><screen> |
---|
169 | <prompt>$</prompt> <userinput><command>curl</command> <option>-O</option> <parameter>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_SRC_&date;.tar.gz</parameter></userinput> |
---|
170 | </screen></listitem> |
---|
171 | </varlistentry> |
---|
172 | </variablelist> |
---|
173 | Untar the file |
---|
174 | <screen format="linespecific"> |
---|
175 | <prompt>$</prompt> <userinput><command>cd</command> <parameter><envar>${HOME}</envar>/SAXO_DIR</parameter></userinput> |
---|
176 | <prompt>$</prompt> <userinput><command>tar</command> <option>xvfz</option> <parameter>SAXO_SRC_&date;.tar.gz</parameter></userinput> |
---|
177 | <prompt>$</prompt> <userinput><command>rm</command> <parameter>SAXO_SRC_&date;.tar.gz</parameter></userinput> |
---|
178 | </screen> |
---|
179 | </para> |
---|
180 | |
---|
181 | </sect3> |
---|
182 | <!-- 2.3.2 --> |
---|
183 | <sect3 id="saxo_data_tar"> |
---|
184 | <title> |
---|
185 | Get <application>SAXO</application> tests data files (&szdata; Mb) |
---|
186 | </title> |
---|
187 | <para> |
---|
188 | If you want to use the tests programs, you need to download the data tests files (<filename>SAXO_DATA_&date2;.tar.gz</filename>), You may download theses files in |
---|
189 | <itemizedlist> |
---|
190 | <listitem><simpara><filename class='directory'><envar>${HOME}</envar>/My_IDL</filename>. This is the easiest solution but it could be unconvenient if your <envar>${HOME}</envar> disk space is limited.</simpara></listitem> |
---|
191 | <listitem><simpara>any other Directory of your choice. In that case, when using IDL, you will need to define the variable <varname>iodir</varname> 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 <link linkend="generate_init"><xref linkend="generate_init"/></link>) or directly within IDL with the following commad: <prompt>&promptidl;</prompt> <userinput><command>iodir = <replaceable>the chosen directory</replaceable></command></userinput></simpara></listitem> |
---|
192 | </itemizedlist> |
---|
193 | <screen format="linespecific"> |
---|
194 | <prompt>$</prompt> <userinput><command>cd</command> <parameter><envar>${HOME}</envar></parameter></userinput> |
---|
195 | <prompt>$</prompt> <userinput><command>mkdir</command> <parameter><replaceable>CHOSEN_DIR</replaceable></parameter></userinput> |
---|
196 | <prompt>$</prompt> <userinput><command>cd</command> <parameter><replaceable>CHOSEN_DIR</replaceable></parameter></userinput> |
---|
197 | </screen> |
---|
198 | Download <ulink url="http://forge.ipsl.jussieu.fr/saxo/download/SAXO_DATA_&date2;.tar.gz">SAXO_DATA_&date2;.tar.gz</ulink> (&szdata; Mb) |
---|
199 | ... or with |
---|
200 | <variablelist> |
---|
201 | <varlistentry><term><command>wget</command></term> |
---|
202 | <listitem><screen> |
---|
203 | <prompt>$</prompt> <userinput><command>wget</command> <parameter>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_DATA_&date2;.tar.gz</parameter></userinput> |
---|
204 | </screen></listitem> |
---|
205 | </varlistentry> |
---|
206 | <varlistentry><term><command>curl</command></term> |
---|
207 | <listitem><screen> |
---|
208 | <prompt>$</prompt> <userinput><command>curl</command> <option>-O</option> <parameter>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_DATA_&date2;.tar.gz</parameter></userinput> |
---|
209 | </screen></listitem> |
---|
210 | </varlistentry> |
---|
211 | </variablelist> |
---|
212 | </para> |
---|
213 | </sect3> |
---|
214 | </sect2> |
---|
215 | </sect1> |
---|
216 | <!-- 3 --> |
---|
217 | <sect1 id="generate_init"> |
---|
218 | <title> |
---|
219 | Generate your init.pro file |
---|
220 | </title> |
---|
221 | <para> |
---|
222 | To use <application>SAXO</application>, we need to build an idl script that we usually call "<filename>init.pro</filename>". This file contains a set of IDL commands and default definitions (paths and variables of the common files) that are necessary to <application>SAXO</application>. Once it has ben created, <filename>init.pro</filename> should the first executed command when starting IDL session. |
---|
223 | </para> |
---|
224 | <para> |
---|
225 | <screen format="linespecific"> |
---|
226 | <prompt>$</prompt> <userinput><command>cd <envar>${HOME}</envar>/SAXO_DIR/SRC</command></userinput> |
---|
227 | <prompt>$</prompt> <userinput><command>idl</command></userinput> |
---|
228 | <computeroutput>IDL Version 6.0, Mac OS X (darwin ppc m32). (c) 2003, Research Systems, Inc.</computeroutput> |
---|
229 | <!-- |
---|
230 | <computeroutput>Installation number: 35411.</computeroutput> |
---|
231 | <computeroutput>Licensed for personal use by Jean-Philippe BOULANGER only.</computeroutput> |
---|
232 | <computeroutput>All other use is strictly prohibited.</computeroutput> |
---|
233 | --> |
---|
234 | <prompt>&promptidl;</prompt> <userinput><command>buildinit</command></userinput> |
---|
235 | <computeroutput>% Compiled module: BUILDINIT.</computeroutput> |
---|
236 | </screen> |
---|
237 | You must then answer several questions: |
---|
238 | <!-- <itemizedlist mark='opencircle'> --> |
---|
239 | <itemizedlist> |
---|
240 | <listitem><simpara>give the path of <filename class='directory'><envar>${HOME}</envar>/My_IDL</filename></simpara></listitem> |
---|
241 | <listitem><simpara>give the path of <filename class='directory'><envar>${HOME}</envar>/SAXO_DIR</filename></simpara></listitem> |
---|
242 | <listitem><simpara>compatibility with the old version: No (except if you want to use old programs)</simpara></listitem> |
---|
243 | <listitem><simpara>give a default path for the data directory</simpara></listitem> |
---|
244 | <listitem><simpara>give a default path for the postscript directory</simpara></listitem> |
---|
245 | <listitem><simpara>give a default path for the images directory</simpara></listitem> |
---|
246 | <listitem><simpara>give a default path for the animation directory</simpara></listitem> |
---|
247 | <listitem><simpara>number of accessible printer and their configuration</simpara></listitem> |
---|
248 | <listitem><simpara>default color table</simpara></listitem> |
---|
249 | <listitem><simpara>default page orientation (portrait/landscape)</simpara></listitem> |
---|
250 | <listitem><simpara>default page size</simpara></listitem> |
---|
251 | <listitem><simpara>default window size</simpara></listitem> |
---|
252 | <listitem><simpara>postscript archiving options</simpara></listitem> |
---|
253 | <listitem><simpara>name of the init file (<filename>init.pro</filename>)</simpara></listitem> |
---|
254 | </itemizedlist> |
---|
255 | <screen format="linespecific"> |
---|
256 | <computeroutput>% Compiled module: CW_FIELD.</computeroutput> |
---|
257 | <computeroutput>% Compiled module: XMANAGER.</computeroutput> |
---|
258 | <computeroutput>% Compiled module: LOADCT.</computeroutput> |
---|
259 | <computeroutput>% Compiled module: FILEPATH.</computeroutput> |
---|
260 | <computeroutput>% Compiled module: PATH_SEP.</computeroutput> |
---|
261 | <computeroutput>% Compiled module: CW_FIELD.</computeroutput> |
---|
262 | <computeroutput>% Compiled module: STRSPLIT.</computeroutput> |
---|
263 | <computeroutput>% Compiled module: CW_FIELD.</computeroutput> |
---|
264 | <computeroutput>% Compiled module: CW_FIELD.</computeroutput> |
---|
265 | <computeroutput>% Compiled module: CW_FIELD.</computeroutput> |
---|
266 | <prompt>&promptidl;</prompt> <userinput><command>exit</command></userinput> |
---|
267 | </screen> |
---|
268 | There is an example of the kind of <ulink url="idlfiles/init_example.pro?format=raw"> <filename>init.pro</filename></ulink> you should get. |
---|
269 | </para> |
---|
270 | </sect1> |
---|
271 | </article> |
---|