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

Timestamp:

07/23/09 11:18:49 (15 years ago)

Author:

smasson

Message:

update documentation

File:

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

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

@@ -89 +89 @@
       <div id="file_comments">
  Reading function for the file net_cdf.
- 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
+ This program is less universal than <a href="../..//ToBeReviewed/LECTURE/ncdf_lec.html">ncdf_lec</a> (it appeal to 
+ declared variables in <a href="../..//Obsolete/common.html">common</a>) 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...
+ To put it in a nutshell, the result of read_ncdf can be directly used in 
+ <a href="../..//ToBeReviewed/PLOTS/DESSINE/plt.html">plt</a> ...
+
  This is also this program which is used by default in our reading widgets.
 </div>
@@ -121 +124 @@
 
           <h3>Return value</h3><div class="preformat">
- Structure readable by <a href="../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> or an array if NOSTRUCT is activated.</div>
+ Structure readable by <a href="../..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> or an array if NOSTRUCT is 
+ activated.
+</div>
 
           
@@ -156 +161 @@
  Relative with the time axis.
  These can be
-  - 2 date of the  type yyyymmdd and in this case, we select dates
+  - 2 dates of the type yyyymmdd and in this case, we select data
   which are included between these two dates.
-  - 2 indexes which define between which and which time step we have
+  - 2 indexes which define between which and which time steps we have
   to extract the temporal dimension.
 </div>
@@ -255 +260 @@
         
             <div class="comments">
- Specify that BEGINNING and ENDING refer to indexes of the time axis and not to dates
+ Specify that BEGINNING and ENDING refer to indexes of the time axis and not 
+ to dates
 </div>
             
@@ -270 +276 @@
         
             <div class="comments">
- put 1 to apply add_offset ad scale factor on data before looking for
+ put 1 to apply add_offset and scale factor on data before looking for
  missing values
 </div>
@@ -332 +338 @@
         
             <div class="comments">
- To call automatically <a href="../..//ToBeReviewed/INIT/initncdf.html">initncdf</a> with filename as input argument 
- and thus ; redefine all the grid parameters
+ To call automatically <a href="../..//ToBeReviewed/INIT/initncdf.html">initncdf</a> with filename as input argument
+ and thus redefine all the grid parameters
 </div>
             
@@ -366 +372 @@
         
             <div class="comments">
- For ROMS outputs. Use by read_ncdf itself to access auxilliary data (h and zeta).
+ For ROMS outputs. Use by read_ncdf itself to access auxilliary data 
+ (h and zeta).
 </div>
             
@@ -383 +390 @@
  a string used to specify the direction along which we want to make
  spatial and/or temporal mean. It could be: 'x' 'y' 'z' 't' 'xy' 'xz'
- 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt' 'xzt' 'yzt' or 'xyzt' 
+ 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt' 'xzt' 'yzt' or 'xyzt'
 </div>
             
@@ -454 +461 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: read_ncdf.pro 337 2008-03-20 22:04:33Z smasson $
+ $Id: read_ncdf.pro 399 2009-07-02 08:38:54Z smasson $
 </div>
           <h4>History</h4><div class="preformat">
@@ -474 +481 @@
           
           <h4>Uses routines</h4><div class="preformat">
- common.pro
+ <a href="../..//Obsolete/common.html">common</a>
 </div>