Ignore:
Timestamp:
04/06/07 10:35:17 (17 years ago)
Author:
pinsard
Message:

improvements/corrections of some *.pro headers + replace some message by some report

Location:
trunk/SRC/Documentation/idldoc_html_output/Grid
Files:
17 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/Grid/changemsk.html

    r234 r242  
    115115 
    116116          <h3>Return value</h3><div class="preformat"> 
    117  newmsk the new 2D land-sea mask 
     117 the new 2D land-sea mask 
    118118</div> 
    119119 
    … …  
    170170           
    171171          <h4>Version</h4><div class="preformat"> 
    172  $Id: changemsk.pro 232 2007-03-20 16:59:36Z pinsard $ 
     172 $Id: changemsk.pro 238 2007-03-27 13:43:18Z pinsard $ 
    173173</div> 
    174174          <h4>History</h4><div class="preformat"> 

  • trunk/SRC/Documentation/idldoc_html_output/Grid/checkperio.html

    r234 r242  
    182182           
    183183          <h4>Version</h4><div class="preformat"> 
    184  $Id: checkperio.pro 232 2007-03-20 16:59:36Z pinsard $</div> 
     184 $Id: checkperio.pro 238 2007-03-27 13:43:18Z pinsard $</div> 
    185185          <h4>History</h4><div class="preformat"> 
    186186 October 2006: Sebastien Masson (smasson@locean-ipsl.upmc.fr) 

  • trunk/SRC/Documentation/idldoc_html_output/Grid/computegrid.html

    r234 r242  
    296296       Specify latitudes in this case starty, stepy and ny are not used but 
    297297       starty and stepy could be necessary if the x axis is not defined with 
    298        xaxis. It must be sorted in the increasing or deceasing order (along each column if 2d array). 
     298       xaxis. It must be sorted in the increasing or decreasing order (along each column if 2d array). 
    299299</div> 
    300300             
    … …  
    311311         
    312312            <div class="comments"> 
    313        Specify the vertical axis. Must be sorted in the increasing or deceasing order 
     313       Specify the vertical axis. Must be sorted in the increasing or decreasing order 
    314314</div> 
    315315             
    … …  
    650650            <div class="comments"> 
    651651       a string containing the calling command used to 
    652        call computegrid (this is used by <a href=".//../../ToBeReviewed/WIDGET/xxx.html">xxx</a>) 
     652       call computegrid (this is used by <a href="..//ToBeReviewed/WIDGET/xxx.html">xxx</a>) 
    653653 
    654654 
    … …  
    691691         
    692692            <div class="comments"> 
    693     (not used in the present case...) 
     693 not used in the present case ... 
    694694</div> 
    695695             
    … …  
    700700           
    701701          <h4>Version</h4><div class="preformat"> 
    702  $Id: computegrid.pro 232 2007-03-20 16:59:36Z pinsard $ 
     702 $Id: computegrid.pro 240 2007-03-28 12:17:24Z pinsard $ 
    703703</div> 
    704704          <h4>History</h4><div class="preformat"> 
    … …  
    714714           
    715715           
    716           <h4>Restrictions</h4><div class="preformat"> if the grid has x/y periodicity overlap and/or if 
    717     the mask has 0 everywhere at the border (like a close sea) and 
     716          <h4>Restrictions</h4><div class="preformat"> 
     717 if the grid has x/y periodicity overlap and/or if 
     718    the mask has 0 everywhere at the border (like a closed sea) and 
    718719    if (we did not activate /plain and xminmesh, xmaxmesh, yminmesh, 
    719720    ymaxmesh keywords are defined to their default values), we redefine 
    720721    xminmesh, xmaxmesh, yminmesh, ymaxmesh in order to reove the 
    721     overlapping part and/or to open the domain (avoid ti be forced 
     722    overlapping part and/or to open the domain (avoid it be forced 
    722723    to use cell_fill = 1). 
    723724 
    … …  
    728729           
    729730           
    730           <h4>Uses routines</h4><div class="preformat"> cm_4mesh cm_4data cm_4cal 
     731          <h4>Uses routines</h4><div class="preformat"> 
     732 cm_4mesh 
     733 cm_4data 
     734 cm_4cal 
    731735</div> 
    732736           

  • trunk/SRC/Documentation/idldoc_html_output/Grid/directory-overview.html

    r234 r242  
    114114       
    115115        <dt><a href="n80gaussian.html">n80gaussian.pro</a></dt> 
    116         <dd>   compute the latitudes of the n80 gaussian grid.</dd> 
     116        <dd>  compute the latitudes of the n80 gaussian grid.</dd> 
    117117       
    118118        <dt><a href="ncdf_meshread.html">ncdf_meshread.pro</a></dt> 
    … …  
    132132       
    133133        <dt><a href="saveboxparam.html">saveboxparam.pro</a></dt> 
    134         <dd>  save all the zoom parameters (defined by calling <a href=".//../../ToBeReviewed/GRILLE/domdef.html">domdef</a>)  in a file (using save command) located in myuniquetmpdir  (common variable defined by def_myuniquetmpdir) </dd> 
     134        <dd>  save all the zoom parameters (defined by calling <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a>)  in a file (using save command) located in myuniquetmpdir  (common variable defined by def_myuniquetmpdir) </dd> 
    135135       
    136136        <dt><a href="smallmeshmask.html">smallmeshmask.pro</a></dt> 

  • trunk/SRC/Documentation/idldoc_html_output/Grid/micromeshmask.html

    r234 r242  
    147147            </h4> 
    148148         
    149           <div class="comments"></div> 
     149          <div class="comments"> 
     150</div> 
    150151             
    151152            <h4 id="_ncdf_transfer_param_outid">outid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    160161            </h4> 
    161162         
    162           <div class="comments"></div> 
     163          <div class="comments"> 
     164</div> 
    163165             
    164166            <h4 id="_ncdf_transfer_param_inname">inname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    173175            </h4> 
    174176         
    175           <div class="comments"></div> 
     177          <div class="comments"> 
     178</div> 
    176179             
    177180            <h4 id="_ncdf_transfer_param_outname">outname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    198201           
    199202          <h4>Version</h4><div class="preformat"> 
    200  $Id: micromeshmask.pro 231 2007-03-19 17:15:51Z pinsard $ 
     203 $Id: micromeshmask.pro 240 2007-03-28 12:17:24Z pinsard $ 
    201204</div> 
    202205          <h4>History</h4><div class="preformat"> 
    … …  
    274277               
    275278               
    276                
    277                
    278             </h4> 
    279          
    280           <div class="comments"> the name of the uniq reduced meshmask file. 
    281  default definition is micromeshmask.nc 
     279              <span class="attr">default:</span> <span class="value">'micromeshmask.nc'</span> 
     280               
     281            </h4> 
     282         
     283          <div class="comments"> 
     284 the name of the uniq reduced meshmask file. 
    282285</div> 
    283286             
    … …  
    300303            </h4> 
    301304         
    302             <div class="comments"> to define the files path. 
     305            <div class="comments"> 
     306 to define the files path. 
    303307</div> 
    304308             

  • trunk/SRC/Documentation/idldoc_html_output/Grid/n128gaussian.html

    r234 r242  
    115115</div> 
    116116 
    117           <h3>Return value</h3><div class="preformat"> a 1d array 
     117          <h3>Return value</h3><div class="preformat"> 
     118 a 1d array 
    118119</div> 
    119120 
    … …  
    128129           
    129130          <h4>Version</h4><div class="preformat"> 
    130  $Id: n128gaussian.pro 231 2007-03-19 17:15:51Z pinsard $ 
     131 $Id: n128gaussian.pro 238 2007-03-27 13:43:18Z pinsard $ 
    131132</div> 
    132133          <h4>History</h4><div class="preformat"> 

  • trunk/SRC/Documentation/idldoc_html_output/Grid/n160gaussian.html

    r234 r242  
    115115</div> 
    116116 
    117           <h3>Return value</h3><div class="preformat"> a 1d array 
     117          <h3>Return value</h3><div class="preformat"> 
     118 a 1d array 
    118119</div> 
    119120 
    … …  
    123124 
    124125          <h3>Examples</h3><div class="preformat"> 
    125  IDL>lat=n160gaussian() 
     126 IDL> lat=n160gaussian() 
    126127</div> 
    127128          <h3>Version history</h3> 
    128129           
    129130          <h4>Version</h4><div class="preformat"> 
    130  $Id: n160gaussian.pro 231 2007-03-19 17:15:51Z pinsard $ 
     131 $Id: n160gaussian.pro 238 2007-03-27 13:43:18Z pinsard $ 
    131132</div> 
    132133          <h4>History</h4><div class="preformat"> 

  • trunk/SRC/Documentation/idldoc_html_output/Grid/n256gaussian.html

    r234 r242  
    115115</div> 
    116116 
    117           <h3>Return value</h3><div class="preformat"> a 1d array 
     117          <h3>Return value</h3><div class="preformat"> 
     118 a 1d array 
    118119</div> 
    119120 
    … …  
    128129           
    129130          <h4>Version</h4><div class="preformat"> 
    130  $Id: n256gaussian.pro 231 2007-03-19 17:15:51Z pinsard $ 
     131 $Id: n256gaussian.pro 238 2007-03-27 13:43:18Z pinsard $ 
    131132</div> 
    132133          <h4>History</h4><div class="preformat"> 

  • trunk/SRC/Documentation/idldoc_html_output/Grid/n48gaussian.html

    r234 r242  
    115115</div> 
    116116 
    117           <h3>Return value</h3><div class="preformat"> a 1d array 
     117          <h3>Return value</h3><div class="preformat"> 
     118 a 1d array 
    118119</div> 
    119120 
    … …  
    128129           
    129130          <h4>Version</h4><div class="preformat"> 
    130  $Id: n48gaussian.pro 231 2007-03-19 17:15:51Z pinsard $ 
     131 $Id: n48gaussian.pro 238 2007-03-27 13:43:18Z pinsard $ 
    131132</div> 
    132133          <h4>History</h4><div class="preformat"> 

  • trunk/SRC/Documentation/idldoc_html_output/Grid/n80gaussian.html

    r234 r242  
    8787      </div> 
    8888 
    89       <div id="file_comments">  
     89      <div id="file_comments"> 
    9090 compute the latitudes of the n80 gaussian grid. See: 
    9191 <a href="http://www.ecmwf.int/products/data/technical/gaussian/n80FIS.html">Gaussian 80</a> 
    … …  
    115115</div> 
    116116 
    117           <h3>Return value</h3><div class="preformat"> a 1d array 
     117          <h3>Return value</h3><div class="preformat"> 
     118 a 1d array 
    118119</div> 
    119120 
    … …  
    128129           
    129130          <h4>Version</h4><div class="preformat"> 
    130  $Id: n80gaussian.pro 232 2007-03-20 16:59:36Z pinsard $ 
     131 $Id: n80gaussian.pro 238 2007-03-27 13:43:18Z pinsard $ 
    131132</div> 
    132133          <h4>History</h4><div class="preformat"> 

  • trunk/SRC/Documentation/idldoc_html_output/Grid/ncdf_meshread.html

    r234 r242  
    278278         
    279279            <div class="comments"> 
    280     the calling command used to call computegrid (this is used by <a href=".//../../ToBeReviewed/WIDGET/xxx.html">xxx</a>) 
     280    the calling command used to call computegrid (this is used by <a href="..//ToBeReviewed/WIDGET/xxx.html">xxx</a>) 
    281281</div> 
    282282             
    … …  
    293293         
    294294            <div class="comments"> 
    295  Used to pass keywords to <a href=".//../../Utilities/isafile.html">isafile</a> 
     295 Used to pass keywords to <a href="..//Utilities/isafile.html">isafile</a> 
    296296</div> 
    297297             
    … …  
    304304           
    305305          <h4>Version</h4><div class="preformat"> 
    306  $Id: ncdf_meshread.pro 232 2007-03-20 16:59:36Z pinsard $ 
     306 $Id: ncdf_meshread.pro 240 2007-03-28 12:17:24Z pinsard $ 
    307307</div> 
    308308          <h4>History</h4><div class="preformat"> 

  • trunk/SRC/Documentation/idldoc_html_output/Grid/ncdf_meshroms.html

    r234 r242  
    293293         
    294294            <div class="comments"> 
    295  Used to pass keywords to <a href=".//../../Utilities/isafile.html">isafile</a> 
     295 Used to pass keywords to <a href="..//Utilities/isafile.html">isafile</a> 
    296296</div> 
    297297             
    … …  
    304304           
    305305          <h4>Version</h4><div class="preformat"> 
    306  $Id: ncdf_meshroms.pro 231 2007-03-19 17:15:51Z pinsard $ 
     306 $Id: ncdf_meshroms.pro 240 2007-03-28 12:17:24Z pinsard $ 
    307307</div> 
    308308          <h4>History</h4><div class="preformat"> 

  • trunk/SRC/Documentation/idldoc_html_output/Grid/numbisland.html

    r234 r242  
    9292 
    9393 
    94  given a 2D land-se mask, give a number to each islands 
     94 given a 2D land-sea mask, give a number to each island 
    9595</div> 
    9696 
    … …  
    115115            <span class="result">result = </span>numbisland(<span class="result"><a href="#_numbisland_param_mskin">mskin</a></span>)</p> 
    116116         
    117           <div class="comments"></div> 
     117          <div class="comments"> 
     118</div> 
    118119 
    119120          <h3>Return value</h3><div class="preformat"> 
    … …  
    151152           
    152153          <h4>Version</h4><div class="preformat"> 
    153  $Id: numbisland.pro 231 2007-03-19 17:15:51Z pinsard $</div> 
     154 $Id: numbisland.pro 240 2007-03-28 12:17:24Z pinsard $ 
     155</div> 
    154156          <h4>History</h4><div class="preformat"> 
    155157  Jan 2006: sebastien masson (smasson@locean-ipsl.upmc.fr) 

  • trunk/SRC/Documentation/idldoc_html_output/Grid/restoreboxparam.html

    r234 r242  
    8888 
    8989      <div id="file_comments"> 
    90  restore all the zoom parameters (defined by calling <a href=".//../../ToBeReviewed/GRILLE/domdef.html">domdef</a>) 
     90 restore all the zoom parameters (defined by calling <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a>) 
    9191 previously defined by <a href=".//saveboxparam.html">saveboxparam</a> 
    9292</div> 
    … …  
    125125              <span class="attr">required</span> 
    126126               
    127                
     127              <span class="attr">type:</span> <span class="value"> scalar string</span> 
    128128               
    129129               
    … …  
    131131         
    132132          <div class="comments"> 
    133  a scalar string defining the file name 
     133 the file name 
    134134</div> 
    135135             
    … …  
    145145           
    146146          <h4>Version</h4><div class="preformat"> 
    147  $Id: restoreboxparam.pro 231 2007-03-19 17:15:51Z pinsard $ 
     147 $Id: restoreboxparam.pro 238 2007-03-27 13:43:18Z pinsard $ 
    148148</div> 
    149149          <h4>History</h4><div class="preformat"> 

  • trunk/SRC/Documentation/idldoc_html_output/Grid/romsdepth.html

    r234 r242  
    127127           
    128128          <h4>Version</h4><div class="preformat"> 
    129  $Id: romsdepth.pro 231 2007-03-19 17:15:51Z pinsard $</div> 
     129 $Id: romsdepth.pro 238 2007-03-27 13:43:18Z pinsard $ 
     130</div> 
    130131          <h4>History</h4><div class="preformat"> 
    131132 Sept 2006 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    … …  
    145146           
    146147          <h4>Uses routines</h4><div class="preformat"> 
    147  cm_4mesh cm_4data 
     148 cm_4mesh 
     149 cm_4data 
    148150</div> 
    149151           

  • trunk/SRC/Documentation/idldoc_html_output/Grid/saveboxparam.html

    r234 r242  
    8888 
    8989      <div id="file_comments"> 
    90  save all the zoom parameters (defined by calling <a href=".//../../ToBeReviewed/GRILLE/domdef.html">domdef</a>) 
     90 save all the zoom parameters (defined by calling <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a>) 
    9191 in a file (using save command) located in myuniquetmpdir 
    9292 (common variable defined by def_myuniquetmpdir) 
    … …  
    126126              <span class="attr">required</span> 
    127127               
    128                
     128              <span class="attr">type:</span> <span class="value">scalar string</span> 
    129129               
    130130               
    … …  
    132132         
    133133          <div class="comments"> 
    134  a scalar string defining the file name 
     134 the file name 
    135135</div> 
    136136             
    … …  
    146146           
    147147          <h4>Version</h4><div class="preformat"> 
    148  $Id: saveboxparam.pro 231 2007-03-19 17:15:51Z pinsard $ 
     148 $Id: saveboxparam.pro 238 2007-03-27 13:43:18Z pinsard $ 
    149149</div> 
    150150          <h4>History</h4><div class="preformat"> 

  • trunk/SRC/Documentation/idldoc_html_output/Grid/smallmeshmask.html

    r234 r242  
    109109           
    110110          <dt><p><a href="#_smallmeshmask">smallmeshmask<span class="result">, ncfilein[, ncfileout]</span>, IODIR=<span class="result">IODIR</span></a></p><dt> 
    111           <dd></dd>      
     111          <dd> </dd>     
    112112                 
    113113        </dl> 
    … …  
    147147            </h4> 
    148148         
    149           <div class="comments"></div> 
     149          <div class="comments"> 
     150</div> 
    150151             
    151152            <h4 id="_ncdf_transfer_param_outid">outid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    160161            </h4> 
    161162         
    162           <div class="comments"></div> 
     163          <div class="comments"> 
     164</div> 
    163165             
    164166            <h4 id="_ncdf_transfer_param_inname">inname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    173175            </h4> 
    174176         
    175           <div class="comments"></div> 
     177          <div class="comments"> 
     178</div> 
    176179             
    177180            <h4 id="_ncdf_transfer_param_outname">outname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    198201           
    199202          <h4>Version</h4><div class="preformat"> 
    200  $Id: smallmeshmask.pro 231 2007-03-19 17:15:51Z pinsard $ 
     203 $Id: smallmeshmask.pro 240 2007-03-28 12:17:24Z pinsard $ 
    201204</div> 
    202205          <h4>History</h4><div class="preformat"> 
    … …  
    239242            smallmeshmask<span class="result">, <a href="#_smallmeshmask_param_ncfilein">ncfilein</a>[, <a href="#_smallmeshmask_param_ncfileout">ncfileout</a>]</span>, <a href="#_smallmeshmask_keyword_IODIR">IODIR</a>=<span class="result">IODIR</span></p> 
    240243         
    241           <div class="comments"></div> 
     244          <div class="comments"> 
     245</div> 
    242246 
    243247           
    … …  
    301305            </h4> 
    302306         
    303             <div class="comments"> to define the files path.</div> 
     307            <div class="comments"> 
     308 to define the files path. 
     309</div> 
    304310             
    305311           
    … …  
    312318           
    313319          <h4>Version</h4><div class="preformat"> 
    314  $Id: smallmeshmask.pro 231 2007-03-19 17:15:51Z pinsard $ 
     320 $Id: smallmeshmask.pro 240 2007-03-28 12:17:24Z pinsard $ 
    315321</div> 
    316322          <h4>History</h4><div class="preformat"> 
Note: See TracChangeset for help on using the changeset viewer.