Changeset 338 for trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/read_grads.html

Timestamp:

03/20/08 23:06:02 (16 years ago)

Author:

smasson

Message:

update documentation

File:

• trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/read_grads.html (modified) (6 diffs)

trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/read_grads.html

@@ -75 +75 @@
 </font></h2>
 
-      <p><font face="Courier"><i>result = </i>read_grads(<i><a href="#_read_grads_keyword_var">var</a>, <a href="#_read_grads_keyword_date1">date1</a>[, <a href="#_read_grads_keyword_date2">date2</a>]</i>, <a href="#_read_grads_keyword_FILENAME">FILENAME</a>=<i>FILENAME</i>, <a href="#_read_grads_keyword_BOX">BOX</a>=<i>BOX</i>, <a href="#_read_grads_keyword_TIMESTEP">TIMESTEP</a>=<i>TIMESTEP</i>, <a href="#_read_grads_keyword_EVERYTHING">EVERYTHING</a>=<i>EVERYTHING</i>, <a href="#_read_grads_keyword_NOSTRUCT">NOSTRUCT</a>=<i>NOSTRUCT</i>, <a href="#_read_grads_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
-
-    
-
-
-    
+      <p><font face="Courier"><i>result = </i>read_grads(<i><a href="#_read_grads_keyword_var">var</a>, <a href="#_read_grads_keyword_date1">date1</a>[, <a href="#_read_grads_keyword_date2">date2</a>]</i>, <a href="#_read_grads_keyword_FILENAME">FILENAME</a>=<i>FILENAME</i>, <a href="#_read_grads_keyword_BOX">BOX</a>=<i>A 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1, depth2]</i>, <a href="#_read_grads_keyword_TIMESTEP">TIMESTEP</a>=<i>TIMESTEP</i>, <a href="#_read_grads_keyword_EVERYTHING">EVERYTHING</a>=<i>EVERYTHING</i>, <a href="#_read_grads_keyword_NOSTRUCT">NOSTRUCT</a>=<i>NOSTRUCT</i>, <a href="#_read_grads_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
+
+    
+
+
+    <h3>Return value</h3>
+ an array
+
 
     
@@ -165 +167 @@
       
       
-      
-      
-      
-    </h4>
-
-    
+      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>A 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1, depth2]</i></font>
+      
+      
+    </h4>
+
+    
+ It specifies the area where data must be read
+
     
     <a name="#_read_grads_keyword_TIMESTEP"></a>
@@ -187 +191 @@
  to specify that the dates are time steps instead of true calendar.
 
+ NOT yet available
+
     
     <a name="#_read_grads_keyword_EVERYTHING"></a>
@@ -201 +207 @@
 
     
+
     
     <a name="#_read_grads_keyword_NOSTRUCT"></a>
@@ -215 +222 @@
 
     
+
     
     <a name="#_read_grads_keyword__EXTRA"></a>
@@ -229 +237 @@
 
     
-    
-    
-
-    
-    
-    
-    
-    
-    
-
-    
-    
-    
-    
-    
-
-    
-    
-    
-    
+ Used to pass keywords
+
+    
+    
+
+    <h3>Examples</h3><pre>
+ IDL> a=read_grads('sst',19900101,19900131,filename='outputs.ctl')
+ IDL> plt, a
+
+    </pre><h3>Version history</h3>
+    
+    <h4>Version</h4>
+ $Id: read_grads.pro 327 2007-12-13 16:22:35Z pinsard $
+
+    <h4>History</h4>
+ Sebastien Masson (smasson@lodyc.jussieu.fr)
+
+    
+
+    <h3>Known issues</h3>
+    
+    
+    
+    <h4>Restrictions</h4>
+ define all the grid parameters (defined in common.pro)
+ associated to the data.
+
+ this function call the procedure scanfile that use the
+ unix commands grep and sed
+
+
+    <h3>Other attributes</h3>
+    
+    
+    <h4>Uses routines</h4>
+ common
+