source: trunk/SRC/Documentation/xmldoc/getsaxo.xml @ 193

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

add ENTITY hellip in xml files using it, necessary because I don't know yet how to handle entity with xmllint (1/2).
  • Property svn:keywords set to Id
File size: 14.9 KB
Line 
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 hellip "&#x2026;">
6<!ENTITY promptidl "idl&gt;">
7]>
8<!--
9-->
10<article lang="en">
11  <title>
12    Get <application>SAXO</application>
13  </title>
14 
15  <articleinfo>
16    <authorgroup>
17      <author><firstname>Sébastien</firstname><surname>Masson</surname><email>Sebastien.Masson_at_locean-ipsl.upmc.fr</email></author>
18      <author><firstname>Françoise</firstname><surname>Pinsard</surname><email>Francoise.Pinsard_at_locean-ipsl.upmc.fr</email></author>
19    </authorgroup>
20    <keywordset>
21      <keyword>IDL</keyword>
22      <keyword>SAXO</keyword>
23    </keywordset>
24    <revhistory>
25      <revision>
26        <revnumber>0.0</revnumber>
27        <date>May 2006</date>
28        <revremark>First draft</revremark>
29      </revision>
30    </revhistory> 
31   <pubdate>$Id$</pubdate>
32  </articleinfo>
33
34  <!--  1st part -->
35
36  <sect1 id="create_saxo_env">
37    <title>
38      Create <application>SAXO</application> environment
39    </title>
40    <para>
41      To simplify the explanation, we suppose that we install <application>SAXO</application> in your <filename class='directory'><envar>${HOME}</envar></filename>.
42      We need to create 2 directories:
43      <itemizedlist>
44        <listitem>
45         <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
46         </simpara>
47        </listitem>
48        <listitem>
49         <simpara><filename class='directory'><envar>${HOME}</envar>/My_IDL</filename> that will contain user personal files (including modified <application>SAXO</application> files, if needed).
50         </simpara>
51       </listitem>
52      </itemizedlist>
53    </para>
54    <para>
55      <screen format="linespecific">
56  <prompt>$</prompt> <userinput><command>cd</command> <parameter><envar>${HOME}</envar></parameter></userinput>
57  <prompt>$</prompt> <userinput><command>mkdir</command> <parameter>My_IDL</parameter></userinput>
58      </screen>
59    </para>
60  </sect1>
61
62  <!--  2nd part -->
63
64 <sect1 id="get_saxo_files">
65    <title>
66      Get <application>SAXO</application> files
67    </title>
68
69  <!--  2.1 -->
70
71    <sect2 id="saxo_local">
72      <title>
73        If you work at IDRIS, IPSL or LOCEAN
74      </title>
75      <para>
76        <application>SAXO</application> is already installed at
77        <itemizedlist>
78          <listitem>
79           <simpara>IDRIS, on <systemitem class="systemname">rhodes</systemitem>: <filename class='directory'>/home/rech/eee/reee217/SAXO_DIR</filename>
80           </simpara>
81          </listitem>
82          <listitem>
83           <simpara>IPSL: <filename class='directory'>/home/smlod/SAXO_DIR</filename>
84           </simpara>
85          </listitem>
86          <listitem>
87           <simpara>LOCEAN: <filename class='directory'>/usr/home/smasson/SAXO_DIR</filename>
88           </simpara>
89         </listitem>
90        </itemizedlist>
91        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 appropriate directory:
92        <variablelist>
93          <varlistentry><term><emphasis role="bold">IDRIS</emphasis></term>
94          <listitem><screen>
95  <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>
96          </screen>
97         </listitem>
98          </varlistentry>
99          <varlistentry><term><emphasis role="bold">IPSL</emphasis></term>
100          <listitem><screen>
101  <prompt>$</prompt> <userinput><command>ln</command> <option>-s</option> <parameter>/home/smlod/SAXO_DIR</parameter> <parameter><envar>${HOME}</envar>/SAXO_DIR</parameter></userinput>
102          </screen>
103           </listitem>
104          </varlistentry>
105          <varlistentry><term><emphasis role="bold">LOCEAN</emphasis></term>
106          <listitem><screen>
107  <prompt>$</prompt> <userinput><command>ln</command> <option>-s</option> <parameter>/usr/home/smasson/SAXO_DIR</parameter> <parameter><envar>${HOME}</envar>/SAXO_DIR</parameter></userinput>
108          </screen>
109           </listitem>
110          </varlistentry>
111        </variablelist>
112      </para>
113    </sect2>
114
115  <!--  2.2 -->
116
117    <sect2 id="saxo_svn">
118      <title>
119        If <ulink url="http://subversion.tigris.org/"><application> Subversion (svn)</application></ulink> is installed on your machine
120      </title>
121 <!--   2.2.1 -->
122      <sect3 id="saxo_svn_users">
123        <title>
124          Regular users
125        </title>
126      <para>
127        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>:
128        <screen format="linespecific">
129  <prompt>$</prompt> <userinput><command>svn</command> <option>checkout</option> <parameter>http://forge.ipsl.jussieu.fr/saxo/svn/trunk/</parameter> <parameter>SAXO_DIR</parameter></userinput>
130        </screen>
131      </para>
132      <para>
133        The latest revision of the <emphasis role="bold">source files</emphasis> (&szsrcsvn; Mb) can be checked out with the following command:
134        <screen format="linespecific">
135  <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>
136        </screen>
137      </para>
138      <para>
139        The latest revision of the <emphasis role="bold">NetCDF data files</emphasis> (&szdatasvn; Mb) used by the test programs can be checked out with the following command:
140        <screen format="linespecific">
141  <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>
142        </screen>
143      </para>
144      </sect3>
145<!--    2.2.2 -->
146      <sect3 id="saxo_svn_contributors">
147        <title>
148          Contributors
149        </title>
150      <para>
151        <emphasis role="bold">Contributors</emphasis> should better use the following command (and replace login by your own login):
152        <screen  format="linespecific">
153  <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>
154        </screen>
155      </para>
156      </sect3>
157    </sect2>
158
159  <!--  2.3 -->
160
161    <sect2 id="saxo_tar">
162      <title>
163        Get <application>SAXO</application> from a tar file
164      </title>
165  <!--  2.3.1 -->
166      <sect3 id="saxo_src_tar">
167        <title>
168          Get <application>SAXO</application> source files (&szsrc; Mb)
169        </title>
170        <para>
171          Create your <filename class='directory'><envar>${HOME}</envar>/SAXO_DIR</filename> directory &hellip;
172          <screen format="linespecific">
173  <prompt>$</prompt> <userinput><command>cd</command> <parameter><envar>${HOME}</envar></parameter></userinput>
174  <prompt>$</prompt> <userinput><command>mkdir</command> <parameter>SAXO_DIR</parameter></userinput>
175  <prompt>$</prompt> <userinput><command>cd</command> <parameter>SAXO_DIR</parameter></userinput>
176          </screen>
177          &hellip; 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
178        <variablelist>
179          <varlistentry><term><command>wget</command></term>
180          <listitem><screen>
181  <prompt>$</prompt> <userinput><command>wget</command> <parameter>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_SRC_&date;.tar.gz</parameter></userinput>
182          </screen>
183           </listitem>
184          </varlistentry>
185          <varlistentry><term><command>curl</command></term>
186          <listitem><screen>
187  <prompt>$</prompt> <userinput><command>curl</command> <option>-O</option> <parameter>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_SRC_&date;.tar.gz</parameter></userinput>
188          </screen>
189           </listitem>
190          </varlistentry>
191        </variablelist> 
192        Untar the file
193        <screen format="linespecific">
194  <prompt>$</prompt> <userinput><command>cd</command> <parameter><envar>${HOME}</envar>/SAXO_DIR</parameter></userinput>
195  <prompt>$</prompt> <userinput><command>tar</command> <option>xvfz</option> <parameter>SAXO_SRC_&date;.tar.gz</parameter></userinput>
196  <prompt>$</prompt> <userinput><command>rm</command> <parameter>SAXO_SRC_&date;.tar.gz</parameter></userinput>
197        </screen>
198        </para>
199
200      </sect3>
201  <!--  2.3.2 -->
202      <sect3 id="saxo_data_tar">
203        <title>
204          Get <application>SAXO</application> tests data files (&szdata; Mb)
205        </title>
206        <para>
207        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
208        <itemizedlist>
209          <listitem>
210           <simpara><filename class='directory'><envar>${HOME}</envar>/My_IDL</filename>. This is the easiest solution but it could be inconvenient if your <envar>${HOME}</envar> disk space is limited.
211           </simpara>
212          </listitem>
213          <listitem>
214           <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 <filename>init.pro</filename> file (see <xref linkend="generate_init"/>) or directly within IDL with the following command: <prompt>&promptidl;</prompt> <userinput><command>iodir = <replaceable>the chosen directory</replaceable></command></userinput>
215           </simpara>
216          </listitem>
217        </itemizedlist>
218        <screen format="linespecific">
219  <prompt>$</prompt> <userinput><command>cd</command> <parameter><envar>${HOME}</envar></parameter></userinput>
220  <prompt>$</prompt> <userinput><command>mkdir</command> <parameter><replaceable>CHOSEN_DIR</replaceable></parameter></userinput>
221  <prompt>$</prompt> <userinput><command>cd</command> <parameter><replaceable>CHOSEN_DIR</replaceable></parameter></userinput>
222        </screen>
223        Download <ulink url="http://forge.ipsl.jussieu.fr/saxo/download/SAXO_DATA_&date2;.tar.gz">SAXO_DATA_&date2;.tar.gz</ulink> (&szdata; Mb)
224        &hellip; or with
225        <variablelist>
226          <varlistentry><term><command>wget</command></term>
227          <listitem><screen>
228  <prompt>$</prompt> <userinput><command>wget</command> <parameter>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_DATA_&date2;.tar.gz</parameter></userinput>
229          </screen>
230           </listitem>
231          </varlistentry>
232          <varlistentry><term><command>curl</command></term>
233          <listitem><screen>
234  <prompt>$</prompt> <userinput><command>curl</command> <option>-O</option> <parameter>http://forge.ipsl.jussieu.fr/saxo/download/SAXO_DATA_&date2;.tar.gz</parameter></userinput>
235          </screen>
236            </listitem>
237          </varlistentry>
238        </variablelist>
239        </para>
240      </sect3>
241    </sect2>
242  </sect1>
243  <!--  3 -->
244    <sect1 id="generate_init">
245      <title>
246        Generate your init.pro file
247      </title>
248      <para>
249        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 been created, <filename>init.pro</filename> should the first executed command when starting IDL session.
250      </para>
251      <para>
252        <screen format="linespecific">
253  <prompt>$</prompt> <userinput><command>cd</command> <parameter><envar>${HOME}</envar>/SAXO_DIR/SRC</parameter></userinput>
254  <prompt>$</prompt> <userinput><command>idl</command></userinput>
255  <computeroutput>IDL Version 6.0, Mac OS X (darwin ppc m32). (c) 2003, Research Systems, Inc.</computeroutput>
256<!--
257  <computeroutput>Installation number: 35411.</computeroutput>
258  <computeroutput>Licensed for personal use by Jean-Philippe BOULANGER only.</computeroutput>
259  <computeroutput>All other use is strictly prohibited.</computeroutput>
260-->
261  <prompt>&promptidl;</prompt> <userinput><command>buildinit</command></userinput>
262  <computeroutput>% Compiled module: BUILDINIT.</computeroutput>
263        </screen>
264        You must then answer several questions:
265<!--    <itemizedlist mark='opencircle'> -->
266        <itemizedlist>
267          <listitem>
268           <simpara>give the path of <filename class='directory'><envar>${HOME}</envar>/My_IDL</filename>
269           </simpara>
270          </listitem>
271          <listitem>
272           <simpara>give the path of <filename class='directory'><envar>${HOME}</envar>/SAXO_DIR</filename>
273           </simpara>
274          </listitem>
275          <listitem>
276           <simpara>compatibility with the old version: No (except if you want to use old programs)
277           </simpara>
278          </listitem>
279          <listitem>
280           <simpara>give a default path for the data directory
281           </simpara>
282          </listitem>
283          <listitem>
284           <simpara>give a default path for the postscript directory
285           </simpara>
286          </listitem>
287          <listitem>
288           <simpara>give a default path for the images directory
289           </simpara>
290          </listitem>
291          <listitem>
292           <simpara>give a default path for the animation directory
293           </simpara>
294          </listitem>
295          <listitem>
296           <simpara>number of accessible printer and their configuration
297           </simpara>
298          </listitem>
299          <listitem>
300           <simpara>default color table
301           </simpara>
302          </listitem>
303          <listitem>
304           <simpara>default page orientation (portrait/landscape)
305           </simpara>
306          </listitem>
307          <listitem>
308           <simpara>default page size
309           </simpara>
310          </listitem>
311          <listitem>
312           <simpara>default window size
313           </simpara>
314          </listitem>
315          <listitem>
316           <simpara>postscript archiving options
317           </simpara>
318          </listitem>
319          <listitem>
320           <simpara>name of the init file (<filename>init.pro</filename>)
321           </simpara>
322          </listitem>
323        </itemizedlist>
324        <screen format="linespecific">
325   <computeroutput>% Compiled module: CW_FIELD.</computeroutput>
326   <computeroutput>% Compiled module: XMANAGER.</computeroutput>
327   <computeroutput>% Compiled module: LOADCT.</computeroutput>
328   <computeroutput>% Compiled module: FILEPATH.</computeroutput>
329   <computeroutput>% Compiled module: PATH_SEP.</computeroutput>
330   <computeroutput>% Compiled module: CW_FIELD.</computeroutput>
331   <computeroutput>% Compiled module: STRSPLIT.</computeroutput>
332   <computeroutput>% Compiled module: CW_FIELD.</computeroutput>
333   <computeroutput>% Compiled module: CW_FIELD.</computeroutput>
334   <computeroutput>% Compiled module: CW_FIELD.</computeroutput>
335   <prompt>&promptidl;</prompt> <userinput><command>exit</command></userinput>
336        </screen>
337        There is an example of the kind of <ulink url="idlfiles/init_example.pro"> <filename>init.pro</filename></ulink> you should get.
338      </para>
339    </sect1>
340<sect1 id="aftergetsaxo">
341<title>After this</title>
342<para>
343You are now ready to do your
344<ulink url="./firststeps.html">First steps with SAXO</ulink>.
345</para>
346</sect1>
347</article>
Note: See TracBrowser for help on using the repository browser.