Changeset 188 for trunk/SRC/Documentation/xmldoc/firststeps.xml
- Timestamp:
- 09/21/06 14:59:48 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/xmldoc/firststeps.xml
r183 r188 4 4 [ 5 5 <!ENTITY promptidl "idl>"> 6 <!ENTITY numb1 '<inlinemediaobject><imageobject><imagedata fileref="images/callouts/1.png ?format=raw" format="PNG"/></imageobject><textobject><phrase>1</phrase></textobject></inlinemediaobject>'>7 <!ENTITY numb2 '<inlinemediaobject><imageobject><imagedata fileref="images/callouts/2.png ?format=raw" format="PNG"/></imageobject><textobject><phrase>2</phrase></textobject></inlinemediaobject>'>8 <!ENTITY showfig '<inlinemediaobject><imageobject><imagedata fileref="images/showfig.png ?format=raw" format="PNG"/></imageobject><textobject><phrase>show result</phrase></textobject></inlinemediaobject>'>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 9 ]> 10 10 … … 67 67 <title>Before this</title> 68 68 <para> 69 In this document, we supposed that you followed <ulink url=" getsaxo.html">Get SAXO</ulink> recommendations.69 In this document, we supposed that you followed <ulink url="./getsaxo.html">Get SAXO</ulink> recommendations. 70 70 </para> 71 71 </sect1> … … 137 137 <prompt>&promptidl;</prompt> <userinput><command>n = 10</command></userinput> 138 138 <prompt>&promptidl;</prompt> <userinput><command>y = findgen(n)</command></userinput> &numb1; 139 <prompt>&promptidl;</prompt> <userinput><command>plot, y</command></userinput> <ulink url=" figpng/basic_plot.png?format=raw">&showfig;</ulink>139 <prompt>&promptidl;</prompt> <userinput><command>plot, y</command></userinput> <ulink url="./figpng/basic_plot.png">&showfig;</ulink> 140 140 </screen> 141 141 <calloutlist> … … 157 157 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. 158 158 <screen format="linespecific"> 159 <prompt>&promptidl;</prompt> <userinput><command>splot, y</command></userinput> <ulink url=" figpng/basic_splot1.png?format=raw">&showfig;</ulink>159 <prompt>&promptidl;</prompt> <userinput><command>splot, y</command></userinput> <ulink url="./figpng/basic_splot1.png">&showfig;</ulink> 160 160 <computeroutput>% Compiled module: SPLOT.</computeroutput> 161 161 <computeroutput>% Compiled module: REINITPLT.</computeroutput> … … 233 233 <para> 234 234 <screen format="linespecific"> 235 <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?format=raw">&showfig;</ulink>235 <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> 236 236 </screen> 237 237 <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> 238 238 <screen format="linespecific"> 239 239 <prompt>&promptidl;</prompt> <userinput><command>splot, y, yrange = [0, (n-1)^2], title = 'x and x^2'</command></userinput> 240 <prompt>&promptidl;</prompt> <userinput><command>oplot, y^2, color = 50, linestyle = 2</command></userinput> <ulink url=" figpng/basic_splot4.png?format=raw">&showfig;</ulink>240 <prompt>&promptidl;</prompt> <userinput><command>oplot, y^2, color = 50, linestyle = 2</command></userinput> <ulink url="./figpng/basic_splot4.png">&showfig;</ulink> 241 241 </screen> 242 242 Use the keyword small to produce multi plots figures. … … 252 252 <prompt>&promptidl;</prompt> <userinput><command>splot, y, y^2, title = 'y = x^2', psym = 2, small &numb1; = [1, 2, 1]</command></userinput> 253 253 <prompt>&promptidl;</prompt> <userinput><command>splot, findgen(360)/36., findgen(360)*2.*!dtor, /polar $</command></userinput> 254 <prompt>&promptidl;</prompt> <userinput><command> , small &numb1; = [1, 2, 2], /noerase &numb2;</command></userinput> <ulink url=" figpng/basic_splot3.png?format=raw">&showfig;</ulink>254 <prompt>&promptidl;</prompt> <userinput><command> , small &numb1; = [1, 2, 2], /noerase &numb2;</command></userinput> <ulink url="./figpng/basic_splot3.png">&showfig;</ulink> 255 255 </screen> 256 256 <calloutlist> … … 280 280 <prompt>&promptidl;</prompt> <userinput><command>z = dist(n)</command></userinput> 281 281 <computeroutput>% Compiled module: DIST.</computeroutput> 282 <prompt>&promptidl;</prompt> <userinput><command>scontour, z</command></userinput> <ulink url=" figpng/basic_scontour1.png?format=raw">&showfig;</ulink>282 <prompt>&promptidl;</prompt> <userinput><command>scontour, z</command></userinput> <ulink url="./figpng/basic_scontour1.png">&showfig;</ulink> 283 283 <computeroutput>% Compiled module: SCONTOUR.</computeroutput> 284 284 <computeroutput>% Compiled module: CHKSTRU.</computeroutput> … … 290 290 <screen format="linespecific"> 291 291 <prompt>&promptidl;</prompt> <userinput><command>scontour, z, /fill, nlevels = 15, subtitle = 'nicer contour' $</command></userinput> 292 <prompt>&promptidl;</prompt> <userinput><command> , xtitle = 'x index', charsize = 1.5</command></userinput> <ulink url=" figpng/basic_scontour2.png?format=raw">&showfig;</ulink>292 <prompt>&promptidl;</prompt> <userinput><command> , xtitle = 'x index', charsize = 1.5</command></userinput> <ulink url="./figpng/basic_scontour2.png">&showfig;</ulink> 293 293 </screen> 294 294 It can be used in combination with contour to make more complex plots: … … 301 301 <prompt>&promptidl;</prompt> <userinput><command>scontour, z, levels = n*ind, c_orientation = 180*ind, c_spacing = 0.4*ind</command></userinput> 302 302 <prompt>&promptidl;</prompt> <userinput><command>contour, z, /overplot, c_label = rebin([1, 0], 2, n) &numb1;, levels = n*ind $</command></userinput> 303 <prompt>&promptidl;</prompt> <userinput><command> , c_charthick = 2, c_charsize = 1.5, c_colors = 250*ind</command></userinput> <ulink url=" figpng/basic_scontour3.png?format=raw">&showfig;</ulink>303 <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> 304 304 </screen> 305 305 <calloutlist> … … 317 317 </calloutlist> 318 318 </screenco> 319 <command>scontour</command> is compatible with the positioning method associated with the <computeroutput>small</computeroutput> keyword. See for example the test file <ulink url="../../Tests/tst_basic.pro?format=raw"><filename>tst_basic.pro</filename></ulink>:320 <screen format="linespecific"> 321 <prompt>&promptidl;</prompt> <userinput><command>tst_basic</command></userinput> <ulink url=" figpng/tst_basic.png?format=raw">&showfig;</ulink>319 <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>: 320 <screen format="linespecific"> 321 <prompt>&promptidl;</prompt> <userinput><command>tst_basic</command></userinput> <ulink url="./figpng/tst_basic.png">&showfig;</ulink> 322 322 </screen> 323 323 </para> … … 331 331 <command>tvplus</command> is a enhanced version of tvscl and allow you to have a quick look and perform basic exploration of 2D arrays. 332 332 <screen format="linespecific"> 333 <prompt>&promptidl;</prompt> <userinput><command>tvplus, dist(20)</command></userinput> <ulink url=" figpng/tvplus.png?format=raw">&showfig;</ulink>333 <prompt>&promptidl;</prompt> <userinput><command>tvplus, dist(20)</command></userinput> <ulink url="./figpng/tvplus.png">&showfig;</ulink> 334 334 <computeroutput>left button : mouse position and associated array value</computeroutput> 335 335 <computeroutput>middle button: use it twice to define a zoom box</computeroutput> … … 362 362 <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. 363 363 <screen format="linespecific"> 364 <prompt>&promptidl;</prompt> <userinput><command>pltv, dist(20)</command></userinput> <ulink url=" figpng/pltv.png?format=raw">&showfig;</ulink>364 <prompt>&promptidl;</prompt> <userinput><command>pltv, dist(20)</command></userinput> <ulink url="./figpng/pltv.png">&showfig;</ulink> 365 365 </screen> 366 366 </para> … … 406 406 <computeroutput>% Compiled module: DEFINETRI.</computeroutput> 407 407 </screen> 408 This <ulink url="../../Tests/tst_initlev.pro?format=raw"><command>@tst_initlev</command></ulink> command allows us to define:408 This <ulink type="text" url="../../Tests/tst_initlev.pro"><command>@tst_initlev</command></ulink> command allows us to define: 409 409 <itemizedlist> 410 410 <listitem><simpara>domain dimensions, stored in <varname>jpi, jpj and jpk</varname></simpara></listitem> … … 448 448 We provide other initialization methods/examples 449 449 <itemizedlist> 450 <listitem><simpara><ulink url="../../Tests/tst_initorca2_short.pro?format=raw">@tst_initorca2_short</ulink> : ORCA2 example</simpara></listitem>451 <listitem><simpara><ulink url="../../Tests/tst_initorca05_short.pro?format=raw">@tst_initorca05_short</ulink> : ORCA05 example</simpara></listitem>452 <listitem><simpara><ulink url="../../Tests/tst_initlev_stride.pro?format=raw">@tst_initlev_stride</ulink> : same as @tst_initlev but we skip on point over 2 in x and y direction</simpara></listitem>453 <listitem><simpara><ulink url="../../Tests/tst_initorca2_short_stride.pro?format=raw">@tst_initorca2_short_stride</ulink> : ORCA2 with stride</simpara></listitem>454 <listitem><simpara><ulink url="../../Tests/tst_initorca05_short_stride.pro?format=raw">@tst_initorca05_short_stride</ulink> : ORCA05 with stride</simpara></listitem>455 <listitem><simpara><ulink url="../../Tests/tst_initlev_index.pro?format=raw">@tst_initlev_index</ulink> : in that case we load the grid using points index as axis instead of the longitude/latitude position</simpara></listitem>456 <listitem><simpara><ulink url="../../Tests/tst_initorca2_index.pro?format=raw">@tst_initorca2_index</ulink> : load ORCA2 as it see by the model</simpara></listitem>457 <listitem><simpara><ulink url="../../Tests/tst_initorca05_index.pro?format=raw">@tst_initorca05_index</ulink> : load ORCA05 as it see by the model</simpara></listitem>458 <listitem><simpara><ulink url="../../Tests/tst_initlev_index_stride.pro?format=raw">@tst_initlev_index_stride</ulink> : @tst_initlev_index with stride</simpara></listitem>459 <listitem><simpara><ulink url="../../Tests/tst_initorca2_index_stride.pro?format=raw">@tst_initorca2_index_stride</ulink> : ORCA2 in index with stride</simpara></listitem>460 <listitem><simpara><ulink url="../../Tests/tst_initorca05_index_stride.pro?format=raw">@tst_initorca05_index_stride</ulink> : ORCA05 in index with stride</simpara></listitem>450 <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca2_short.pro">@tst_initorca2_short</ulink> : ORCA2 example</simpara></listitem> 451 <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca05_short.pro">@tst_initorca05_short</ulink> : ORCA05 example</simpara></listitem> 452 <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> 453 <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca2_short_stride.pro">@tst_initorca2_short_stride</ulink> : ORCA2 with stride</simpara></listitem> 454 <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca05_short_stride.pro">@tst_initorca05_short_stride</ulink> : ORCA05 with stride</simpara></listitem> 455 <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> 456 <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> 457 <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> 458 <listitem><simpara><ulink type="text" url="../../Tests/tst_initlev_index_stride.pro">@tst_initlev_index_stride</ulink> : @tst_initlev_index with stride</simpara></listitem> 459 <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca2_index_stride.pro">@tst_initorca2_index_stride</ulink> : ORCA2 in index with stride</simpara></listitem> 460 <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca05_index_stride.pro">@tst_initorca05_index_stride</ulink> : ORCA05 in index with stride</simpara></listitem> 461 461 </itemizedlist> 462 462 </para> … … 469 469 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. 470 470 <itemizedlist> 471 <listitem><simpara><ulink url="../../Tests/tst_initorca2.pro?format=raw">@tst_initorca2</ulink> : ORCA2</simpara></listitem>472 <listitem><simpara><ulink url="../../Tests/tst_initorca05.pro?format=raw">@tst_initorca05</ulink> : ORCA05</simpara></listitem>473 <listitem><simpara><ulink url="../../Tests/tst_initorca2_stride.pro?format=raw">@tst_initorca2_stride</ulink> : ORCA2 with stride</simpara></listitem>474 <listitem><simpara><ulink url="../../Tests/tst_initorca05_stride.pro?format=raw">@tst_initorca05_stride</ulink> : ORCA05 with stride</simpara></listitem>475 <listitem><simpara><ulink url="../../Tests/tst_initorca2_index.pro?format=raw">@tst_initorca2_index</ulink> : load ORCA2 as it see by the model</simpara></listitem>476 <listitem><simpara><ulink url="../../Tests/tst_initorca05_index.pro?format=raw">@tst_initorca05_index</ulink> : load ORCA05 as it see by the model</simpara></listitem>477 <listitem><simpara><ulink url="../../Tests/tst_initorca2_index_stride.pro?format=raw">@tst_initorca2_index_stride</ulink> : ORCA2 in index with stride</simpara></listitem>478 <listitem><simpara><ulink url="../../Tests/tst_initorca05_index_stride.pro?format=raw">@tst_initorca05_index_stride</ulink> : ORCA05 in index with stride</simpara></listitem>471 <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca2.pro">@tst_initorca2</ulink> : ORCA2</simpara></listitem> 472 <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca05.pro">@tst_initorca05</ulink> : ORCA05</simpara></listitem> 473 <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca2_stride.pro">@tst_initorca2_stride</ulink> : ORCA2 with stride</simpara></listitem> 474 <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca05_stride.pro">@tst_initorca05_stride</ulink> : ORCA05 with stride</simpara></listitem> 475 <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> 476 <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> 477 <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca2_index_stride.pro">@tst_initorca2_index_stride</ulink> : ORCA2 in index with stride</simpara></listitem> 478 <listitem><simpara><ulink type="text" url="../../Tests/tst_initorca05_index_stride.pro">@tst_initorca05_index_stride</ulink> : ORCA05 in index with stride</simpara></listitem> 479 479 </itemizedlist> 480 480 </para> … … 487 487 </title> 488 488 <para> 489 A quick presentation of horizontal plots and maps is shown in <ulink url="../../Tests/tst_plt.pro?format=raw">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 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: 490 490 <screen format="linespecific"> 491 491 <prompt>&promptidl;</prompt> <userinput><command>tst_plt</command></userinput> … … 511 511 </title> 512 512 <para> 513 A quick presentation of vertical sections is shown in <ulink url="../../Tests/tst_pltz.pro?format=raw">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 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: 514 514 <screen format="linespecific"> 515 515 <prompt>&promptidl;</prompt> <userinput><command>tst_pltz</command></userinput> … … 535 535 </title> 536 536 <para> 537 A quick presentation of hovmoellers and time series is shown in <ulink url="../../Tests/tst_pltt.pro?format=raw">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 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: 538 538 <screen format="linespecific"> 539 539 <prompt>&promptidl;</prompt> <userinput><command>tst_pltt</command></userinput>
Note: See TracChangeset
for help on using the changeset viewer.