Changeset 80 for trunk/SRC/Documentation/xmldoc/firststeps.xml
- Timestamp:
- 06/01/06 10:42:58 (18 years ago)
- File:
-
- 1 edited
-
trunk/SRC/Documentation/xmldoc/firststeps.xml (modified) (16 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/xmldoc/firststeps.xml
r79 r80 4 4 [ 5 5 <!ENTITY promptidl "idl>"> 6 <!ENTITY numb1 '<inlinemediaobject><imageobject><imagedata fileref="images/callouts/1.png " format="PNG"/></imageobject><textobject><phrase>1</phrase></textobject></inlinemediaobject>'>7 <!ENTITY numb2 '<inlinemediaobject><imageobject><imagedata fileref="images/callouts/2.png " format="PNG"/></imageobject><textobject><phrase>2</phrase></textobject></inlinemediaobject>'>8 <!ENTITY showfig '<inlinemediaobject><imageobject><imagedata fileref="images/showfig.png " format="PNG"/></imageobject><textobject><phrase>show result</phrase></textobject></inlinemediaobject>'>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>'> 9 9 ]> 10 10 … … 131 131 <prompt>&promptidl;</prompt> <userinput><command>n = 10</command></userinput> 132 132 <prompt>&promptidl;</prompt> <userinput><command>y = findgen(n)</command></userinput> &numb1; 133 <prompt>&promptidl;</prompt> <userinput><command>plot, y</command></userinput> <ulink url="figpng/basic_plot.png ">&showfig;</ulink>133 <prompt>&promptidl;</prompt> <userinput><command>plot, y</command></userinput> <ulink url="figpng/basic_plot.png?format=raw">&showfig;</ulink> 134 134 </screen> 135 135 <calloutlist> … … 150 150 Using IDL <command>plot</command> command is quite unconvenient to save the figure as a postscript. In addition, positionning 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 developped <command>splot</command> (like super-plot) which can be used in the same way as plot but is much more convenient to make postcript and position the figure. 151 151 <screen format="linespecific"> 152 <prompt>&promptidl;</prompt> <userinput><command>splot, y</command></userinput> <ulink url="figpng/basic_splot1.png ">&showfig;</ulink>152 <prompt>&promptidl;</prompt> <userinput><command>splot, y</command></userinput> <ulink url="figpng/basic_splot1.png?format=raw">&showfig;</ulink> 153 153 <computeroutput>% Compiled module: SPLOT.</computeroutput> 154 154 <computeroutput>% Compiled module: REINITPLT.</computeroutput> … … 226 226 <para> 227 227 <screen format="linespecific"> 228 <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>228 <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> 229 229 </screen> 230 230 <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> 231 231 <screen format="linespecific"> 232 232 <prompt>&promptidl;</prompt> <userinput><command>splot, y, yrange = [0, (n-1)^2], title = 'x and x^2'</command></userinput> 233 <prompt>&promptidl;</prompt> <userinput><command>oplot, y^2, color = 50, linestyle = 2</command></userinput> <ulink url="figpng/basic_splot4.png ">&showfig;</ulink>233 <prompt>&promptidl;</prompt> <userinput><command>oplot, y^2, color = 50, linestyle = 2</command></userinput> <ulink url="figpng/basic_splot4.png?format=raw">&showfig;</ulink> 234 234 </screen> 235 235 Use the keyword small to produce multi plots figures. … … 245 245 <prompt>&promptidl;</prompt> <userinput><command>splot, y, y^2, title = 'y = x^2', psym = 2, small &numb1; = [1, 2, 1]</command></userinput> 246 246 <prompt>&promptidl;</prompt> <userinput><command>splot, findgen(360)/36., findgen(360)*2.*!dtor, /polar $</command></userinput> 247 <prompt>&promptidl;</prompt> <userinput><command> , small &numb1; = [1, 2, 2], /noerase &numb2;</command></userinput> <ulink url="figpng/basic_splot3.png ">&showfig;</ulink>247 <prompt>&promptidl;</prompt> <userinput><command> , small &numb1; = [1, 2, 2], /noerase &numb2;</command></userinput> <ulink url="figpng/basic_splot3.png?format=raw">&showfig;</ulink> 248 248 </screen> 249 249 <calloutlist> … … 273 273 <prompt>&promptidl;</prompt> <userinput><command>z = dist(n)</command></userinput> 274 274 <computeroutput>% Compiled module: DIST.</computeroutput> 275 <prompt>&promptidl;</prompt> <userinput><command>scontour, z</command></userinput> <ulink url="figpng/basic_scontour1.png ">&showfig;</ulink>275 <prompt>&promptidl;</prompt> <userinput><command>scontour, z</command></userinput> <ulink url="figpng/basic_scontour1.png?format=raw">&showfig;</ulink> 276 276 <computeroutput>% Compiled module: SCONTOUR.</computeroutput> 277 277 <computeroutput>% Compiled module: CHKSTRU.</computeroutput> … … 283 283 <screen format="linespecific"> 284 284 <prompt>&promptidl;</prompt> <userinput><command>scontour, z, /fill, nlevels = 15, subtitle = 'nicer contour' $</command></userinput> 285 <prompt>&promptidl;</prompt> <userinput><command> , xtitle = 'x index', charsize = 1.5</command></userinput> <ulink url="figpng/basic_scontour2.png ">&showfig;</ulink>285 <prompt>&promptidl;</prompt> <userinput><command> , xtitle = 'x index', charsize = 1.5</command></userinput> <ulink url="figpng/basic_scontour2.png?format=raw">&showfig;</ulink> 286 286 </screen> 287 287 It can be used in combinanson with contour to make more complex plots: … … 294 294 <prompt>&promptidl;</prompt> <userinput><command>scontour, z, levels = n*ind, c_orientation = 180*ind, c_spacing = 0.4*ind</command></userinput> 295 295 <prompt>&promptidl;</prompt> <userinput><command>contour, z, /overplot, c_label = rebin([1, 0], 2, n) &numb1;, levels = n*ind $</command></userinput> 296 <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>296 <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> 297 297 </screen> 298 298 <calloutlist> … … 310 310 </calloutlist> 311 311 </screenco> 312 <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 "><filename>tst_basic.pro</filename></ulink>:313 <screen format="linespecific"> 314 <prompt>&promptidl;</prompt> <userinput><command>tst_basic</command></userinput> <ulink url="figpng/tst_basic.png ">&showfig;</ulink>312 <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>: 313 <screen format="linespecific"> 314 <prompt>&promptidl;</prompt> <userinput><command>tst_basic</command></userinput> <ulink url="figpng/tst_basic.png?format=raw">&showfig;</ulink> 315 315 </screen> 316 316 </para> … … 324 324 <command>tvplus</command> is a enhanced version of tvscl and allow you to have a quick look and perform basic exploration of 2D arrays. 325 325 <screen format="linespecific"> 326 <prompt>&promptidl;</prompt> <userinput><command>tvplus, dist(20)</command></userinput> <ulink url="figpng/tvplus.png ">&showfig;</ulink>326 <prompt>&promptidl;</prompt> <userinput><command>tvplus, dist(20)</command></userinput> <ulink url="figpng/tvplus.png?format=raw">&showfig;</ulink> 327 327 <computeroutput>left button : mouse position and associated array value</computeroutput> 328 328 <computeroutput>middle button: use it twice to define a zoom box</computeroutput> … … 377 377 <computeroutput>% Compiled module: DEFINETRI.</computeroutput> 378 378 </screen> 379 This <ulink url="../../Tests/tst_initlev.pro "><command>@tst_initlev</command></ulink> command allows us to define:379 This <ulink url="../../Tests/tst_initlev.pro?format=raw"><command>@tst_initlev</command></ulink> command allows us to define: 380 380 <itemizedlist> 381 381 <listitem><simpara>domain dimensions, stored in <varname>jpi, jpj and jpk</varname></simpara></listitem> … … 419 419 We provide other initialization methods/examples 420 420 <itemizedlist> 421 <listitem><simpara><ulink url="../../Tests/tst_initorca2_short.pro ">@tst_initorca2_short</ulink> : ORCA2 example</simpara></listitem>422 <listitem><simpara><ulink url="../../Tests/tst_initorca05_short.pro ">@tst_initorca05_short</ulink> : ORCA05 example</simpara></listitem>423 <listitem><simpara><ulink 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>424 <listitem><simpara><ulink url="../../Tests/tst_initorca2_short_stride.pro ">@tst_initorca2_short_stride</ulink> : ORCA2 with stride</simpara></listitem>425 <listitem><simpara><ulink url="../../Tests/tst_initorca05_short_stride.pro ">@tst_initorca05_short_stride</ulink> : ORCA05 with stride</simpara></listitem>426 <listitem><simpara><ulink 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>427 <listitem><simpara><ulink url="../../Tests/tst_initorca2_index.pro ">@tst_initorca2_index</ulink> : load ORCA2 as it see by the model</simpara></listitem>428 <listitem><simpara><ulink url="../../Tests/tst_initorca05_index.pro ">@tst_initorca05_index</ulink> : load ORCA05 as it see by the model</simpara></listitem>429 <listitem><simpara><ulink url="../../Tests/tst_initlev_index_stride.pro ">@tst_initlev_index_stride</ulink> : @tst_initlev_index with stride</simpara></listitem>430 <listitem><simpara><ulink url="../../Tests/tst_initorca2_index_stride.pro ">@tst_initorca2_index_stride</ulink> : ORCA2 in index with stride</simpara></listitem>431 <listitem><simpara><ulink url="../../Tests/tst_initorca05_index_stride.pro ">@tst_initorca05_index_stride</ulink> : ORCA05 in index with stride</simpara></listitem>421 <listitem><simpara><ulink url="../../Tests/tst_initorca2_short.pro?format=raw">@tst_initorca2_short</ulink> : ORCA2 example</simpara></listitem> 422 <listitem><simpara><ulink url="../../Tests/tst_initorca05_short.pro?format=raw">@tst_initorca05_short</ulink> : ORCA05 example</simpara></listitem> 423 <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> 424 <listitem><simpara><ulink url="../../Tests/tst_initorca2_short_stride.pro?format=raw">@tst_initorca2_short_stride</ulink> : ORCA2 with stride</simpara></listitem> 425 <listitem><simpara><ulink url="../../Tests/tst_initorca05_short_stride.pro?format=raw">@tst_initorca05_short_stride</ulink> : ORCA05 with stride</simpara></listitem> 426 <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> 427 <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> 428 <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> 429 <listitem><simpara><ulink url="../../Tests/tst_initlev_index_stride.pro?format=raw">@tst_initlev_index_stride</ulink> : @tst_initlev_index with stride</simpara></listitem> 430 <listitem><simpara><ulink url="../../Tests/tst_initorca2_index_stride.pro?format=raw">@tst_initorca2_index_stride</ulink> : ORCA2 in index with stride</simpara></listitem> 431 <listitem><simpara><ulink url="../../Tests/tst_initorca05_index_stride.pro?format=raw">@tst_initorca05_index_stride</ulink> : ORCA05 in index with stride</simpara></listitem> 432 432 </itemizedlist> 433 433 </para> … … 440 440 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. 441 441 <itemizedlist> 442 <listitem><simpara><ulink url="../../Tests/tst_initorca2.pro ">@tst_initorca2</ulink> : ORCA2</simpara></listitem>443 <listitem><simpara><ulink url="../../Tests/tst_initorca05.pro ">@tst_initorca05</ulink> : ORCA05</simpara></listitem>444 <listitem><simpara><ulink url="../../Tests/tst_initorca2_stride.pro ">@tst_initorca2_stride</ulink> : ORCA2 with stride</simpara></listitem>445 <listitem><simpara><ulink url="../../Tests/tst_initorca05_stride.pro ">@tst_initorca05_stride</ulink> : ORCA05 with stride</simpara></listitem>446 <listitem><simpara><ulink url="../../Tests/tst_initorca2_index.pro ">@tst_initorca2_index</ulink> : load ORCA2 as it see by the model</simpara></listitem>447 <listitem><simpara><ulink url="../../Tests/tst_initorca05_index.pro ">@tst_initorca05_index</ulink> : load ORCA05 as it see by the model</simpara></listitem>448 <listitem><simpara><ulink url="../../Tests/tst_initorca2_index_stride.pro ">@tst_initorca2_index_stride</ulink> : ORCA2 in index with stride</simpara></listitem>449 <listitem><simpara><ulink url="../../Tests/tst_initorca05_index_stride.pro ">@tst_initorca05_index_stride</ulink> : ORCA05 in index with stride</simpara></listitem>442 <listitem><simpara><ulink url="../../Tests/tst_initorca2.pro?format=raw">@tst_initorca2</ulink> : ORCA2</simpara></listitem> 443 <listitem><simpara><ulink url="../../Tests/tst_initorca05.pro?format=raw">@tst_initorca05</ulink> : ORCA05</simpara></listitem> 444 <listitem><simpara><ulink url="../../Tests/tst_initorca2_stride.pro?format=raw">@tst_initorca2_stride</ulink> : ORCA2 with stride</simpara></listitem> 445 <listitem><simpara><ulink url="../../Tests/tst_initorca05_stride.pro?format=raw">@tst_initorca05_stride</ulink> : ORCA05 with stride</simpara></listitem> 446 <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> 447 <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> 448 <listitem><simpara><ulink url="../../Tests/tst_initorca2_index_stride.pro?format=raw">@tst_initorca2_index_stride</ulink> : ORCA2 in index with stride</simpara></listitem> 449 <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 450 </itemizedlist> 451 451 </para> … … 458 458 </title> 459 459 <para> 460 A quick presentation of horizontal plots and maps is shown in <ulink url="../../Tests/tst_plt.pro ">tst_plt</ulink>. After laoding any of the grid (for example with one of the <link linkend="load_grid">above examples</link>). Just try:460 A quick presentation of horizontal plots and maps is shown in <ulink url="../../Tests/tst_plt.pro?format=raw">tst_plt</ulink>. After laoding any of the grid (for example with one of the <link linkend="load_grid">above examples</link>). Just try: 461 461 <screen format="linespecific"> 462 462 <prompt>&promptidl;</prompt> <userinput><command>tst_plt</command></userinput> … … 482 482 </title> 483 483 <para> 484 A quick presentation of vertical sections is shown in <ulink url="../../Tests/tst_pltz.pro ">tst_pltz</ulink>. After laoding any of the grid (for example with one of the <link linkend="load_grid">above examples</link>). Just try:484 A quick presentation of vertical sections is shown in <ulink url="../../Tests/tst_pltz.pro?format=raw">tst_pltz</ulink>. After laoding any of the grid (for example with one of the <link linkend="load_grid">above examples</link>). Just try: 485 485 <screen format="linespecific"> 486 486 <prompt>&promptidl;</prompt> <userinput><command>tst_pltz</command></userinput> … … 506 506 </title> 507 507 <para> 508 A quick presentation of hovmoellers and time series is shown in <ulink url="../../Tests/tst_pltt.pro ">tst_pltt</ulink>. After laoding any of the grid (for example with one of the <link linkend="load_grid">above examples</link>). Just try:508 A quick presentation of hovmoellers and time series is shown in <ulink url="../../Tests/tst_pltt.pro?format=raw">tst_pltt</ulink>. After laoding any of the grid (for example with one of the <link linkend="load_grid">above examples</link>). Just try: 509 509 <screen format="linespecific"> 510 510 <prompt>&promptidl;</prompt> <userinput><command>tst_pltt</command></userinput>
Note: See TracChangeset
for help on using the changeset viewer.
