Ignore:
Timestamp:
06/12/06 14:12:53 (18 years ago)
Author:
pinsard
Message:

start to modify headers of Grid .pro files for better idldoc output

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/Grid/micromeshmask.html

    r89 r103  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> reduce the size of the NetCDF meshmask created by OPA by 
     90 using bit (and not byte) format for the masks and the foat format 
     91 for the other fields.  
     92</div> 
    9093 
    9194       
     
    102105           
    103106          <dt><p><a href="#_ncdf_transfer">ncdf_transfer<span class="result">, inid, outid, inname, outname</span></a></p><dt> 
    104           <dd>  NAME: micromeshmask.</dd>        
     107          <dd> </dd>     
    105108           
    106109          <dt><p><a href="#_micromeshmask">micromeshmask<span class="result">, ncfilein, ncfileout</span>, IODIR=<span class="result">IODIR</span></a></p><dt> 
     
    116119        <div class="routine_details" id="_ncdf_transfer"> 
    117120 
    118           <h2><a class="top" href="#container">top</a>ncdf_transfer </h2> 
     121          <h2><a class="top" href="#container">top</a>ncdf_transfer <span class="categories"> for OPA meshmask files 
     122</span></h2> 
    119123         
    120124          <p class="header"> 
     
    122126         
    123127          <div class="comments"> 
    124  NAME: micromeshmask.pro 
    125  
    126  PURPOSE: reduce the size of the NetCDF meshmask created by OPA by 
    127  using bit (and not byte) format for the masks and the foat format 
    128  for the other fields.  
    129  
    130  CATEGORY:for OPA meshmask files 
    131  
    132  CALLING SEQUENCE: reducencmeshmask, ncfilein[, ncfileout] 
    133  
    134  INPUTS:  
    135       ncfilein: 
     128</div> 
     129 
     130           
     131 
     132           
     133            <h3>Parameters</h3> 
     134         
     135             
     136            <h4 id="_ncdf_transfer_param_inid">inid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     137               
     138               
     139               
     140               
     141               
     142               
     143               
     144               
     145            </h4> 
     146         
     147          <div class="comments"></div> 
     148             
     149            <h4 id="_ncdf_transfer_param_outid">outid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     150               
     151               
     152               
     153               
     154               
     155               
     156               
     157               
     158            </h4> 
     159         
     160          <div class="comments"></div> 
     161             
     162            <h4 id="_ncdf_transfer_param_inname">inname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     163               
     164               
     165               
     166               
     167               
     168               
     169               
     170               
     171            </h4> 
     172         
     173          <div class="comments"></div> 
     174             
     175            <h4 id="_ncdf_transfer_param_outname">outname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     176               
     177               
     178               
     179               
     180               
     181               
     182               
     183               
     184            </h4> 
     185         
     186          <div class="comments"></div> 
     187             
     188 
     189           
     190 
     191           
     192 
     193          <h3>Examples</h3><div class="value">  
     194 IDL> reducencmeshmask, ncfilein[, ncfileout] 
     195 
     196  
     197    IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/' 
     198    IDL> micromeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir 
     199</div> 
     200          <h3>Version history</h3> 
     201           
     202           
     203          <h4>History</h4><div class="value"> 
     204      July 2004 Sebastien Masson (smasson@lodyc.jussieu.fr)</div> 
     205           
     206           
     207           
     208           
     209           
     210           
     211           
     212         
     213           
     214           
     215           
     216           
     217           
     218           
     219           
     220         
     221           
     222         
     223        </div> 
     224         
     225 
     226        <div class="routine_details" id="_micromeshmask"> 
     227 
     228          <h2><a class="top" href="#container">top</a>micromeshmask </h2> 
     229         
     230          <p class="header"> 
     231            micromeshmask<span class="result">, <a href="#_micromeshmask_param_ncfilein">ncfilein</a>, <a href="#_micromeshmask_param_ncfileout">ncfileout</a></span>, <a href="#_micromeshmask_keyword_IODIR">IODIR</a>=<span class="result">IODIR</span></p> 
     232         
     233          <div class="comments"></div> 
     234 
     235           
     236 
     237           
     238            <h3>Parameters</h3> 
     239         
     240             
     241            <h4 id="_micromeshmask_param_ncfilein">ncfilein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     242              <span class="attr">in</span> 
     243               
     244               
     245              <span class="attr">required</span> 
     246               
     247               
     248               
     249               
     250            </h4> 
     251         
     252          <div class="comments"> 
    136253      1) the name of the meshmask file to be reduced. In that case, 
    137254      there is only one meshmask file 
     
    141258      2) the xxx part in the names: xxx.mesh_hgr.nc xxx.mesh_zgr.nc 
    142259      xxx.mask.nc. In that case, the meshmask is split into 3 files. 
    143  
    144       ncfileout: the name of the uniq reduced meshmask file. default 
     260</div> 
     261             
     262            <h4 id="_micromeshmask_param_ncfileout">ncfileout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     263              <span class="attr">in</span> 
     264               
     265               
     266              <span class="attr">required</span> 
     267               
     268               
     269               
     270               
     271            </h4> 
     272         
     273          <div class="comments"> the name of the uniq reduced meshmask file. default 
    145274      definition is micromeshmask.nc 
    146  
    147  KEYWORD PARAMETERSSAT: 
    148  
    149     IODIR:to define the files path. 
    150  
    151  OUTPUTS: no 
    152  
    153  COMMON BLOCKS: no 
    154  
    155  EXAMPLE: 
    156     IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/' 
    157     IDL> micromeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir 
    158  
    159  MODIFICATION HISTORY:</div> 
    160  
    161            
    162  
    163            
    164             <h3>Parameters</h3> 
    165          
    166              
    167             <h4 id="_ncdf_transfer_param_inid">inid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    168                
    169                
    170                
    171                
    172                
    173                
    174                
    175                
    176             </h4> 
    177          
    178           <div class="comments"></div> 
    179              
    180             <h4 id="_ncdf_transfer_param_outid">outid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    181                
    182                
    183                
    184                
    185                
    186                
    187                
    188                
    189             </h4> 
    190          
    191           <div class="comments"></div> 
    192              
    193             <h4 id="_ncdf_transfer_param_inname">inname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    194                
    195                
    196                
    197                
    198                
    199                
    200                
    201                
    202             </h4> 
    203          
    204           <div class="comments"></div> 
    205              
    206             <h4 id="_ncdf_transfer_param_outname">outname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    207                
    208                
    209                
    210                
    211                
    212                
    213                
    214                
    215             </h4> 
    216          
    217           <div class="comments"></div> 
    218              
    219  
    220            
    221  
    222            
    223  
    224            
    225            
    226            
    227            
    228            
    229            
    230            
    231            
    232            
    233            
    234            
    235            
    236          
    237            
    238            
    239            
    240            
    241            
    242            
    243            
    244          
    245            
    246          
    247         </div> 
    248          
    249  
    250         <div class="routine_details" id="_micromeshmask"> 
    251  
    252           <h2><a class="top" href="#container">top</a>micromeshmask </h2> 
    253          
    254           <p class="header"> 
    255             micromeshmask<span class="result">, <a href="#_micromeshmask_param_ncfilein">ncfilein</a>, <a href="#_micromeshmask_param_ncfileout">ncfileout</a></span>, <a href="#_micromeshmask_keyword_IODIR">IODIR</a>=<span class="result">IODIR</span></p> 
    256          
    257           <div class="comments"></div> 
    258  
    259            
    260  
    261            
    262             <h3>Parameters</h3> 
    263          
    264              
    265             <h4 id="_micromeshmask_param_ncfilein">ncfilein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    266                
    267                
    268                
    269                
    270                
    271                
    272                
    273                
    274             </h4> 
    275          
    276           <div class="comments"></div> 
    277              
    278             <h4 id="_micromeshmask_param_ncfileout">ncfileout&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    279                
    280                
    281                
    282                
    283                
    284                
    285                
    286                
    287             </h4> 
    288          
    289           <div class="comments"></div> 
     275</div> 
    290276             
    291277 
     
    307293            </h4> 
    308294         
    309             <div class="comments"></div> 
     295            <div class="comments"> to define the files path.</div> 
    310296             
    311297           
Note: See TracChangeset for help on using the changeset viewer.