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