source: trunk/SRC/Documentation/idldoc_html_output/ReadWrite/read_grads.html @ 191

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 6.1 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>read_grads.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="read_grads.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../ReadWrite//read_grads.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="ncdf_timeget.html">&lt;&lt;prev file</a> | <a href="read_oasis.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="read_grads.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ReadWrite/</a></h1>
82      <h2 class="pro_file">read_grads.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 reading grads file (except "data type station" or "grib")
91 from the grads control file even if there is multiple data files.
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_read_grads">
106
107          <h2><a class="top" href="#container">top</a>read_grads <span class="categories"> 
108 Reading
109</span></h2>
110       
111          <p class="header">
112            <span class="result">result = </span>read_grads(<span class="result"><a href="#_read_grads_param_var">var</a>, <a href="#_read_grads_param_date1">date1</a>[, <a href="#_read_grads_param_date2">date2</a>]</span>, <a href="#_read_grads_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_read_grads_keyword_BOX">BOX</a>=<span class="result">BOX</span>, <a href="#_read_grads_keyword_TIMESTEP">TIMESTEP</a>=<span class="result">TIMESTEP</span>, <a href="#_read_grads_keyword_EVERYTHING">EVERYTHING</a>=<span class="result">EVERYTHING</span>, <a href="#_read_grads_keyword_NOSTRUCT">NOSTRUCT</a>=<span class="result">NOSTRUCT</span>, <a href="#_read_grads_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
113       
114          <div class="comments"></div>
115
116         
117
118         
119            <h3>Parameters</h3>
120       
121           
122            <h4 id="_read_grads_param_var">var&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">
134 the variable name
135</div>
136           
137            <h4 id="_read_grads_param_date1">date1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
138              <span class="attr">in</span>
139             
140             
141              <span class="attr">required</span>
142             
143             
144             
145             
146            </h4>
147       
148          <div class="comments">
149 date of the beginning (yyyymmdd if TIMESTEP is not activate)
150</div>
151           
152            <h4 id="_read_grads_param_date2">date2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
153              <span class="attr">in</span>
154             
155              <span class="attr">optional</span>
156             
157             
158             
159             
160             
161            </h4>
162       
163          <div class="comments">
164 last date. Optional, if not specified date2=date1
165</div>
166           
167
168         
169
170         
171
172            <h3>Keywords</h3>
173           
174            <h4 id="_read_grads_keyword_FILENAME">FILENAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
175             
176             
177             
178             
179             
180             
181             
182             
183            </h4>
184       
185            <div class="comments">
186 the grads control file name: 'xxxx.ctl'
187</div>
188           
189            <h4 id="_read_grads_keyword_BOX">BOX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
190             
191             
192             
193             
194             
195             
196             
197             
198            </h4>
199       
200            <div class="comments"></div>
201           
202            <h4 id="_read_grads_keyword_TIMESTEP">TIMESTEP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
203             
204             
205             
206             
207             
208             
209             
210             
211            </h4>
212       
213            <div class="comments">
214 to specify that the dates are time steps instead of true calendar.
215</div>
216           
217            <h4 id="_read_grads_keyword_EVERYTHING">EVERYTHING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
218             
219             
220             
221             
222             
223             
224             
225             
226            </h4>
227       
228            <div class="comments"></div>
229           
230            <h4 id="_read_grads_keyword_NOSTRUCT">NOSTRUCT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
231             
232             
233             
234             
235             
236             
237             
238             
239            </h4>
240       
241            <div class="comments"></div>
242           
243            <h4 id="_read_grads_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
244             
245             
246             
247             
248             
249             
250             
251             
252            </h4>
253       
254            <div class="comments"></div>
255           
256         
257
258         
259         
260         
261         
262         
263         
264         
265         
266         
267         
268         
269         
270       
271         
272         
273         
274         
275         
276         
277         
278       
279          <h3>Statistics</h3>
280          <table class="statistics">
281            <tr><td>McCabe cyclic</td><td>          55</td></tr>
282            <tr><td>McCabe essential</td><td>           2</td></tr>
283            <tr><td>McCabe modular design</td><td>           1</td></tr>
284          </table>
285         
286       
287        </div>
288       
289      </div>
290
291     
292
293      <div id="tagline">Produced by IDLdoc 2.0.</div>
294
295    </div>
296
297  </body>
298</html>
Note: See TracBrowser for help on using the repository browser.