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