Changeset 163 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/read_ncdf.html

Timestamp:

08/29/06 14:59:46 (18 years ago)

Author:

navarro

Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File:

• trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/read_ncdf.html (modified) (13 diffs)

trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/read_ncdf.html

@@ -701 +701 @@
       <div id="file_comments">
  Reading function for the file net_cdf.
- This program is less universal than ncdf_lec (it appeal to declarated 
+ This program is less universal than ncdf_lec (it appeal to declared 
  variables in common.pro) but it is very easier to be used. It considerate
  the declaration of the different zooms which have been defined
  (ixminmesh...premierx...), the declaration of the variable key_shift...
  To put it in a nutshell, the result of read_ncdf can be directly used in plt...
- This is also this program which is used by default inour reading widgets.  
+ This is also this program which is used by default in our reading widgets.  
 </div>
 
@@ -727 +727 @@
         
           <p class="header">
-            <span class="result">result = </span>read_ncdf(<span class="result"><a href="#_read_ncdf_param_name">name</a>, <a href="#_read_ncdf_param_beginning">beginning</a>, <a href="#_read_ncdf_param_ending">ending</a>, <a href="#_read_ncdf_param_compatibility">compatibility</a></span>, <a href="#_read_ncdf_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_read_ncdf_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_read_ncdf_keyword_PARENTIN">PARENTIN</a>=<span class="result">PARENTIN</span>, <a href="#_read_ncdf_keyword_TIMESTEP">TIMESTEP</a>=<span class="result">TIMESTEP</span>, <a href="#_read_ncdf_keyword_TIMEVAR">TIMEVAR</a>=<span class="result">TIMEVAR</span>, <a href="#_read_ncdf_keyword_TOUT">TOUT</a>=<span class="result">TOUT</span>, <a href="#_read_ncdf_keyword_NOSTRUCT">NOSTRUCT</a>=<span class="result">NOSTRUCT</span>, <a href="#_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL</a>=<span class="result">CONT_NOFILL</span>, <a href="#_read_ncdf_keyword_INIT">INIT</a>=<span class="result">INIT</span>, <a href="#_read_ncdf_keyword_GRID">GRID</a>=<span class="result">GRID</span>, <a href="#_read_ncdf_keyword_FBASE2TBASE">FBASE2TBASE</a>=<span class="result">FBASE2TBASE</span>, <a href="#_read_ncdf_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
+            <span class="result">result = </span>read_ncdf(<span class="result"><a href="#_read_ncdf_param_name">name</a>, <a href="#_read_ncdf_param_beginning">beginning</a>, <a href="#_read_ncdf_param_ending">ending</a>, <a href="#_read_ncdf_param_compatibility">compatibility</a></span>, <a href="#_read_ncdf_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_read_ncdf_keyword_FILENAME">FILENAME</a>=<span class="result">string</span>, <a href="#_read_ncdf_keyword_PARENTIN">PARENTIN</a>=<span class="result">PARENTIN</span>, <a href="#_read_ncdf_keyword_TIMESTEP">TIMESTEP</a>=<span class="result">TIMESTEP</span>, <a href="#_read_ncdf_keyword_TIMEVAR">TIMEVAR</a>=<span class="result">string</span>, <a href="#_read_ncdf_keyword_TOUT">TOUT</a>=<span class="result">TOUT</span>, <a href="#_read_ncdf_keyword_NOSTRUCT">NOSTRUCT</a>=<span class="result">NOSTRUCT</span>, <a href="#_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL</a>=<span class="result">CONT_NOFILL</span>, <a href="#_read_ncdf_keyword_INIT">INIT</a>=<span class="result">INIT</span>, <a href="#_read_ncdf_keyword_GRID">GRID</a>=<span class="result">GRID</span>, <a href="#_read_ncdf_keyword_FBASE2TBASE">FBASE2TBASE</a>=<span class="result">FBASE2TBASE</span>, <a href="#_read_ncdf_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
         
           <div class="comments"></div>
 
           <h3>Return value</h3><div class="preformat">
- Structure readable by litchamp.pro or an array if NOSRUCT is activated.
+ Structure readable by litchamp.pro or an array if NOSTRUCT is activated.
  </div>
 
@@ -745 +745 @@
               <span class="attr">required</span>
               
-              
+              <span class="attr">type:</span> <span class="value">string</span>
               
               
@@ -751 +751 @@
         
           <div class="comments">
- It is a string defining the field to be read.
+ It define the field to be read.
 </div>
             
@@ -771 +771 @@
   which are included between these two dates.
   - 2 indexes which define between which and which time step we have 
-  to extract the telporal dimension.
+  to extract the temporal dimension.
 </div>
             
@@ -833 +833 @@
               
               
-              
+              <span class="attr">type:</span> <span class="value">string</span>
               
               
@@ -839 +839 @@
         
             <div class="comments">
- It is a string containing the file's name.
+ It contains he file's name.
  </div>
             
@@ -877 +877 @@
               
               
-              
+              <span class="attr">type:</span> <span class="value">string</span>
               
               
@@ -883 +883 @@
         
             <div class="comments">
- It is a string which define the name of the variable that
- contains the time axis. This keyword can be usefull if there
- is no unlimited dimension or if the time axis selected by defaut
+ It define the name of the variable that
+ contains the time axis. This keyword can be useful if there
+ is no unlimited dimension or if the time axis selected by default
  (the first 1D array with unlimited dimension) is not the good one.
 </div>
@@ -919 +919 @@
             <div class="comments">
  We activate it if we do not want that read_ncdf send back a structure 
- but only the array refering to the field.
+ but only the array referring to the field.
  </div>
             
@@ -963 +963 @@
         
             <div class="comments">
- ='[UTVWF]' to specify the type of grid. Defaut is (1)
+ ='[UTVWF]' to specify the type of grid. Default is (1)
  based on the name of the file if the file ends by
  GRID[._][TUVFW].NC (not case sensible) or (2) T if case (1)
@@ -1003 +1003 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: read_ncdf.pro 150 2006-08-09 10:12:54Z navarro $ </div>
+ $Id: read_ncdf.pro 157 2006-08-21 09:01:50Z navarro $ </div>
           <h4>History</h4><div class="preformat">
  Sebastien Masson (smasson@lodyc.jussieu.fr)
@@ -1028 +1028 @@
           
         
+          <h3>Statistics</h3>
+          <table class="statistics">
+            <tr><td>McCabe cyclic</td><td>         116</td></tr>
+            <tr><td>McCabe essential</td><td>           1</td></tr>
+            <tr><td>McCabe modular design</td><td>           1</td></tr>
+          </table>