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

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

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