Ignore:
Timestamp:
07/23/09 11:18:49 (15 years ago)
Author:
smasson
Message:

update documentation

Location:
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS
Files:
14 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/depth2floatlevel.html

    r338 r402  
    8888 
    8989      <div id="file_comments"> 
    90  Rather comparable to depth2level but here, the calculated level is in float. 
     90 Rather comparable to <a href="../..//ToBeReviewed/CALCULS/depth2level.html">depth2level</a> but here, the calculated level  
     91 is in float. 
    9192 For example, the level 5.4 correspond to a depth equal 
    9293 to gdep[5]+.4*(gdep[6]-gdep[5]) 
    … …  
    164165 
    165166          <h3>Examples</h3><div class="preformat"> 
    166     IDL> a=(jpk-1)/(1.*jpi*jpj)*findgen(jpi,jpj) 
    167     IDL> plt, 1e6*(a-floatlevel2depth(depth2floatlevel(a))),/nocontour 
     167 
     168   IDL> a=(jpk-1)/(1.*jpi*jpj)*findgen(jpi,jpj) 
     169   IDL> plt, 1e6*(a-floatlevel2depth(depth2floatlevel(a))),/nocontour 
    168170 
    169171  ->champ nul a 1e-6 pres 
    … …  
    172174           
    173175          <h4>Version</h4><div class="preformat"> 
    174  $Id: depth2floatlevel.pro 327 2007-12-13 16:22:35Z pinsard $ 
     176 $Id: depth2floatlevel.pro 371 2008-08-07 09:32:02Z pinsard $ 
    175177</div> 
    176178          <h4>History</h4><div class="preformat"> 
    … …  
    192194           
    193195          <h4>Uses routines</h4><div class="preformat"> 
    194  common.pro 
     196 <a href="../..//Obsolete/common.html">common</a> 
    195197</div> 
    196198           

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/depth2level.html

    r338 r402  
    223223           
    224224          <h4>Version</h4><div class="preformat"> 
    225  $Id: depth2level.pro 327 2007-12-13 16:22:35Z pinsard $</div> 
     225 $Id: depth2level.pro 370 2008-08-07 07:59:15Z pinsard $</div> 
    226226          <h4>History</h4><div class="preformat"> 
    227227 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    … …  
    245245           
    246246          <h4>Uses routines</h4><div class="preformat"> 
    247  common.pro 
     247 <a href="../..//Obsolete/common.html">common</a> 
    248248</div> 
    249249           

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/depth2mask.html

    r338 r402  
    166166           
    167167          <h4>Version</h4><div class="preformat"> 
    168  $Id: depth2mask.pro 327 2007-12-13 16:22:35Z pinsard $ 
     168 $Id: depth2mask.pro 370 2008-08-07 07:59:15Z pinsard $ 
    169169</div> 
    170170          <h4>History</h4><div class="preformat"> 
    … …  
    184184           
    185185          <h4>Uses routines</h4><div class="preformat"> 
    186  common.pro 
     186 <a href="../..//Obsolete/common.html">common</a> 
    187187</div> 
    188188           

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/determ2.html

    r338 r402  
    192192 
    193193          <h3>Examples</h3><div class="preformat"> 
    194  IDL> a=findgen(2,2,5) 
    195  IDL> print, determ2(a) 
    196  IDL> FOR i=0,4 DO print, determ(a[*,*,i]) 
     194 
     195   IDL> a=findgen(2,2,5) 
     196   IDL> print, determ2(a) 
     197   IDL> FOR i=0,4 DO print, determ(a[*,*,i]) 
    197198</div> 
    198199          <h3>Version history</h3> 
    199200           
    200201          <h4>Version</h4><div class="preformat"> 
    201  $Id: determ2.pro 325 2007-12-06 10:04:53Z pinsard $ 
     202 $Id: determ2.pro 371 2008-08-07 09:32:02Z pinsard $ 
    202203</div> 
    203204          <h4>History</h4><div class="preformat"> 

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/determ3.html

    r249 r402  
    273273 
    274274          <h3>Examples</h3><div class="preformat"> 
    275  a=findgen(3,3,5) 
    276  print, determ3(a^2) 
    277  FOR i=0,4 DO print, determ((a[*,*,i])^2) ; IDL solution 
     275  
     276   IDL> a=findgen(3,3,5) 
     277   IDL> print, determ3(a^2) 
     278   IDL> FOR i=0,4 DO print, determ((a[*,*,i])^2) 
    278279</div> 
    279280          <h3>Version history</h3> 
    280281           
    281282          <h4>Version</h4><div class="preformat"> 
    282  $Id: determ3.pro 231 2007-03-19 17:15:51Z pinsard $ 
     283 $Id: determ3.pro 371 2008-08-07 09:32:02Z pinsard $ 
    283284</div> 
    284285          <h4>History</h4><div class="preformat"> 

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/directory-overview.html

    r321 r402  
    9090       
    9191        <dt><a href="depth2floatlevel.html">depth2floatlevel.pro</a></dt> 
    92         <dd>  Rather comparable to depth2level but here, the calculated level is in float.</dd> 
     92        <dd>  Rather comparable to <a href="../..//ToBeReviewed/CALCULS/depth2level.html">depth2level</a> but here, the calculated level  is in float.</dd> 
    9393       
    9494        <dt><a href="depth2level.html">depth2level.pro</a></dt> 
    … …  
    117117       
    118118        <dt><a href="level2depth.html">level2depth.pro</a></dt> 
    119         <dd>  Allows to pass from a 2d level array to a 2d depth array corresponding to these levels </dd> 
     119        <dd>  Allows to pass from a 2d level array to a 2d depth array corresponding to   these levels </dd> 
    120120       
    121121        <dt><a href="level2index.html">level2index.pro</a></dt> 

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/floatlevel2depth.html

    r338 r402  
    163163 
    164164          <h3>Examples</h3><div class="preformat"> 
    165     IDL> a=gdept[jpk-1]/(1.*jpi*jpj)*findgen(jpi,jpj) 
    166     IDL> plt, 1e6*(a-floatlevel2depth(depth2floatlevel(a))),/nocontour 
     165   IDL> a=gdept[jpk-1]/(1.*jpi*jpj)*findgen(jpi,jpj) 
     166   IDL> plt, 1e6*(a-floatlevel2depth(depth2floatlevel(a))),/nocontour 
    167167 
    168168  ->null field at 1e-6 pres 
    … …  
    171171           
    172172          <h4>Version</h4><div class="preformat"> 
    173  $Id: floatlevel2depth.pro 327 2007-12-13 16:22:35Z pinsard $ 
     173 $Id: floatlevel2depth.pro 371 2008-08-07 09:32:02Z pinsard $ 
    174174</div> 
    175175          <h4>History</h4><div class="preformat"> 
    … …  
    189189           
    190190          <h4>Uses routines</h4><div class="preformat"> 
    191  common.pro 
     191 <a href="../..//Obsolete/common.html">common</a> 
    192192</div> 
    193193           

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/grossemoyenne.html

    r338 r402  
    115115</div> 
    116116 
    117            
     117          <h3>Return value</h3><div class="preformat"> 
     118 an array 
     119</div> 
    118120 
    119121           
    … …  
    133135         
    134136          <div class="comments"> 
    135  3 or 4d field 
     137 3d or 4d field 
    136138</div> 
    137139             
    … …  
    283285            <div class="comments"> 
    284286 to force to perform first temporal 
    285  mean even if nan is activated (see SPATIALFIRST explanations...) 
     287 mean even if NAN is activated (see SPATIALFIRST explanations...) 
    286288</div> 
    287289             
    … …  
    305307           
    306308          <h4>Version</h4><div class="preformat"> 
    307  $Id: grossemoyenne.pro 327 2007-12-13 16:22:35Z pinsard $ 
     309 $Id: grossemoyenne.pro 378 2008-08-12 12:35:46Z pinsard $ 
    308310</div> 
    309311          <h4>History</h4><div class="preformat"> 
    … …  
    330332           
    331333          <h4>Uses routines</h4><div class="preformat"> 
    332  result:un tableau 
    333  common 
     334 <a href="../..//Obsolete/common.html">common</a> 
    334335 <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> 
    335336</div> 

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/hdyn.html

    r338 r402  
    268268           
    269269          <h4>Version</h4><div class="preformat"> 
    270  $Id: hdyn.pro 327 2007-12-13 16:22:35Z pinsard $ 
     270 $Id: hdyn.pro 370 2008-08-07 07:59:15Z pinsard $ 
    271271</div> 
    272272          <h4>History</h4><div class="preformat"> 
    … …  
    292292           
    293293          <h4>Uses routines</h4><div class="preformat"> 
    294  common.pro 
     294 <a href="../..//Obsolete/common.html">common</a> 
    295295</div> 
    296296           

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/level2depth.html

    r338 r402  
    8888 
    8989      <div id="file_comments"> 
    90  Allows to pass from a 2d level array to a 2d depth array corresponding to these levels 
     90 Allows to pass from a 2d level array to a 2d depth array corresponding to  
     91 these levels 
    9192</div> 
    9293 
    … …  
    134135         
    135136          <div class="comments"> 
    136  2d level array of sill levels (or a structure respecting <a href="../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> criterions) 
     137 2d level array of sill levels (or a structure respecting <a href="../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a>  
     138 criterions) 
    137139</div> 
    138140             
    … …  
    165167           
    166168          <h4>Version</h4><div class="preformat"> 
    167  $Id: level2depth.pro 327 2007-12-13 16:22:35Z pinsard $ 
     169 $Id: level2depth.pro 370 2008-08-07 07:59:15Z pinsard $ 
    168170</div> 
    169171          <h4>History</h4><div class="preformat"> 
    … …  
    184186           
    185187          <h4>Uses routines</h4><div class="preformat"> 
    186  common.pro 
     188 <a href="../..//Obsolete/common.html">common</a> 
    187189</div> 
    188190           

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/level2index.html

    r338 r402  
    9191 has been extract from a level specified by the 2d level array (typically, 
    9292 we want to obtain the salinity along an isopycn we have repered by its level). 
    93  level2index is a function who give, in function of level, a 2d indexes array 
     93 level2index is a function which give, in function of level, a 2d indexes array 
    9494 which will allow to extract the 2d array from the 3d array... 
    9595</div> 
    … …  
    150150           
    151151          <h4>Version</h4><div class="preformat"> 
    152  $Id: level2index.pro 325 2007-12-06 10:04:53Z pinsard $ 
     152 $Id: level2index.pro 367 2008-08-06 09:05:24Z pinsard $ 
    153153</div> 
    154154          <h4>History</h4><div class="preformat"> 

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/level2mask.html

    r338 r402  
    148148           
    149149          <h4>Version</h4><div class="preformat"> 
    150  $Id: level2mask.pro 325 2007-12-06 10:04:53Z pinsard $ 
     150 $Id: level2mask.pro 370 2008-08-07 07:59:15Z pinsard $ 
    151151</div> 
    152152          <h4>History</h4><div class="preformat"> 
    … …  
    169169           
    170170          <h4>Uses routines</h4><div class="preformat"> 
    171  common.pro 
     171 <a href="../..//Obsolete/common.html">common</a> 
    172172</div> 
    173173           

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/moyenne.html

    r338 r402  
    267267           
    268268          <h4>Version</h4><div class="preformat"> 
    269  $Id: moyenne.pro 327 2007-12-13 16:22:35Z pinsard $ 
     269 $Id: moyenne.pro 370 2008-08-07 07:59:15Z pinsard $ 
    270270</div> 
    271271          <h4>History</h4><div class="preformat"> 
    … …  
    292292           
    293293          <h4>Uses routines</h4><div class="preformat"> 
    294  common 
     294 <a href="../..//Obsolete/common.html">common</a> 
    295295 <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> 
    296296</div> 

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/projectondepth.html

    r338 r402  
    173173           
    174174          <h4>Version</h4><div class="preformat"> 
    175  $Id: projectondepth.pro 325 2007-12-06 10:04:53Z pinsard $ 
     175 $Id: projectondepth.pro 370 2008-08-07 07:59:15Z pinsard $ 
    176176</div> 
    177177          <h4>History</h4><div class="preformat"> 
    … …  
    193193           
    194194          <h4>Uses routines</h4><div class="preformat"> 
    195  common.pro 
     195 <a href="../..//Obsolete/common.html">common</a> 
    196196</div> 
    197197           
Note: See TracChangeset for help on using the changeset viewer.