source: trunk/SRC/Documentation/xmldoc/firststeps.xml @ 270

Last change on this file since 270 was 270, checked in by pinsard, 17 years ago

minor changes in xml doc (lodyc became locean, uppercase in titles)
  • Property svn:keywords set to Id
File size: 34.2 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 hellip "&#x2026;">
6<!ENTITY promptidl "idl&gt;">
7<!ENTITY numb1 '<inlinemediaobject><imageobject><imagedata fileref="images/callouts/1.png" format="PNG"/></imageobject><textobject><phrase>1</phrase></textobject></inlinemediaobject>'>
8<!ENTITY numb2 '<inlinemediaobject><imageobject><imagedata fileref="images/callouts/2.png" format="PNG"/></imageobject><textobject><phrase>2</phrase></textobject></inlinemediaobject>'>
9<!ENTITY showfig '<inlinemediaobject><imageobject><imagedata fileref="images/showfig.png" format="PNG"/></imageobject><textobject><phrase>show result</phrase></textobject></inlinemediaobject>'>
10]>
11
12<!--
13instructions to create html file
14xsltproc ?-?-param  section.autolabel 1 -output firststep.html /sw/share/xml/xsl/docbook-xsl/xhtml/docbook.xsl firststep.xml
15xsltproc -output firststep.html /sw/share/xml/xsl/docbook-xsl/xhtml/docbook.xsl firststep.xml
16xsltproc  /sw/share/xml/xsl/docbook-xsl/xhtml/chunk.xsl  firststep.xml
17xsltproc ?-?-param  section.autolabel 1 /sw/share/xml/xsl/docbook-xsl/xhtml/chunk.xsl firststep.xml
18
19-->
20
21<!--
22module :
23first steps with SAXO ...
24
25source :
26./SRC/Documentation/xmldoc/firststeps.xml
27
28-->
29<article lang="en">
30  <title>
31    First steps with <application>SAXO</application>
32  </title>
33 
34  <articleinfo>
35    <authorgroup>
36      <author><firstname>Sébastien</firstname> <surname>Masson</surname> <email>Sebastien.Masson_at_locean-ipsl.upmc.fr</email></author>
37      <author><firstname>Françoise</firstname> <surname>Pinsard</surname> <email>Francoise.Pinsard_at_locean-ipsl.upmc.fr</email></author>
38    </authorgroup>
39    <keywordset>
40      <keyword>IDL</keyword>
41      <keyword>SAXO</keyword>
42    </keywordset>
43    <revhistory>
44      <revision>
45        <revnumber>0.0</revnumber>
46        <date>29 July 2005</date>
47        <revremark>First draft</revremark>
48      </revision>
49      <revision>
50        <revnumber>0.1</revnumber>
51        <date>29 August 2005</date>
52        <revremark>last Japanese version!</revremark>
53      </revision>
54      <revision>
55        <revnumber>0.2</revnumber>
56        <date>May 2006</date>
57        <revremark>split with getsaxo</revremark>
58      </revision>
59     </revhistory> 
60     <pubdate>$Id$</pubdate>
61  </articleinfo>
62 
63
64 
65<sect1 id="beforefirststeps">
66<title>Before this</title>
67<para>
68In this document, we supposed that you followed <ulink url="./getsaxo.html">Get SAXO</ulink> recommendations.
69</para>
70</sect1>
71
72  <sect1 id="first_plots">
73    <title>
74      First plots &hellip;
75    </title>
76    <sect2 id="start_with_init">
77      <title>
78        Start IDL session: <userinput><command>@init</command></userinput>
79      </title>
80      <para>
81        Each IDL session using <application>SAXO</application> must always start with: <prompt>&promptidl;</prompt> <userinput><command>@init</command></userinput>.     
82      </para>
83      <para>
84        <emphasis>The @ is equivalent to an include. It is used to execute a set of IDL commands that will be directly executed without any compilation (as it is the case for a procedure or a function). All variables defined and used in the @&hellip; file will still be accessible after the execution of the @&hellip; is finished (which is not the case for procedures and functions that ends with the return instruction).</emphasis>
85        <screen format="linespecific">
86  <prompt>$</prompt> <userinput><command>cd</command> <filename class="directory"><envar>${HOME}</envar>/My_IDL/</filename></userinput>
87  <prompt>$</prompt> <userinput><command>idl</command></userinput>
88  <computeroutput>IDL Version 6.0, Mac OS X (darwin ppc m32). (c) 2003, Research Systems, Inc.</computeroutput>
89  <computeroutput>Installation number: 35411.</computeroutput>
90  <computeroutput>Licensed for personal use by Jean-Philippe BOULANGER only.</computeroutput>
91  <computeroutput>All other use is strictly prohibited.</computeroutput>
92  <prompt>&promptidl;</prompt> <userinput><command>@init</command></userinput>
93  <computeroutput>% Compiled module: KEEP_COMPATIBILITY.</computeroutput>
94  <computeroutput>% Compiled module: FIND.</computeroutput>
95  <computeroutput>% Compiled module: PATH_SEP.</computeroutput>
96  <computeroutput>% Compiled module: STRSPLIT.</computeroutput>
97  <computeroutput>% Compiled module: DEF_MYUNIQUETMPDIR.</computeroutput>
98  <computeroutput>We forget the compatibility with the old version</computeroutput>
99  <computeroutput>% Compiled module: DEMOMODE_COMPATIBILITY.</computeroutput>
100  <computeroutput>% Compiled module: ISADIRECTORY.</computeroutput>
101  <computeroutput>% Compiled module: LCT.</computeroutput>
102  <computeroutput>% Compiled module: RSTRPOS.</computeroutput>
103  <computeroutput>% Compiled module: REVERSE.</computeroutput>
104  <computeroutput>% Compiled module: STR_SEP.</computeroutput>
105  <computeroutput>% Compiled module: LOADCT.</computeroutput>
106  <prompt>&promptidl;</prompt>
107        </screen>
108        As an IDL session using <application>SAXO</application> must always start with <prompt>&promptidl;</prompt> <userinput><command>@init</command></userinput>, it could be convenient to define the environment variable <envar>IDL_STARTUP</envar> to <filename><envar>${HOME}</envar>/My_IDL/init.pro</filename>. In that way, <filename>init.pro</filename> will automatically been executed when starting IDL. This can be done with the following command:
109      <variablelist>
110        <varlistentry><term><command>csh</command></term>
111        <listitem><screen><prompt>$</prompt> <userinput><command>setenv</command> <envar>IDL_STARTUP</envar> <filename><envar>${HOME}</envar>/My_IDL/init.pro</filename></userinput></screen></listitem>
112        </varlistentry>
113        <varlistentry><term><command>ksh</command></term>
114        <listitem><screen><prompt>$</prompt> <userinput><command>export</command> <envar>IDL_STARTUP</envar>=<filename><envar>${HOME}</envar>/My_IDL/init.pro</filename></userinput></screen></listitem>
115        </varlistentry>
116      </variablelist>
117      </para>
118 
119     
120    </sect2>
121    <sect2 id="basic_plots">
122      <title>
123        Basic plots &hellip;
124      </title>
125      <sect3 id="basic_splot">
126      <title>
127        splot
128      </title>
129
130      <para>
131        <screenco>
132          <areaspec>
133            <area id="findgen" coords='2'/>
134          </areaspec>
135        <screen format="linespecific">
136   <prompt>&promptidl;</prompt> <userinput><command>n = 10</command></userinput>
137   <prompt>&promptidl;</prompt> <userinput><command>y = findgen(n)</command></userinput> &numb1;
138   <prompt>&promptidl;</prompt> <userinput><command>plot, y</command></userinput> <ulink url="./figpng/basic_plot.png">&showfig;</ulink>
139        </screen>
140          <calloutlist>
141            <callout arearefs="findgen">
142              <para>
143                <command>findgen</command> stands for
144<emphasis role="bold">f</emphasis>loat <emphasis role="bold">ind</emphasis>ex <emphasis role="bold">gen</emphasis>erator.
145                <screen format="linespecific">
146  <prompt>&promptidl;</prompt> <userinput><command>print, findgen(6)</command></userinput>
147  <computeroutput>      0.00000      1.00000      2.00000      3.00000      4.00000      5.00000</computeroutput>
148                </screen>
149              </para> 
150            </callout>
151          </calloutlist>
152        </screenco>
153     </para>
154     
155      <para>
156        Using IDL <command>plot</command> command is quite inconvenient to save the figure as a postscript. In addition, positioning the figure on the window/page by using <varname>!p.position</varname>, <varname>!p.region</varname> and <varname>!p.multi</varname> is often a nightmare. That's why we developed <command>splot</command> (like super-plot) which can be used in the same way as plot but is much more convenient to make postscript and position the figure.
157        <screen format="linespecific">
158  <prompt>&promptidl;</prompt> <userinput><command>splot, y</command></userinput> <ulink url="./figpng/basic_splot1.png">&showfig;</ulink>
159  <computeroutput>% Compiled module: SPLOT.</computeroutput>
160  <computeroutput>% Compiled module: REINITPLT.</computeroutput>
161  <computeroutput>% Compiled module: PLACEDESSIN.</computeroutput>
162  <computeroutput>% Compiled module: CALIBRE.</computeroutput>
163  <computeroutput>% Compiled module: GIVEWINDOWSIZE.</computeroutput>
164  <computeroutput>% Compiled module: GET_SCREEN_SIZE.</computeroutput>
165  <computeroutput>% Compiled module: TERMINEDESSIN.</computeroutput>
166        </screen>
167        Save the figure seen on the screen as a (real, not a screen capture) postscript in only one command.
168        <screenco>
169          <areaspec>
170            <area id="make_ps" coords='6'/>
171          </areaspec>
172        <screen format="linespecific">
173  <prompt>&promptidl;</prompt> <userinput><command>@ps</command></userinput>
174  <computeroutput>% Compiled module: GETFILE.</computeroutput>
175  <computeroutput>% Compiled module: PUTFILE.</computeroutput>
176  <computeroutput>% Compiled module: OPENPS.</computeroutput>
177  <computeroutput>% Compiled module: XQUESTION.</computeroutput>
178  <computeroutput>Name of the postscript file? (default answer is idl.ps)</computeroutput><userinput>first_ps</userinput> &numb1;
179  <computeroutput>% Compiled module: ISAFILE.</computeroutput>
180  <computeroutput>% Compiled module: XNOTICE.</computeroutput>
181  <computeroutput>% Compiled module: CLOSEPS.</computeroutput>
182  <computeroutput>% Compiled module: PRINTPS.</computeroutput>
183  <computeroutput>% Compiled module: FILE_WHICH.</computeroutput>
184  <computeroutput>% Compiled module: CW_BGROUP.</computeroutput>
185  <computeroutput>% Compiled module: XMANAGER.</computeroutput>
186        </screen>
187          <calloutlist>
188            <callout arearefs="make_ps">
189              <para>
190                <remark>If needed, the name of the postscript will automatically be completed with .ps. Just hit return, if you want to use the default postscript name: <filename>idl.ps</filename>.</remark> 
191              </para>
192            </callout>
193          </calloutlist>
194        </screenco>
195        Check that the <quote><filename>first_ps.ps</filename></quote> file is now existing &hellip;
196        <screen format="linespecific">
197  <prompt>&promptidl;</prompt> <userinput><command>print, file_test(psdir + 'first_ps.ps')</command></userinput>
198  <computeroutput>           1</computeroutput>
199  <prompt>&promptidl;</prompt> <userinput><command>help, file_info(psdir + 'first_ps.ps'), /structure</command></userinput>
200  <computeroutput>** Structure FILE_INFO, 21 tags, length=64, data length=63:</computeroutput>
201  <computeroutput>   NAME            STRING    '/Users/sebastie/IDL/first_ps.ps'</computeroutput>
202  <computeroutput>   EXISTS          BYTE         1</computeroutput>
203  <computeroutput>   READ            BYTE         1</computeroutput>
204  <computeroutput>   WRITE           BYTE         1</computeroutput>
205  <computeroutput>   EXECUTE         BYTE         0</computeroutput>
206  <computeroutput>   REGULAR         BYTE         1</computeroutput>
207  <computeroutput>   DIRECTORY       BYTE         0</computeroutput>
208  <computeroutput>   BLOCK_SPECIAL   BYTE         0</computeroutput>
209  <computeroutput>   CHARACTER_SPECIAL</computeroutput>
210  <computeroutput>                   BYTE         0</computeroutput>
211  <computeroutput>   NAMED_PIPE      BYTE         0</computeroutput>
212  <computeroutput>   SETUID          BYTE         0</computeroutput>
213  <computeroutput>   SETGID          BYTE         0</computeroutput>
214  <computeroutput>   SOCKET          BYTE         0</computeroutput>
215  <computeroutput>   STICKY_BIT      BYTE         0</computeroutput>
216  <computeroutput>   SYMLINK         BYTE         0</computeroutput>
217  <computeroutput>   DANGLING_SYMLINK</computeroutput>
218  <computeroutput>                   BYTE         0</computeroutput>
219  <computeroutput>   MODE            LONG               420</computeroutput>
220  <computeroutput>   ATIME           LONG64                1122424373</computeroutput>
221  <computeroutput>   CTIME           LONG64                1122424373</computeroutput>       
222  <computeroutput>   MTIME           LONG64                1122424373</computeroutput>       
223  <computeroutput>   SIZE            LONG64                      4913</computeroutput>
224        </screen>
225      </para>
226      <para id="splot_description">
227        <command>splot</command> accepts the same keywords as <command>plot</command> (<computeroutput id="plot_kwd">/ISOTROPIC, MAX_VALUE=value, MIN_VALUE=value, NSUM=value, /POLAR, THICK=value, /XLOG, /YLOG, /YNOZERO</computeroutput>), including the graphics keywords (<computeroutput id="gr_kwd">BACKGROUND, CHARSIZE, CHARTHICK, CLIP, COLOR, DATA, DEVICE, FONT, LINESTYLE, NOCLIP, NODATA, NOERASE, NORMAL, POSITION, PSYM, SUBTITLE, SYMSIZE, T3D, THICK, TICKLEN, TITLE, [XYZ]CHARSIZE, [XYZ]GRIDSTYLE, [XYZ]MARGIN, [XYZ]MINOR, [XYZ]RANGE, [XYZ]STYLE, [XYZ]THICK, [XYZ]TICKFORMAT, [XYZ]TICKINTERVAL, [XYZ]TICKLAYOUT, [XYZ]TICKLEN, [XYZ]TICKNAME, [XYZ]TICKS, [XYZ]TICKUNITS, [XYZ]TICKV, [XYZ]TICK_GET, [XYZ]TITLE, ZVALUE</computeroutput>).
228      </para>
229      <simpara>
230        It can therefore be customized <emphasis>as much as you want</emphasis>. See this short example:
231      </simpara>
232      <para>
233        <screen format="linespecific">
234  <prompt>&promptidl;</prompt> <userinput><command>splot, y, y^2, linestyle = 2, thick = 2, title = 'y = x^2', /portrait</command></userinput> <ulink url="./figpng/basic_splot2.png">&showfig;</ulink>
235        </screen>
236        <command>splot</command> can be used to setup the graphic environment (<varname>!p</varname>, <varname>!x</varname>, <varname>!y</varname>, <varname>!z</varname> variables) needed by procedures like <command>oplot</command>
237        <screen format="linespecific">
238  <prompt>&promptidl;</prompt> <userinput><command>splot, y, yrange = [0, (n-1)^2], title = 'x and x^2'</command></userinput>
239  <prompt>&promptidl;</prompt> <userinput><command>oplot, y^2, color = 50, linestyle = 2</command></userinput> <ulink url="./figpng/basic_splot4.png">&showfig;</ulink>
240        </screen>
241        Use the keyword small to produce multi plots figures.
242        <screenco>
243          <areaspec>
244            <areaset id="small" coords="">
245              <area id="small.1" coords='1'/>
246              <area id="small.2" coords='2'/>
247            </areaset>
248            <area id="noerase" coords='2'/>
249          </areaspec>
250        <screen format="linespecific">
251  <prompt>&promptidl;</prompt> <userinput><command>splot, y, y^2, title = 'y = x^2', psym = 2, small &numb1; = [1, 2, 1]</command></userinput>
252  <prompt>&promptidl;</prompt> <userinput><command>splot, findgen(360)/36., findgen(360)*2.*!dtor, /polar $</command></userinput>
253  <prompt>&promptidl;</prompt> <userinput><command>    , small &numb1; = [1, 2, 2], /noerase &numb2;</command></userinput> <ulink url="./figpng/basic_splot3.png">&showfig;</ulink>
254        </screen>
255          <calloutlist>
256            <callout arearefs="small">
257              <para>
258                the <computeroutput>small</computeroutput> keyword is a 3 elements vector which defines how we divide the page and in which case we should make the plot: [number of columns, number of rows, case number]. The case numbering is starting at 1, from top to bottom and left to right.
259              </para>
260            </callout>
261            <callout arearefs="noerase">
262              <simpara>
263                you must put <computeroutput>/noerase</computeroutput> otherwise the second plot will be done in a new window.
264              </simpara>
265            </callout>
266          </calloutlist>
267        </screenco>
268      </para>
269     
270      </sect3>
271
272      <sect3 id="basic_contour">
273      <title>
274        scontour
275      </title>
276      <para>
277        Following <command><link linkend="basic_splot">splot</link></command> example, we provide <command>scontour</command> as a "super <command>contour</command>".
278        <screen format="linespecific">
279  <prompt>&promptidl;</prompt> <userinput><command>z = dist(n)</command></userinput>
280  <computeroutput>% Compiled module: DIST.</computeroutput>
281  <prompt>&promptidl;</prompt> <userinput><command>scontour, z</command></userinput> <ulink url="./figpng/basic_scontour1.png">&showfig;</ulink>
282  <computeroutput>% Compiled module: SCONTOUR.</computeroutput>
283  <computeroutput>% Compiled module: CHKSTRU.</computeroutput>
284        </screen>
285        <command>scontour</command> accepts the same keywords as <command>contour</command> (<computeroutput>C_ANNOTATION=vector_of_strings, C_CHARSIZE=value, C_CHARTHICK=integer, C_COLORS=vector, C_LABELS=vector{each element 0 or 1}, C_LINESTYLE=vector, { /FILL | /CELL_FILL | C_ORIENTATION=degrees}, C_SPACING=value, C_THICK=vector, /CLOSED, /DOWNHILL, /FOLLOW, /IRREGULAR, /ISOTROPIC, LEVELS=vector, NLEVELS=integer{1 to 60}, MAX_VALUE=value, MIN_VALUE=value, /OVERPLOT, {/PATH_DATA_COORDS, PATH_FILENAME=string, PATH_INFO=variable, PATH_XY=variable}, TRIANGULATION=variable, /PATH_DOUBLE, /XLOG, /YLOG, ZAXIS={0 | 1 | 2 | 3 | 4}</computeroutput>), including the <link linkend="gr_kwd">graphics keywords</link> (except <computeroutput>LINESTYLE, PSYM, SYMSIZE</computeroutput>).
286      </para>
287      <simpara>It can therefore be customized <emphasis>as much as you want</emphasis>. See these short examples:</simpara>
288      <para>
289        <screen format="linespecific">
290  <prompt>&promptidl;</prompt> <userinput><command>scontour, z, /fill, nlevels = 15, subtitle = 'nicer contour' $</command></userinput>
291  <prompt>&promptidl;</prompt> <userinput><command>    , xtitle = 'x index', charsize = 1.5</command></userinput> <ulink url="./figpng/basic_scontour2.png">&showfig;</ulink>
292        </screen>
293It can be used in combination with contour to make more complex plots:
294        <screenco>
295          <areaspec>
296            <area id="rebin" coords='1'/>
297          </areaspec>
298        <screen format="linespecific">
299  <prompt>&promptidl;</prompt> <userinput><command>ind = findgen(2*n)/(2.*n)</command></userinput>
300  <prompt>&promptidl;</prompt> <userinput><command>scontour, z, levels = n*ind, c_orientation = 180*ind, c_spacing = 0.4*ind</command></userinput>
301  <prompt>&promptidl;</prompt> <userinput><command>contour, z, /overplot, c_label = rebin([1, 0], 2, n) &numb1;, levels = n*ind $</command></userinput>
302  <prompt>&promptidl;</prompt> <userinput><command>    , c_charthick = 2, c_charsize = 1.5, c_colors = 250*ind</command></userinput> <ulink url="./figpng/basic_scontour3.png">&showfig;</ulink>
303        </screen>
304        <calloutlist>
305          <callout arearefs="rebin">
306            <para>
307              <command>rebin</command> is used to build an array containing an alternation of 1 and 0 in order to label one contour every two contours.
308                <screen format="linespecific">
309  <prompt>&promptidl;</prompt> <userinput><command>print, rebin([1, 0], 2, 3)</command></userinput>
310  <computeroutput>       1       0</computeroutput>
311  <computeroutput>       1       0</computeroutput>
312  <computeroutput>       1       0</computeroutput>
313                </screen>
314            </para>
315          </callout>
316        </calloutlist>
317        </screenco>
318        <command>scontour</command> is compatible with the positioning method associated with the <computeroutput>small</computeroutput> keyword. See for example the test file <ulink type="text" url="../../Tests/tst_basic.pro"><filename>tst_basic.pro</filename></ulink>:
319        <screen format="linespecific">
320  <prompt>&promptidl;</prompt> <userinput><command>tst_basic</command></userinput> <ulink url="./figpng/tst_basic.png">&showfig;</ulink>
321        </screen>
322      </para>
323      </sect3>
324
325      <sect3 id="tvplus">
326        <title>
327          Quick look and explore 2D arrays: tvplus
328        </title>
329        <para>
330          <command>tvplus</command> is a enhanced version of tvscl and allow you to have a quick look and perform basic exploration of 2D arrays.
331          <screen format="linespecific">
332  <prompt>&promptidl;</prompt> <userinput><command>tvplus, dist(20)</command></userinput> <ulink url="./figpng/tvplus.png">&showfig;</ulink>
333  <computeroutput>left button  : mouse position and associated array value</computeroutput>
334  <computeroutput>middle button: use it twice to define a zoom box</computeroutput>
335  <computeroutput>right button : quit</computeroutput>
336  <computeroutput>(x, y) = (  5,   5), value = 7.07107</computeroutput>
337  <computeroutput>(x, y) = ( 12,   8), value = 11.3137</computeroutput>
338          </screen>
339          For more informations on <command>tvplus</command>, try:
340          <screen format="linespecific">
341  <prompt>&promptidl;</prompt> <userinput><command>xhelp, 'tvplus'</command></userinput>
342          </screen>
343          To see the source code of <command>tvplus</command>, try:
344          <screen format="linespecific">
345  <prompt>&promptidl;</prompt> <userinput><command>xfile, 'tvplus'</command></userinput>
346          </screen>
347          <note><title>New Feature</title><para>
348          If you use an IDL 6.2 or later revision, you can simply get the help of any command by typing ?<replaceable>command_name</replaceable>, for example:
349          <screen format="linespecific">
350  <prompt>&promptidl;</prompt> <userinput><command>?tvplus</command></userinput>
351          </screen>
352          </para></note>
353        </para>
354      </sect3>
355
356      <sect3 id="pltv">
357        <title>
358          Formal quick look at 2D arrays: pltv
359        </title>
360        <para>
361          <command>pltv</command> is a mix between <link linkend="tvplus">tvplus</link> and <link linkend="plt">plt</link> and allow you to have formal quick look of 2D arrays.
362          <screen format="linespecific">
363  <prompt>&promptidl;</prompt> <userinput><command>pltv, dist(20)</command></userinput> <ulink url="./figpng/pltv.png">&showfig;</ulink>
364          </screen>
365        </para>
366      </sect3>
367    </sect2>
368  </sect1>
369
370  <sect1 id="gridded_data">
371    <title>
372      Explore gridded data (model outputs and observations)
373    </title>
374    <para>
375      This section briefly describes the main functionalities offered by SAXO to explore gridded data on regular or irregular grid.
376    </para>
377
378    <sect2 id="load_grid">
379      <title>
380        Load the data grid
381      </title>
382      <para>
383        As we focus in this section on the gridded data, we must first load the grid informations before reading and plotting the data. Loading the grid independently of the data allow you to reload the grid only when it is strictly necessary and not every time you access the data. In <filename class="directory"><envar>${HOME}</envar>/SAXO_DIR/Tests/</filename>, we provide several examples to load a grid.
384      </para>
385      <sect3 id="load_fromdata">
386        <title>
387          Easiest solution: load data grid (regular or not) directly from the data file.
388        </title>
389        <para>
390          Example of Levitus temperature on a regular 1x1 grid.
391          <screen format="linespecific">
392  <prompt>&promptidl;</prompt> <userinput><command>@tst_initlev</command></userinput>
393  <computeroutput>% Compiled module: INITNCDF.</computeroutput>
394  <computeroutput>% Compiled module: ISAFILE.</computeroutput>
395  <computeroutput>% Compiled module: UNIQ.</computeroutput>
396  <computeroutput>% Loaded DLM: NCDF.</computeroutput>
397  <computeroutput>% Compiled module: COMPUTEGRID.</computeroutput>
398  <computeroutput>% Compiled module: DOMDEF.</computeroutput>
399  <computeroutput>% Compiled module: INTER.</computeroutput>
400  <computeroutput>% Compiled module: TRIANGULE.</computeroutput>
401  <computeroutput>% Compiled module: TRIANGULE_C.</computeroutput>
402  <computeroutput>% Compiled module: UNDEFINE.</computeroutput>
403  <computeroutput>% Compiled module: TESTVAR.</computeroutput>
404  <computeroutput>% Compiled module: DIFFERENT.</computeroutput>
405  <computeroutput>% Compiled module: DEFINETRI.</computeroutput>
406          </screen>
407          This <ulink type="text" url="../../Tests/tst_initlev.pro"><command>@tst_initlev</command></ulink> command allows us to define:
408          <itemizedlist>
409            <listitem><simpara>domain dimensions, stored in <varname>jpi, jpj and jpk</varname></simpara></listitem>
410            <listitem><simpara>points abscissa, stored in 2D array <varname></varname>glamt</simpara></listitem>
411            <listitem><simpara>points ordinates, stored in 2D array <varname></varname>gphit</simpara></listitem>
412            <listitem><simpara>points depths, stored in 1D array <varname></varname>gdept</simpara></listitem>
413            <listitem><simpara>cells corners abscissa, stored in 2D array <varname></varname>glamf</simpara></listitem>
414            <listitem><simpara>cells corners ordinates, stored in 2D array <varname></varname>gphif</simpara></listitem>
415            <listitem><simpara>cells upper boundary depth, stored in 1D array <varname></varname>gdepw</simpara></listitem>
416            <listitem><simpara>land-sea mask, stored in <varname>tmask</varname></simpara></listitem>
417            <listitem><simpara>the cells size in the longitudinal direction, stored in 2D array <varname></varname>e1t</simpara></listitem>
418            <listitem><simpara>the cells size in the latitudinal direction, stored in 2D array <varname></varname>e2t</simpara></listitem>
419            <listitem><simpara>the cells size in the vertical direction, stored in 1D array <varname></varname>e3t</simpara></listitem>
420            <listitem><simpara>the triangulation used to fill the land points, stored in <varname></varname>triangles_list</simpara></listitem>
421          </itemizedlist>
422
423          <screen format="linespecific">
424  <prompt>&promptidl;</prompt> <userinput><command>help, jpi,jpj,jpk</command></userinput>
425  <computeroutput>JPI (LOCAL_COORD)   LONG      =          360</computeroutput>
426  <computeroutput>JPJ (LOCAL_COORD)   LONG      =          180</computeroutput>
427  <computeroutput>JPK (LOCAL_COORD)   LONG      =           33</computeroutput>
428  <prompt>&promptidl;</prompt> <userinput><command>help, glamt, gphit,glamf, gphif</command></userinput>
429  <computeroutput>GLAMT (LONGITUDES)  FLOAT     = Array[360, 180]</computeroutput>
430  <computeroutput>GPHIT (LATITUDES)   FLOAT     = Array[360, 180]</computeroutput>
431  <computeroutput>GLAMF (LONGITUDES)  FLOAT     = Array[360, 180]</computeroutput>
432  <computeroutput>GPHIF (LATITUDES)   FLOAT     = Array[360, 180]</computeroutput>
433  <prompt>&promptidl;</prompt> <userinput><command>help, gdept, gdepw</command></userinput>
434  <computeroutput>GDEPT (VERTICAL)    FLOAT     = Array[33]</computeroutput>
435  <computeroutput>GDEPW (VERTICAL)    FLOAT     = Array[33]</computeroutput>
436  <prompt>&promptidl;</prompt> <userinput><command>help, e1t, e2t, e3t</command></userinput>
437  <computeroutput>E1T (SCALE_FACTORS) FLOAT     = Array[360, 180]</computeroutput>
438  <computeroutput>E2T (SCALE_FACTORS) FLOAT     = Array[360, 180]</computeroutput>
439  <computeroutput>E3T (VERTICAL)      FLOAT     = Array[33]</computeroutput>
440  <prompt>&promptidl;</prompt> <userinput><command>help, tmask</command></userinput>
441  <computeroutput>TMASK (MASKS)       BYTE      = Array[360, 180, 33]</computeroutput>
442  <prompt>&promptidl;</prompt> <userinput><command>help, triangles_list</command></userinput>
443  <computeroutput>TRIANGLES_LIST (LIEES_A_TRIANGULE) LONG      = Array[3, 128880]</computeroutput>
444  <prompt>&promptidl;</prompt> <userinput><command>tvplus, glamt*tmask[*,*,0]</command></userinput>
445  <prompt>&promptidl;</prompt> <userinput><command>tvplus, gphit*tmask[*,*,0]</command></userinput>
446          </screen>
447          We provide other initialization methods/examples
448          <itemizedlist>
449            <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca2_short.pro">@tst_initorca2_short</ulink> : ORCA2 example</simpara></listitem>
450            <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca05_short.pro">@tst_initorca05_short</ulink> : ORCA05 example</simpara></listitem>
451            <listitem><simpara><ulink type="text" url="../../Tests/tst_initlev_stride.pro">@tst_initlev_stride</ulink> : same as @tst_initlev but we skip on point over 2 in x and y direction</simpara></listitem>
452            <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca2_short_stride.pro">@tst_initorca2_short_stride</ulink> : ORCA2 with stride</simpara></listitem>
453            <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca05_short_stride.pro">@tst_initorca05_short_stride</ulink> : ORCA05 with stride</simpara></listitem>
454            <listitem><simpara><ulink type="text" url="../../Tests/tst_initlev_index.pro">@tst_initlev_index</ulink> : in that case we load the grid using points index as axis instead of the longitude/latitude position</simpara></listitem>
455            <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca2_index.pro">@tst_initorca2_index</ulink> : load ORCA2 as it see by the model</simpara></listitem>
456            <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca05_index.pro">@tst_initorca05_index</ulink> : load ORCA05 as it see by the model</simpara></listitem>
457            <listitem><simpara><ulink type="text" url="../../Tests/tst_initlev_index_stride.pro">@tst_initlev_index_stride</ulink> : @tst_initlev_index with stride</simpara></listitem>
458            <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca2_index_stride.pro">@tst_initorca2_index_stride</ulink> : ORCA2 in index with stride</simpara></listitem>
459            <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca05_index_stride.pro">@tst_initorca05_index_stride</ulink> : ORCA05 in index with stride</simpara></listitem>
460          </itemizedlist>
461        </para>
462      </sect3>
463      <sect3 id="load_meshmask">
464        <title>
465          Load the grid from OPA <filename>meshmask</filename> file
466        </title>
467        <para>
468          When the grid is really irregular (its abscissa and ordinate cannot be descried by a vector), loading the grid directly from the data forces us to make an approximation when computing the grid corners position and the cells size. In that case, it can be preferable to load the grid from the meshmask file created by OPA. As OPA use a Arakawa-C discretization, loading the grid from the meshmask will also define all parameters related to the U, V and F grids (glam[uv],gphi[uv], e[12][uvf]). Note that, when using a simple <link linkend="load_fromdata">grid definition from the data itself</link> (with <filename>initncdf</filename> or <filename>computegrid</filename>), adding the keyword /FULLCGRID leads also to the definition of all U, V and F grids parameters. There is the examples to load ORCA grids from OPA meshmask.
469          <itemizedlist>
470            <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca2.pro">@tst_initorca2</ulink> : ORCA2</simpara></listitem>
471            <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca05.pro">@tst_initorca05</ulink> : ORCA05</simpara></listitem>
472            <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca2_stride.pro">@tst_initorca2_stride</ulink> : ORCA2 with stride</simpara></listitem>
473            <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca05_stride.pro">@tst_initorca05_stride</ulink> : ORCA05 with stride</simpara></listitem>
474            <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca2_index.pro">@tst_initorca2_index</ulink> : load ORCA2 as it see by the model</simpara></listitem>
475            <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca05_index.pro">@tst_initorca05_index</ulink> : load ORCA05 as it see by the model</simpara></listitem>
476            <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca2_index_stride.pro">@tst_initorca2_index_stride</ulink> : ORCA2 in index with stride</simpara></listitem>
477            <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca05_index_stride.pro">@tst_initorca05_index_stride</ulink> : ORCA05 in index with stride</simpara></listitem>
478          </itemizedlist>
479        </para>
480        </sect3>
481    </sect2>
482
483    <sect2 id="plt">
484      <title>
485        Horizontal plots and maps
486      </title>
487        <para>
488          A quick presentation of horizontal plots and maps is shown in <ulink type="text" url="../../Tests/tst_plt.pro">tst_plt</ulink>. After loading any of the grid (for example with one of the <link linkend="load_grid">above examples</link>). Just try:
489          <screen format="linespecific">
490  <prompt>&promptidl;</prompt> <userinput><command>tst_plt</command></userinput>
491          </screen>
492        </para>
493        <simpara><emphasis>Beware, the command is <command>tst_plt</command> and not <command>@tst_plt</command> as <filename>tst_plt.pro</filename> is a procedure and not an include.</emphasis></simpara>
494        <para>
495          See the results with
496          <itemizedlist>
497          <listitem><simpara><command>@tst_initlev</command>&figsplt_lev;</simpara></listitem>
498          <listitem><simpara><command>@tst_initorca2</command>&figsplt_orca2;</simpara></listitem>
499          <listitem><simpara><command>@tst_initorca05</command>&figsplt_orca05;</simpara></listitem>
500          <listitem><simpara><command>@tst_initlev_stride</command>&figsplt_lev_stride;</simpara></listitem>
501          <listitem><simpara><command>@tst_initorca2_stride</command>&figsplt_orca2_stride;</simpara></listitem>
502          <listitem><simpara><command>@tst_initorca05_stride</command>&figsplt_orca05_stride;</simpara></listitem>
503          </itemizedlist>
504        </para>
505    </sect2>
506
507    <sect2 id="pltz">
508      <title>
509        Vertical sections
510      </title>
511        <para>
512          A quick presentation of vertical sections is shown in <ulink type="text" url="../../Tests/tst_pltz.pro">tst_pltz</ulink>. After loading any of the grid (for example with one of the <link linkend="load_grid">above examples</link>). Just try:
513          <screen format="linespecific">
514  <prompt>&promptidl;</prompt> <userinput><command>tst_pltz</command></userinput>
515          </screen>
516        </para>
517          <simpara><emphasis>Beware, the command is <command>tst_pltz</command> and not <command>@tst_pltz</command> as <filename>tst_pltz.pro</filename> is a procedure and not an include.</emphasis></simpara>         
518        <para>
519          See the results with
520          <itemizedlist>
521          <listitem><simpara><command>@tst_initlev</command>&figspltz_lev;</simpara></listitem>
522          <listitem><simpara><command>@tst_initorca2</command>&figspltz_orca2;</simpara></listitem>
523          <listitem><simpara><command>@tst_initorca05</command>&figspltz_orca05;</simpara></listitem>
524          <listitem><simpara><command>@tst_initlev_stride</command>&figspltz_lev_stride;</simpara></listitem>
525          <listitem><simpara><command>@tst_initorca2_stride</command>&figspltz_orca2_stride;</simpara></listitem>
526          <listitem><simpara><command>@tst_initorca05_stride</command>&figspltz_orca05_stride;</simpara></listitem>
527          </itemizedlist>
528        </para>
529    </sect2>
530
531    <sect2 id="pltt">
532      <title>
533        Hovmoellers and time series
534      </title>
535        <para>
536          A quick presentation of hovmoellers and time series is shown in <ulink type="text" url="../../Tests/tst_pltt.pro">tst_pltt</ulink>. After loading any of the grid (for example with one of the <link linkend="load_grid">above examples</link>). Just try:
537          <screen format="linespecific">
538  <prompt>&promptidl;</prompt> <userinput><command>tst_pltt</command></userinput>
539          </screen>
540        </para>
541          <simpara><emphasis>Beware, the command is <command>tst_pltt</command> and not <command>@tst_pltt</command> as <filename>tst_pltt.pro</filename> is a procedure and not an include.</emphasis></simpara>
542        <para>
543          See the results with
544          <itemizedlist>
545          <listitem><simpara><command>@tst_initlev</command>&figspltt_lev;</simpara></listitem>
546          <listitem><simpara><command>@tst_initorca2</command>&figspltt_orca2;</simpara></listitem>
547          <listitem><simpara><command>@tst_initorca05</command>&figspltt_orca05;</simpara></listitem>
548          <listitem><simpara><command>@tst_initlev_stride</command>&figspltt_lev_stride;</simpara></listitem>
549          <listitem><simpara><command>@tst_initorca2_stride</command>&figspltt_orca2_stride;</simpara></listitem>
550          <listitem><simpara><command>@tst_initorca05_stride</command>&figspltt_orca05_stride;</simpara></listitem>
551          </itemizedlist>
552        </para>
553    </sect2>
554
555    <sect2 id="plt1d">
556      <title>
557        1D plots
558      </title>
559        <para>
560          To be continued &hellip;
561        </para>
562   </sect2>
563
564
565  </sect1>
566 
567</article>
Note: See TracBrowser for help on using the repository browser.