Ignore:
Timestamp:
07/21/06 14:47:49 (18 years ago)
Author:
navarro
Message:

english and nicer header (2a)

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/ncdf_lec.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 Give informations on a file net cdf and allows to recuperate  
     700 variables which are write in. 
     701</div> 
    699702 
    700703       
    … …  
    711714        <div class="routine_details" id="_ncdf_lec"> 
    712715 
    713           <h2><a class="top" href="#container">top</a>ncdf_lec </h2> 
     716          <h2><a class="top" href="#container">top</a>ncdf_lec <span class="categories"> 
     717 Reading 
     718</span></h2> 
    714719         
    715720          <p class="header"> 
    … …  
    717722         
    718723          <div class="comments"> 
    719  NAME:ncdflec 
    720  
    721  PURPOSE:donne des infos sur un fichier netcdf et permet de recupere 
    722  les variables qui y sont ecrites  
    723  
    724  CATEGORY:lecture de fichiers netcdf 
    725  
    726  CALLING SEQUENCE: res=ncdflec('nom_de _fichier') 
    727  
    728  INPUTS:nom_de _fichier:nom d'un fichier net cdf situe ds e repertoire 
    729  stipule par iodir 
    730  
    731  KEYWORD PARAMETERS: 
    732  
    733         ATT: 'global' ou au nom d'une variable. permet de voir tous les 
    734  attributs rattaches a une variable. 
    735  
    736         /DIM:donne la liste des dimensions 
    737  
    738         VAR: 
    739        1) /var: donne la liste des variables 
    740        2) var='nom de variable': ds ce cas la fonction retourne la variable 
    741  
    742        IODIR: string contenant le repertoire ou aller chercher le 
    743        fichier a lire. 
    744  
    745        _EXTRA: permet de passer les mots cles definits par IDL pour 
    746        les fonction NETCDF (en particulier OFFSET et COUNT ds ncdf_varget) 
    747  
    748  OUTPUTS:-1 sauf si var='nom de variable' auquel cas la fonction retourne la variable 
    749  
    750  REMARQUE:les noms des variables du programme sont similaires a ceux employes 
    751  ds le manuel IDL 'scientific data formats' 
    752 </div> 
    753  
    754            
     724</div> 
     725 
     726          <h3>Return value</h3><div class="preformat"> 
     727 -1 (exept if var='nom de variable', then the function send back the variable). 
     728</div> 
    755729 
    756730           
    … …  
    759733             
    760734            <h4 id="_ncdf_lec_param_nom">nom&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    761                
    762                
    763                
    764                
     735              <span class="attr">in</span> 
     736               
     737               
     738              <span class="attr">required</span> 
    765739               
    766740               
    … …  
    769743            </h4> 
    770744         
    771           <div class="comments"></div> 
     745          <div class="comments"> 
     746 Name of a file net cdf situated in the directory stipulated by iodir. 
     747</div> 
    772748             
    773749 
    … …  
    789765            </h4> 
    790766         
    791             <div class="comments"></div> 
     767            <div class="comments"> 
     768 'global' or at the name of a variable. Allows to see all attributes  
     769 joined at a variable 
     770</div> 
    792771             
    793772            <h4 id="_ncdf_lec_keyword_DIM">DIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    802781            </h4> 
    803782         
    804             <div class="comments"></div> 
     783            <div class="comments"> 
     784 Give the list of dimensions. 
     785</div> 
    805786             
    806787            <h4 id="_ncdf_lec_keyword_VAR">VAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    815796            </h4> 
    816797         
    817             <div class="comments"></div> 
     798            <div class="comments"> 
     799       1) /var: Gove the list of dimensions. 
     800       2) var='nom de variable': in this case the function send back the variable. 
     801</div> 
    818802             
    819803            <h4 id="_ncdf_lec_keyword_IODIR">IODIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    828812            </h4> 
    829813         
    830             <div class="comments"></div> 
     814            <div class="comments"> 
     815 String containing the directory containing the file to be read 
     816</div> 
    831817             
    832818            <h4 id="_ncdf_lec_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    841827            </h4> 
    842828         
    843             <div class="comments"></div> 
     829            <div class="comments"> 
     830 Allows to pass keywords defined by IDL to functions NETCDF ( particularly OFFSET  
     831 and COUNT in ncdf_varget) 
     832</div> 
    844833             
    845834           
    846835 
    847836           
    848            
    849            
    850            
    851            
    852            
    853            
    854            
    855            
    856            
    857            
    858            
     837          <h3>Version history</h3> 
     838           
     839          <h4>Version</h4><div class="preformat"> 
     840 $Id$ 
     841</div> 
     842          <h4>History</h4><div class="preformat"></div> 
     843           
     844           
     845          <h3>Known issues</h3> 
     846           
     847           
     848           
     849          <h4>Restrictions</h4><div class="preformat"> 
     850 Variables's names of the program are similar to these used by the IDL manual  
     851 'scientific data formats' 
     852</div> 
    859853         
    860854           
Note: See TracChangeset for help on using the changeset viewer.