Ignore:
Timestamp:
06/09/06 17:18:59 (18 years ago)
Author:
pinsard
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/Obsolete/nlecan.html

    r89 r97  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> lit les moyennes annuelles 
     90 sur maia: /u/rech/eee/reee217/TOTEM/REF/OUTPUTS  
     91</div> 
    9092 
    9193       
     
    102104        <div class="routine_details" id="_nlecan"> 
    103105 
    104           <h2><a class="top" href="#container">top</a>nlecan </h2> 
     106          <h2><a class="top" href="#container">top</a>nlecan <span class="warning">obsolete</span> <span class="categories"> lecture de NETCDF 
     107</span></h2> 
    105108         
    106109          <p class="header"> 
    107110            <span class="result">result = </span>nlecan(<span class="result"><a href="#_nlecan_param_nom">nom</a>, <a href="#_nlecan_param_numsortie79">numsortie79</a>, <a href="#_nlecan_param_nbretps">nbretps</a></span>, <a href="#_nlecan_keyword_BOITE">BOITE</a>=<span class="result">BOITE</span>, <a href="#_nlecan_keyword_GRILLE">GRILLE</a>=<span class="result">GRILLE</span>, <a href="#_nlecan_keyword_TOUT">TOUT</a>=<span class="result">TOUT</span>, <a href="#_nlecan_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> 
    108111         
    109           <div class="comments"> 
    110  NAME:NLECAN 
    111  
    112  PURPOSE:lit les moyennes annuelles 
    113  sur maia: /u/rech/eee/reee217/TOTEM/REF/OUTPUTS  
    114  
    115  CATEGORY:lecture de NETCDF 
    116  
    117  CALLING SEQUENCE:res=nlecan(nom, numsortie79, nbretps) 
    118  
    119  INPUTS: 
    120        nom:nom du tableau contenant le champ que l'on veut (le 
    121  trouver avec ncdflec,fichier,/var 
    122        numsortie79:le numero du pas de temps que l'on veut sortir du 
    123  fichier (compte a partir de 1) a partir de 79 
    124        nbretps:nombre de pas de temps a extraire 
    125  
    126  KEYWORD PARAMETERS: 
    127  
    128        BOITE: boite sur laquelle integrer (par defaut tt le domaine) 
    129  
    130         GRILLE:impose la grille a laquelle est rapporte le champ. rq permet 
     112          <div class="comments"></div> 
     113 
     114          <h3>Return value</h3><div class="value"> tableau 2d (qd la serie ne fait que 1 pas de temps) ou 
     115 3d (valable ds 1 premier tps que pour les tableaux 2d) 
     116 </div> 
     117 
     118           
     119            <h3>Parameters</h3> 
     120         
     121             
     122            <h4 id="_nlecan_param_nom">nom&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     123              <span class="attr">in</span> 
     124               
     125               
     126              <span class="attr">required</span> 
     127               
     128               
     129               
     130               
     131            </h4> 
     132         
     133          <div class="comments"> nom du tableau contenant le champ que l'on veut (le 
     134 trouver avec ncdflec,fichier,/var</div> 
     135             
     136            <h4 id="_nlecan_param_numsortie79">numsortie79&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     137              <span class="attr">in</span> 
     138               
     139               
     140              <span class="attr">required</span> 
     141               
     142               
     143               
     144               
     145            </h4> 
     146         
     147          <div class="comments"> le numero du pas de temps que l'on veut sortir du 
     148 fichier (compte a partir de 1) a partir de 79</div> 
     149             
     150            <h4 id="_nlecan_param_nbretps">nbretps&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     151              <span class="attr">in</span> 
     152               
     153               
     154              <span class="attr">required</span> 
     155               
     156               
     157               
     158               
     159            </h4> 
     160         
     161          <div class="comments"> nombre de pas de temps a extraire 
     162</div> 
     163             
     164 
     165           
     166 
     167           
     168 
     169            <h3>Keywords</h3> 
     170             
     171            <h4 id="_nlecan_keyword_BOITE">BOITE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     172               
     173               
     174               
     175               
     176               
     177               
     178               
     179               
     180            </h4> 
     181         
     182            <div class="comments">  boite sur laquelle integrer (par defaut tt le domaine) 
     183</div> 
     184             
     185            <h4 id="_nlecan_keyword_GRILLE">GRILLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     186               
     187               
     188               
     189               
     190               
     191               
     192               
     193               
     194            </h4> 
     195         
     196            <div class="comments"> impose la grille a laquelle est rapporte le champ. rq permet 
    131197 d'aller plus vite ds la lecture  
    132  
    133         /TOUT:oblige a lire le tableau entier en non pas celui reduit a domdef 
    134  
    135  OUTPUTS: res=tableau 2d (qd la serie ne fait que 1 pas de temps) ou 
    136  3d (valable ds 1 premier tps que pour les tableaux 2d) 
    137   
    138  COMMON BLOCKS: 
    139         common.pro 
    140  
    141  SIDE EFFECTS:appele par nlec 
    142  
    143  RESTRICTIONS: 
    144  
    145  EXAMPLE: 
    146 </div> 
    147  
    148            
    149  
    150            
    151             <h3>Parameters</h3> 
    152          
    153              
    154             <h4 id="_nlecan_param_nom">nom&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    155                
    156                
    157                
    158                
    159                
    160                
    161                
    162                
    163             </h4> 
    164          
    165           <div class="comments"></div> 
    166              
    167             <h4 id="_nlecan_param_numsortie79">numsortie79&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="_nlecan_param_nbretps">nbretps&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  
    194            
    195  
    196            
    197  
    198             <h3>Keywords</h3> 
    199              
    200             <h4 id="_nlecan_keyword_BOITE">BOITE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     198</div> 
     199             
     200            <h4 id="_nlecan_keyword_TOUT">TOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     201               
     202               
     203               
     204               
     205               
     206               
     207               
     208               
     209            </h4> 
     210         
     211            <div class="comments"> oblige a lire le tableau entier en non pas celui reduit a domdef 
     212</div> 
     213             
     214            <h4 id="_nlecan_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    201215               
    202216               
     
    211225            <div class="comments"></div> 
    212226             
    213             <h4 id="_nlecan_keyword_GRILLE">GRILLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    214                
    215                
    216                
    217                
    218                
    219                
    220                
    221                
    222             </h4> 
    223          
    224             <div class="comments"></div> 
    225              
    226             <h4 id="_nlecan_keyword_TOUT">TOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    227                
    228                
    229                
    230                
    231                
    232                
    233                
    234                
    235             </h4> 
    236          
    237             <div class="comments"></div> 
    238              
    239             <h4 id="_nlecan_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    240                
    241                
    242                
    243                
    244                
    245                
    246                
    247                
    248             </h4> 
    249          
    250             <div class="comments"></div> 
    251              
    252            
    253  
    254            
    255            
    256            
    257            
    258            
    259            
    260            
    261            
    262            
    263            
    264            
    265            
    266          
    267            
    268            
    269            
    270            
     227           
     228 
     229          <h3>Examples</h3><div class="value">  
     230 IDL> res=nlecan(nom, numsortie79, nbretps) 
     231</div> 
     232          <h3>Version history</h3> 
     233           
     234           
     235          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     236</div> 
     237           
     238           
     239          <h3>Known issues</h3> 
     240          <h4>Obsolete</h4><div class="value"></div> 
     241           
     242           
     243          <h4>Restrictions</h4><div class="value"> appele par nlec 
     244</div> 
     245         
     246          <h3>Other attributes</h3> 
     247           
     248           
     249          <h4>Uses routines</h4><div class="value"> common.pro 
     250</div> 
    271251           
    272252           
Note: See TracChangeset for help on using the changeset viewer.