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

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

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