source: trunk/SRC/Documentation/xmldoc/mini_notice.xml @ 158

<?xml version='1.0' encoding='iso-8859-1'?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[
<!ENTITY promptidl "idl&gt;">
]
>
<!--

./SAXO_DIR/SRC/Documentation/xmldoc/mini_notice.xml

update :
fplod 2006-07-20T08:45:14Z aedon.locean-ipsl.upmc.fr (Darwin)
. creation by hand made migration from mini_notice.html to XML/Docbook
. installation part has been removed
. add images
++ fake graphics callouts see forxxxdoc.sh

-->
<article lang="en">
<title>
Mini Guide for Basic Commands in the XXX Program
</title>
  <articleinfo>
    <authorgroup>
      <author><firstname>Sébastien</firstname><surname>Masson</surname><email>Sebastien.Masson_at_locean-ipsl.upmc.fr</email></author>
      <author><firstname>Albert</firstname><surname>Fisher</surname></author>
      <author><firstname>Françoise</firstname><surname>Pinsard</surname><email>Francoise.Pinsard_at_locean-ipsl.upmc.fr</email></author>
      <author><firstname>Steve</firstname><surname>Navarro</surname></author>
    </authorgroup>
    <keywordset>
      <keyword>idl</keyword>
      <keyword>SAXO</keyword>
      <keyword>xxx</keyword>
    </keywordset>
    <revhistory>
      <revision>
        <revnumber>0.0</revnumber>
        <date>May 29, 2000</date>
        <revremark>French release by Sébastien Masson</revremark>
      </revision>
      <revision>
        <revnumber>0.1</revnumber>
        <date>July, 2002</date>
        <revremark>Translation by Albert Fisher</revremark>
      </revision>
      <revision>
        <revnumber>0.2</revnumber>
        <date>July 20, 2006</date>
        <revremark>HTML to XML/Docbook migration by Françoise Pinsard</revremark>
      </revision>
     </revhistory>
     <pubdate>$Id$</pubdate>
  </articleinfo>


<!--
La partie suivante n'a plus tellement de sens maintenant que tout SAXO est disponible sur forge
<para>
Where to find the source code
</para>
The scripts are available in the IDL_29_5_2000 directory.
</para>
<para>
In this directory are
<itemizedlist>
<listitem><para>a tar file IDL_29_5_2000.tar with all the files</para></listitem>
<listitem><para>the scripts in ASCII, in subdirectories by theme</para></listitem>
</itemizedlist>

<para>
This IDL_29_5_2000 directory is available:
<itemizedlist>
<listitem><para>at LODYC: adonis.lodyc.jussieu.fr:/usr/home/smasson/IDL_29_5_2000</para></listitem>
<listitem><para>at IPSL: cook.ipsl.jussieu.fr:/home/smlod/IDL_29_5_2000</para></listitem>
<listitem><para>at IDRIS: rhodes.idris.fr:/home/rech/eee/reee217/IDL_29_5_2000</para></listitem>
<listitem><para>on the anonymous ftp site of LODYC (contact <ulink url="mailto:smasson@lodyc.jussieu.fr">smasson@lodyc.jussieu.fr</ulink>
for access).</para></listitem>
<listitem><para>soon, from <ulink url="http://www.lodyc.jussieu.fr/~opatlod/SAXO/"/></para></listitem>
</itemizedlist>
</para>
<para>
This mini guide is also found in the IDL_29_5_2000 directory, in
different formats.  It is also consultable on the web at:
</para>
<para>
<ulink url="http://www.ipsl.jussieu.fr/~smlod/mini_notice.html"/>
</para>

-->
<!-- ++ n'a plus rien à faire ici
<sect1 id="intro"><title>Introduction and assumptions</title>

<para>
This micro guide is unfortunately not a user's guide for all the
scripts that have been written for IDL (version 5.2 or higher
required). The goal is simply to clarify a few points on the use of the <filename>xxx.pro</filename>
program.
</para>
<para>
For further help on the furnished scripts, here are
several possibilities:

<itemizedlist>
<listitem><para>execute in IDL the command
  <screen format="linespecific">
<prompt>&promptidl;</prompt> <userinput>xhelp, '<replaceable>script_name</replaceable>'</userinput>
</screen>
</para></listitem>
<listitem><para>consult the IDL online help for scripts whose source is unavailable</para></listitem>
<listitem><para>
subscribe to the mailing list for updates and user questions/responses
</para>
<para>
to subscribe, send a mail to: <ulink url="mailto:majordomo@lmd.jussieu.fr">majordomo@lmd.jussieu.fr</ulink>
with no subject, containing the message:
<userinput>subscribe forum-idl <replaceable>e-mail address</replaceable></userinput>
</para></listitem>
<listitem><para>consult the archives of this mail list:
    <ulink url="http://www.lmd.jussieu.fr/archives/form-idl/last/mail1.html"/></para></listitem>
<listitem><para>consult in desperation the feeble web pages we have started to write
  (while waiting for something better)
  <ulink url="http://www.ipsl.jussieu.fr/~smlod/"/></para></listitem>
<listitem><para>wait until we write a full user's manual!</para></listitem>
</itemizedlist>
</para>

<para>
The XXX widget is a layer on top of the scripts in the <application>SAXO</application> package
(themselves layered on top of IDL). It is designed to permit the
visualization and rapid exploration of data, offering a maximum in
options, while not necessarily all those offered by the package and by
IDL.
</para>
<para>
Based on the use of files in the NetCDF format, it can easily work
with other file formats.  For this, all that is necessary is to write
an IDL function capable of extracting a matrix from a file as a
function of the following parameters: the variable name, two dates, an
experiment name, and a domain.
</para>
<para>
Developed to visualize the output of the OPA model, the <application>SAXO</application> package was
conceived to work on C grids.  To use it on grids where the T, U, and
V points are the same, one must nevertheless declare the parameters of
the grid that correspond to the U and V points.  Careful, for this
type of discretization, the calculation scripts of type <filename>div.pro</filename> and
<filename>curl.pro</filename> are wrong.
</para>
<para>
The averaging routines are not adapted to warped grids, they sum
following the i, j, and k indices, weighting each point by scale
factors and the land-sea mask.  Slices and Hovmoellers do not work in
the diagonal, but are always done following i, j, or k.  When a domain
is given to one of the scripts, an average over the domain in the
directions perpendicular to that displayed is automatically made before
display.
</para>
<para>
Before continuing on to the practical part of this guide, the
installation and use of the <application>SAXO</application> package, I'd like to thank Guillaume
Roullet, who also participated in the writing of the scripts in the
package (notably the drawing of vectors on warped grids).
</para>
</sect1>

<sect1 id="beforefirststeps">
<title>Before this</title>
<para>
In this document, we supposed that you followed <ulink url="getsaxo.html?format=raw">Get SAXO</ulink> recommandations.
</para>
</sect1>


<sect1 id="initfiles"><title>Install the files <filename>init.pro</filename> and
<filename>initgrid.pro</filename></title>

<para>
This version of the <application>SAXO</application> package depends a certain number of common
variables that are primarily environmental parameters (working paths,
color management, Postscript formatting) and the parameters of the
grid on which you are working (longitude, latitude, depth, land-sea
mask, scale factors, position of the zoom in relation to the original
grid).
</para>
<para>
These two types of parameters are kept separately:
<itemizedlist>
<listitem><para>environmental parameters are defined at the very beginning of the
IDL session, and are in principle never changed.  They are initialized
by the <filename>init.pro</filename> script.</para></listitem>
<listitem><para>Those that belong to the grid are reinitialized every time the
grid is changed.  They can therefore be called at any time during a
session. These parameters are initialized by the <filename>initgrid.pro</filename>
scripts, and are specific to each particular grid.
</para>
<para>
For example: <filename>initorca.pro</filename> for the ORCA 2&deg; grid,
<filename>initorca05.pro</filename> for
the ORCA 0.5&deg; grid, or <filename>initorcapac.pro</filename> for the ORCA grid zoomed on
the Pacific.</para></listitem>
</itemizedlist>
</para>
<para>
To begin, one must therefore copy <filename><replaceable>packagedir</replaceable>/INIT/init.pro</filename>
into <replaceable>homedir</replaceable>, and create in <replaceable>homedir</replaceable> a script of the
type <filename>initgrid.pro</filename>.
</para>

<sect2 id="modifinit"><title>Modification of the <filename>init.pro</filename> script</title>

<para>
It is necessary to personalize the lines that correspond to the 6
directories defined in &sect; 1.1.  That is:
<itemizedlist>
<listitem><para>The definition of !path.</para><para>
The first expand_path must contain <replaceable>homedir</replaceable>, the second
<replaceable>packagedir</replaceable>.  The directory declaration must be preceded by a +
sign, and must take the form of a character chain. The + sign
specifies that subdirectories must also be considered.  For those
working on a Mac, <literallayout>"+':'+"</literallayout> must be replaced by <literallayout>"+','+"</literallayout> and for Windows
by <literallayout>"+';'+"</literallayout>.</para>
<warning>
<para>
In their definition, the directories must not finish with the
directory separation character ("/" under UNIX/Linux).
</para>
</warning>
</listitem>
<listitem><para>Definition of the rest of the directories:</para><para>
Define as necessary the variables homedir, workdir, iodir, animdir,
psdir, and imagedir.</para>
<warning>
<para>
Despite precautions taken, in order to avoid bugs it is
recommended that these directories be defined with the directory
separation character as the final character ("/" under UNIX/Linux).
</para>
</warning>
</listitem>
</itemizedlist>
</para>
<note>
<para>
Depending on the resolution of your screen and the type of
machine used, it is possible that the graphics window which is created
will be too large.  If this is the case, change the ccwindowsize
variable which is a multiplicative coefficient applied to the window
size.
</para>
</note>
</sect2>
<sect2 id="modifinitgrid"><title>Modification or creation of the <filename>initgrid.pro</filename> script</title>

<para>
In the <replaceable>packagedir</replaceable>/INIT directory you will find a certain
number of scripts associated with the latest grids on which I've
worked.  If you are also working on one of these grids, for example
ORCA, copy the file  <filename><replaceable>packagedir</replaceable>/INIT/initorca.pro</filename> to your
<replaceable>homedir</replaceable>.  If not, copy it nevertheless to use as a model.  In
the file <filename>initgrid.pro</filename>, adjust the zoom parameters (if it has not
already been done).
</para>
<para>
Careful: unlike in previous versions of the <application>SAXO</application> package, all the zoom
parameters must be defined.  If you do not know them in advance,
define their values to be -1.
</para>
<para>
In the rest of the script, define iodir as <replaceable>iodir</replaceable>, and verify
the name of the mask file, if one exists.
</para>
</sect2>
</sect1>
-->
<sect1 id="introxxx"><title>XXX widget functions</title>
<sect2 id="launchxxx"><title>Launching XXX</title>

<para>
The first command to type is

  <screen format="linespecific">
<prompt>&promptidl;</prompt> <userinput>@init</userinput>
</screen>

</para>
<para>
Afterwards, to work directly with XXX, type:

  <screen format="linespecific">

<prompt>&promptidl;</prompt> <userinput>xxx</userinput>
</screen>

</para>


A window will open with 2 lines to complete.
<figure id="fig_xxx_0101">
<title>Window xxx 1</title>
<mediaobjectco>
<imageobjectco>
<areaspec units="calspair">
<area id="datafile" coords="500,1715 9326,3074"/>
<area id="initmethod" coords="1500,3268 8326,4919"/>
<area id="initprogram" coords="57,5145 9961,8996"/>
</areaspec>
<imageobject>
<imagedata fileref="figpng/xxx_0101.png"/> <!-- ++ instead of figpng/xxx_0101_org.png -->
</imageobject>
<calloutlist>
<callout arearefs="datafile">
<para>Data file</para>
</callout>
<callout arearefs="initmethod">
<para>Init method</para>
</callout>
<callout arearefs="initprogram">
<para>Init program</para>
</callout>
</calloutlist>
</imageobjectco>
<!-- ++ si on met textobject, on ne voit plus l'image !!
<textobject>[plot figpng/xxx_0101.png]</textobject>
-->
</mediaobjectco>
</figure>
<sect3 id="datafiletxt"><title>File name</title>
  <para>
    the name of the data file. The name can be typed directly in the window
    provided, or selected with the help of the <guibutton>browse</guibutton> button.
</para>
</sect3>
<sect3 id="initmethodtxt"><title>Grid initalization method</title>
  <para>
    By default, "automatic grid construction with initncdf.pro" is checked.
  </para>
  <para>
    But you can choose an other grid by checking "grid construction with other IDL batch or procedure"  
  </para>
</sect3>
<sect3 id="initprogramtxt"><title>Grid initalization parameters</title>
  <para>
    <figure id="fig_xxx_0102">
      <title>Window xxx 1</title>
      <mediaobjectco>
        <imageobjectco>
          <imageobject>
            <imagedata fileref="figpng/xxx_0102.png"/>
          </imageobject>
        </imageobjectco>
      </mediaobjectco>
    </figure>
  </para>
  <para>
    the second the name of
    the <filename>initgrid.pro</filename> script which will permit the reading and processing of the
    grid associated with the data file.
  </para>
  <para>
    Once these two lines have been completed, click on <guibutton>let's go</guibutton>.
  </para>
  <para>For example, we choose the mask "tst_initlev". Compare the result with "automatic grid construction with initncdf.pro" checked. Cf <xref linkend="fig_xxx_0404"/> </para>
<para>
  <figure id="fig_xxx_0103">
      <title>Oceania at 125 metters of depth with a mask</title>
        <imageobject>
          <imagedata fileref="figpng/xxx_0103.png"/>
        </imageobject>
  </figure>
</para>
</sect3>
</sect2>

<sect2 id="wigdets"><title>Description of XXX window</title>

<para>
Now the XXX window will open.
<!-- cf example in http://www.docbook.org/tdg/en/html/area.html
sauf que dans l'exemple en question on ne donne que 2 nombres et pas 4
voir aussi message http://www.oasis-open.org/archives/docbook-apps/200501/msg00089.html
peut-etre du nouveau dans les xsl depuis le 16 janvier 2005
peut-être essayé http://lists.kde.org/?l=kde-doc-english&m=112780764426265&w=2
ce produit klickety est installable via fink sous mac
 -->
<figure id="fig_xxx_0201">
<title>Window xxx 2</title>
<mediaobjectco>
<imageobjectco>
<areaspec units="calspair">
<area id="plottype" coords="69,380 2261,809"/>
<area id="menu" coords="2517,380 7575,841"/>
<area id="ok" coords="116,936 1025,1365"/>
<area id="pagelayout" coords="1631,936 4498,1365"/>
<area id="variableslist" coords="4871,952 7529,1349"/>
<area id="fileslist" coords="46,1507 8018,1857"/>
<area id="commandtext" coords="46,2000 8065,2539"/>
<area id="calendar" coords="46,2682 4941,3428"/>
<area id="domdef" coords="372,3603 7179,7095"/>
<area id="specifications" coords="23,7269 8041,9206"/>
</areaspec>
<imageobject>
<imagedata fileref="figpng/xxx_0201.png"/> <!-- ++ instead of figpng/xxx_0201_org.png -->
</imageobject>
<calloutlist>
<callout arearefs="plottype">
<para>Plot type</para>
</callout>
<callout arearefs="menu">
<para>Menu</para>
</callout>
<callout arearefs="ok">
<para>OK</para>
</callout>
<callout arearefs="pagelayout">
<para>Page layout</para>
</callout>
<callout arearefs="variableslist">
<para>Variables list</para>
</callout>
<callout arearefs="fileslist">
<para>Files list</para>
</callout>
<callout arearefs="commandtext">
<para>Command text</para>
</callout>
<callout arearefs="calendar">
<para>Calendar</para>
</callout>
<callout arearefs="domdef">
<para>Domdef</para>
</callout>
<callout arearefs="specifications">
<para>Spefications</para>
</callout>
</calloutlist>
</imageobjectco>
<!-- ++ si on met textobject, on ne voit plus l'image
<textobject>[plot figpng/xxx_0201.png]</textobject>
-->
</mediaobjectco>
</figure>
</para>
<para>
It's configuration will change
depending on whether you are in portrait or in landscape, but here are
the different parts available for your use.
</para>

<sect3 id="plottypetxt"><title>Plot type list</title>
<para>allows specification of the type of plot desired.</para>
<para>
    <figure id="fig_xxx_0202">
      <title>Differents plot types avaibles</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0202.png"/>
          </imageobject>
    </figure>
</para>
<note>
<para>
If the type <constant>plt</constant> is selected, the selection of plot type
is made by mouse. Cf <xref linkend="mouse"/></para>
</note>
</sect3>

<sect3 id="menutxt"><title>The menu bar made up of 3 submenus</title>
<sect4 id="filesubmenu"><title><guisubmenu>File</guisubmenu> submenu</title>
<para>
    <figure id="fig_xxx_0203">
      <title>The File menu</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0203.png"/>
          </imageobject>
    </figure>
</para>

<para>
<itemizedlist>
<listitem>
<para>
<guimenuitem>Open:</guimenuitem> to open a second file.  Same procedure as during the
launching of XXX.  The new file can be on a different grid, with
different variables, with a different time base.
</para></listitem>
<listitem><para><guimenuitem>New XXX:</guimenuitem> to open a second XXX window identical to the first.</para></listitem>
<listitem><para><guimenuitem>Close:</guimenuitem> to close the XXX window.</para></listitem>
</itemizedlist>
</para>

</sect4>
<sect4 id="saveassubmenu"><title><guisubmenu>Save As</guisubmenu> submenu</title>
<para>
    <figure id="fig_xxx_0204">
      <title>The Save As menu</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0204.png"/>
          </imageobject>
    </figure>
</para>

<para>
<itemizedlist>
<listitem><para><guimenuitem>Postscript:</guimenuitem> to save in Postscript format</para></listitem>
<listitem><para><guimenuitem>Animated gif:</guimenuitem> to create an animation from the XXX window.
Careful, the creation of an animation is only possible if none of the
plots have a time axis, and if the plots are all on the same time base
(calendar).  On the other hand, animations of horizontal and vertical
plots, with different color palettes (for those not on an X-terminal),
are possible.
<note>
<para>
the creation of animations has a tendency to saturate the video
memory of X-terminals, crashing the entire program...</para>
</note>
</para></listitem>
<listitem><para><guimenuitem>Gif:</guimenuitem> to save a gif of the XXX graphics window.</para></listitem>
<listitem><para><guimenuitem>IDL procedure:</guimenuitem> to save the command history that has created the
plot.  For example if I save the commands in <filename>xxx_figure.pro</filename>, I can
then launch a new IDL session and type:
  <screen format="linespecific">
<prompt>&promptidl;</prompt> <userinput>@init</userinput>
<prompt>&promptidl;</prompt> <userinput>xxx_figure</userinput>
</screen>
</para>
<para>
and I'll obtain the saved figure.
  <screen format="linespecific">
<prompt>&promptidl;</prompt> <userinput>xxx_figure,/post </userinput>
</screen>
or
  <screen format="linespecific">
<prompt>&promptidl;</prompt> <userinput>@ps</userinput>
</screen>
will then create a Postscript file of the figure.</para><para></para></listitem>
<listitem><para><guimenuitem>RESTORE kwd of xxx:</guimenuitem></para></listitem>
<listitem><para><guimenuitem>Print to prompt:</guimenuitem> lists in the IDL window the command history that
created the last plot.  Useful primarily for debugging...</para></listitem>
</itemizedlist>
</para>
</sect4>
<para>Test the various possibilities in the <guimenu>Save As</guimenu> menu.</para>
<sect4 id="flagsubmenu"><title><guisubmenu>Flag options</guisubmenu> submenu</title>
<para>
    <figure id="fig_xxx_0205">
      <title>The Flag Option menu</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0205.png"/>
          </imageobject>
    </figure>
</para>

<para>
<itemizedlist>
<listitem><para><guibutton>Portrait/Landscape:</guibutton> changes the configuration of the plot.</para></listitem>
<listitem><para><guibutton>Overlay:</guibutton> to plot contours of a different field on top the
one represented as color-filled contours.  It is necessary to relaunch the
entire plot to make this work!</para></listitem>
<listitem><para><guibutton>Vecteur:</guibutton> to plot a vector field on top of contours. Only
works on horizontal plots (<filename>plt.pro</filename>).  As for Overlay, a relaunch of
the entire plot is necessary.</para></listitem>
<listitem><para><guibutton>Longitude / x index:</guibutton> switches longitude labelling of the plot
subdomain from degrees to indices following i. </para></listitem>
<listitem><para><guibutton>Latitude / y index:</guibutton> switches latitude labelling of the plot
subdomain from degrees to indices following j. </para></listitem>
</itemizedlist>
</para>
</sect4>
<para>
Test the various possibilities in the <guimenu>Flag options</guimenu> menu.
</para>
<caution>
<para>
Careful, a selected option remains selected until it is reclicked.
</para>
</caution>
</sect3>

<sect3 id="oktxt"><title>OK button</title>
<para>click on this <guibutton>OK</guibutton> button is required to make a new plot appear</para>
</sect3>

<sect3 id="pagelayouttxt"><title>Page Layout</title>
<para>specify the number of columns and rows for plots on the sheet of paper.</para>
<para>
    <figure id="fig_xxx_0206">
      <title>Number of Column</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0206.png"/>
          </imageobject>
    </figure>
</para>
<para>For example: For 2 cln and 2 row. For explanations, see further.</para>
<para>
    <figure id="fig_xxx_0206a">
      <title>A frame with several graphics</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0206a.png"/>
          </imageobject>
    </figure>
</para>
</sect3>

<sect3 id="variableslisttxt"><title><guimenuitem>List of variables</guimenuitem></title>
<para> you can choose the variable to work on.</para>
<para>
    <figure id="fig_xxx_0207">
      <title>differents Variables avaible</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0207.png"/>
          </imageobject>
    </figure>
</para>
</sect3>

<sect3 id="fileslisttxt"><title><guimenuitem>List of open files</guimenuitem></title>
<para> you can choose the file to work on.</para>
<para>
    <figure id="fig_xxx_0208">
      <title>List of open files</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0208.png"/>
          </imageobject>
    </figure>
</para>
</sect3>

<sect3 id="commandtexttxt"><title><guimenuitem>Command text</guimenuitem></title>
<para>To specify the computation you want to do. 
Examples: </para>
<sect4 id="withoutcommandtexttxt"><title><guimenuitem> Without any Command Text</guimenuitem></title>
<para>
    <figure id="fig_xxx_0209">
      <title>Graphic by default</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0209.png"/>
          </imageobject>
    </figure>
</para>
</sect4>

<sect4 id="withrealcont"><title><guimenuitem> With the command text /realcont</guimenuitem></title>
<para>
    <figure id="fig_xxx_0210a">
      <title>Command text area</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0210a.png"/>
          </imageobject>
    </figure>
</para>
<para>
    <figure id="fig_xxx_0210">
      <title>Graphic with the command text "/realcont"</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0210.png"/>
          </imageobject>
    </figure>
</para>
</sect4>

<sect4 id="withmaportho"><title><guimenuitem>With the command text /realcont+ map=[90,0,0]+ /ortho+ cell_fill=2.</guimenuitem></title>
<para>
    <figure id="fig_xxx_0211a">
      <title>Command text area with the right syntax</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0211a.png"/>
          </imageobject>
    </figure>
</para>
<para>
    <figure id="fig_xxx_0211">
      <title>Polar Projection</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0211.png"/>
          </imageobject>
    </figure>
</para>
</sect4>

<note><para>In the default case, the name given to a field is of no importance.</para></note>
</sect3>

<sect3 id="calendartxt"><title>Calendar</title>
<para>
The calendar is made up of two droplists, which allow specification of
two dates, the beginning and end of a time series, or the period over
which to average before plotting.</para>
<para>Example: The first plot is during January.</para>
<para>         The second plot is from January to December.</para>
<para>
    <figure id="fig_xxx_0301">
      <title>Graphic with 2 different period of study</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0301.png"/>
          </imageobject>
    </figure>
</para>
</sect3>

<sect3 id="domdeftxt"><title>Define the domain</title>
<para>
A series of widgets that allow specification of the min/max limits of
the domain in longitude/x-index, latitude/y-index, and depth in levels
or meters.  For depth, one can specify in levels for a horizontal
plot, and in meters for a vertical plot.
</para>

<sect4 id="withoutdomainspecification"><title><guimenuitem>Without any domain specification</guimenuitem></title>
<para>
    <figure id="fig_xxx_0210">
      <title>Domain by default</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0210.png"/>
          </imageobject>
    </figure>
</para>
</sect4>

<sect4 id="withzoom"><title><guimenuitem>With a zoom on Oceania</guimenuitem></title>
<para>We can zoom, between 0 and 1 meter of depth, on the Oceania, by playing with the part Domdef, with this configuration</para>
<para>
    <figure id="fig_xxx_0401">
      <title>Change Domain area</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0401.png"/>
          </imageobject>
    </figure>
</para>
<para>This configuration give us:</para>
<para>
    <figure id="fig_xxx_0402">
      <title>Graphic with a specified domain</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0402.png"/>
          </imageobject>
    </figure>
</para>
</sect4>
</sect3>

<sect4 id="depthspecificationtxt"><title><guimenuitem>With the specification of the depth</guimenuitem></title>
<para>If we want to see the temperature of the ocean between 125 and 126 meters of depth</para>
<para>
    <figure id="fig_xxx_0403">
      <title>Change depth area</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0403.png"/>
          </imageobject>
    </figure>
</para>
<para>
    <figure id="fig_xxx_0404">
      <title>Oceania at 125 metters of depth without a mask</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0404.png"/>
          </imageobject>
    </figure>
</para>
<para>As you can see, at this depth, we can see the difference between the continent at the surface and the real goegraphy of the terrain. If we want to see only the terrain at the specified depth, we have to put a mask. Cf <xref linkend="fig_xxx_0103"/></para>  
<para>You can define precisely the depth you want to see:</para>
<para>
    <figure id="fig_xxx_0405">
      <title>The Precise Depth menu</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0405.png"/>
          </imageobject>
    </figure>
</para>
</sect4>


<sect3 id="specificationstxt"><title>specify your plot</title>
<sect4 id="minmaxintervaltxt"><title><guimenuitem>Specify the min, the max and the interval</guimenuitem></title>
<para>
You can specify the min, max, and contour interval by filling out the
provided boxes!
</para>
<para>
You can restore configuration by default by pressing the "default" button.
</para>
<para>
    <figure id="fig_xxx_0501">
      <title>Specification area</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0501.png"/>
          </imageobject>
    </figure>
</para>
</sect4>

<sect4 id="colortxt"><title><guimenuitem>Specify the palette to be used</guimenuitem></title>
<para>For the color palette, you can either specify the name
or go search for one among the palettes available.
</para>
<para>
    <figure id="fig_xxx_0502">
      <title>The Color menu</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0502.png"/>
          </imageobject>
    </figure>
</para>
</sect4>

<para>
The "keywords" window allows specification of all desired
keywords. These keywords can be those of
<filename>plt.pro</filename>, <filename>pltt.pro</filename>, <filename>pltz.pro</filename>,
<filename>plt1d.pro</filename>, or those of contour, plot, or all other programs that are
used. Cf <xref linkend="commandtexttxt"/> 
</para>
</sect3>


</sect2>
</sect1>
<sect1 id="mouseactions"><title>Mouse Actions</title>

<sect2 id="mouse"><title>In the graphics window on a horizontal plot</title>
<para>
Select a domain and select the horizontal plot (<constant>plt</constant>), vertical plot
(<constant>pltz</constant>), or the hovmoeller plot (<constant>pltt</constant>):</para>
<para>
The domain we'd like to select for the plot is determined by one of
its diagonals, defined therefore by two points.  The first point is
defined when the mouse button is pushed, then the mouse is moved, and
the second point is defined as the mouse button is released
(click-drag).  The domains are thus defined by a long click (<abbrev>LC</abbrev>).  To
determine which type of plot should be made of selection, use:
</para>
<para>
If the plot selector is on <constant>plt</constant>
<itemizedlist>
<listitem><para>the left mouse button to create horizontal plots (<constant>plt</constant>)</para></listitem>
<listitem><para>the middle mouse button to create vertical plots (<constant>pltz</constant>)</para></listitem>
<listitem><para>the right mouse button to create common hovmoellers for xt and yt cuts (<constant>pltt</constant>)</para></listitem>
</itemizedlist>
</para>

<para>In summary:</para>
<para>
<itemizedlist>
<listitem><para>
    <figure id="fig_mousell">
      <title><abbrev>LCL</abbrev>---><constant>plt</constant></title>
      <mediaobjectco>
        <imageobjectco>
          <imageobject>
            <imagedata fileref="figpng/xxx_mousell.png"/>
          </imageobject>
        </imageobjectco>
      </mediaobjectco>
    </figure>
<para>
    <figure id="fig_xxx_0701">
      <title>Horizontal Plot</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0701.png"/>
          </imageobject>
    </figure>
</para>

</para></listitem>
<listitem><para>
    <figure id="fig_mouselm">
      <title><abbrev>LCM</abbrev>---><constant>pltz</constant></title>
      <mediaobjectco>
        <imageobjectco>
          <imageobject>
            <imagedata fileref="figpng/xxx_mouselm.png"/>
          </imageobject>
        </imageobjectco>
      </mediaobjectco>
    </figure>
<para>
    <figure id="fig_xxx_0702">
      <title>Vertical Plot</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0702.png"/>
          </imageobject>
    </figure>
</para>

</para></listitem>
<listitem><para>
    <figure id="fig_mouselr">
      <title><abbrev>LCR</abbrev>---><constant>pltt</constant></title>
      <mediaobjectco>
        <imageobjectco>
          <imageobject>
            <imagedata fileref="figpng/xxx_mouselr.png"/>
          </imageobject>
        </imageobjectco>
      </mediaobjectco>
    </figure>
<para>
    <figure id="fig_xxx_0703">
      <title>Common hovmoeller for xt and yt cuts</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0703.png"/>
          </imageobject>
    </figure>
</para>

</para></listitem>
</itemizedlist>
</para>

<note><para>If the plot selector is on something other than <constant>plt</constant> the indicated plot type is made.</para></note>

</sect2>
<sect2 id="multipleplots"><title>Create multiple plots on the same sheet and make them interact</title>

<para>
Select the number of columns and rows for the page.</para>
<para>
Create a first plot.  It will appear in the first frame.</para>
<para>
To create a plot in another frame double-click in the frame with the
middle button (<abbrev>DCM</abbrev>).  A black dotted frame will surround the
designated frame, the <quote>target</quote> frame.  A black frame will surround the
first plot.  This is the <quote>reference</quote> frame, in other words the one
that all the XXX widgets refer to.  Change for example the date and
create a new plot.  With a left button double-click in the first
frame, all the widgets change and refer again to the first plot.  A
double-click with the right button in the second frame will erase the
plot.</para>
<para>In summary: </para>
<itemizedlist>
<listitem><para>
    <figure id="fig_mousedl">
      <title><abbrev>DCL</abbrev>---><quote>reference</quote> frame</title>
      <mediaobjectco>
        <imageobjectco>
          <imageobject>
            <imagedata fileref="figpng/xxx_mousedl.png"/>
          </imageobject>
        </imageobjectco>
      </mediaobjectco>
    </figure>
<para>
    <figure id="fig_xxx_0801">
      <title>The reference frame is selected</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0801.png"/>
          </imageobject>
    </figure>
</para>
    
</para></listitem>
<listitem><para>
    <figure id="fig_mousedm">
      <title><abbrev>DCM</abbrev>---><quote>target</quote> frame</title>
      <mediaobjectco>
        <imageobjectco>
          <imageobject>
            <imagedata fileref="figpng/xxx_mousedm.png"/>
          </imageobject>
        </imageobjectco>
      </mediaobjectco>
    </figure>
<para>
    <figure id="fig_xxx_0802">
      <title>The target frame is selected</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0802.png"/>
          </imageobject>
    </figure>
</para>
</para></listitem>
<listitem><para>
    <figure id="fig_mousedr">
      <title><abbrev>DCR</abbrev>--->erase the frame</title>
      <mediaobjectco>
        <imageobjectco>
          <imageobject>
            <imagedata fileref="figpng/xxx_mousedr.png"/>
          </imageobject>
        </imageobjectco>
      </mediaobjectco>
    </figure>
    
</para></listitem>
</itemizedlist>
<para>Here's a series of commands to show how this works.</para>
<procedure>
<step>
<para>
Select a 3-D field and create 6 frames for the sheet of paper.
</para>
</step>
<step>
<para>
Create a horizontal plot in Frame 1
</para>
</step>
<!-- je n'arrive pas à utliser <stepalternatives> -->
<step>
<para>
<abbrev>DCM</abbrev> in frame 2, <abbrev>LCL</abbrev> on the plot in frame 1, to create a horizontal
zoom in frame 2.</para>
<para>
<abbrev>DCM</abbrev> in frame 3, <abbrev>LCM</abbrev> on the plot in frame 1, to create a vertical cut
in frame 3.</para>
<para>
<abbrev>DCM</abbrev> in frame 4, <abbrev>LCR</abbrev> on the plot in frame 1, to create a hovmoeller in frame 4.
</para>
<para>
    <figure id="fig_xxx_0901">
      <title>Frame with four plot</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0901.png"/>
          </imageobject>
    </figure>
</para>
</step>
</procedure>
<procedure>
<para>
To redo the hovmoeller with the keyword <literallayout>/nocontour</literallayout>
</para>
<step>
<para>
<abbrev>DCL</abbrev> in frame 4 which now becomes the reference and target frame.
</para>
</step>
<step>
<para>
Add the keyword
<literallayout>/nocontour</literallayout>
<para>
    <figure id="fig_xxx_0902a">
      <title>Command text area</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0902a.png"/>
          </imageobject>
    </figure>
</para>
</para>
</step>
<step>
<para>
click <guibutton>OK</guibutton>, and the plot is redone.
</para>
<para>
    <figure id="fig_xxx_0902">
      <title>The fourth plot with the keyword "nocontour"</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0902.png"/>
          </imageobject>
    </figure>
</para>
</step>
</procedure>
<procedure>
<para>
in frame 5, let's create the same plot as in frame 2 except with different dates
</para>
<step>
<para>
<abbrev>DCL</abbrev> on frame 2
</para>
</step>
<step>
<para>
<abbrev>DCM</abbrev> on frame 5
</para>
</step>
<step>
<para>
change the date
</para>
</step>
<step>
<para>
click on <guibutton>OK</guibutton>
</para>
<para>
    <figure id="fig_xxx_0903">
      <title>Frame with five plot</title>
          <imageobject>
            <imagedata fileref="figpng/xxx_0903.png"/>
          </imageobject>
    </figure>
</para>
</step>
</procedure>
</sect2>
</sect1>
<sect1 id="crash"><title>What should I do when it breakdown</title>

<para>
<orderedlist>
<listitem>
<para>
in the IDL window, type
  <screen format="linespecific">
<prompt>&promptidl;</prompt> <userinput>retall</userinput>
</screen>
</para></listitem>
<listitem>
<para><abbrev>DCR</abbrev> to erase the problem frame. 
</para>
</listitem>
<listitem><para>change the orientation of the plot by pressing Flag options -> Portrait/Landscape. Cf <xref linkend="flagsubmenu"/>
</para></listitem>
<listitem><para>quit XXX cleanly using <guibutton>quit</guibutton> from the <guimenu>File</guimenu> menu. Cf <xref linkend="filesubmenu"/>
</para></listitem>
</orderedlist>
</para>
<note>
<para>
Always avoid if at all possible closing and killing the XXX
window, but rather select <guibutton>quit</guibutton> from the <guimenu>File</guimenu> menu.  XXX uses a
large number of pointers, and wantonly killing the window will leave a
large number of unused variables in memory, which could in the end
overflow.  To clean up this memory:
  <screen format="linespecific">
<prompt>&promptidl;</prompt> <userinput>ptr_free, ptr_valid()</userinput>
</screen>
</para>
</note>
</sect1>
</article>