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

Last change on this file since 353 was 351, checked in by pinsard, 16 years ago

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