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

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

start to modify headers of ReadWrite? *.pro files for better idldoc output
File size: 5.9 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../idldoc-help.html?format=raw" 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?format=raw" 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?format=raw">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"> reading grads file (except "data type station" or "grib")
90 from the grads control file even if there is multiple data files.
91
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"> reading function
108</span></h2>
109       
110          <p class="header">
111            <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>
112       
113          <div class="comments"></div>
114
115         
116
117         
118            <h3>Parameters</h3>
119       
120           
121            <h4 id="_read_grads_param_var">var&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
122              <span class="attr">in</span>
123             
124             
125              <span class="attr">required</span>
126             
127             
128             
129             
130            </h4>
131       
132          <div class="comments"> the variable name</div>
133           
134            <h4 id="_read_grads_param_date1">date1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
135              <span class="attr">in</span>
136             
137             
138              <span class="attr">required</span>
139             
140             
141             
142             
143            </h4>
144       
145          <div class="comments"> date of the beginning (yyyymmdd if TIMESTEP is not activate)</div>
146           
147            <h4 id="_read_grads_param_date2">date2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148              <span class="attr">in</span>
149             
150              <span class="attr">optional</span>
151             
152             
153             
154             
155             
156            </h4>
157       
158          <div class="comments"> last date. Optionnal, if not scpecified date2=date1
159      </div>
160           
161
162         
163
164         
165
166            <h3>Keywords</h3>
167           
168            <h4 id="_read_grads_keyword_FILENAME">FILENAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
169             
170             
171             
172             
173             
174             
175             
176             
177            </h4>
178       
179            <div class="comments"> the grads control file name: 'xxxx.ctl'
180</div>
181           
182            <h4 id="_read_grads_keyword_BOX">BOX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
183             
184             
185             
186             
187             
188             
189             
190             
191            </h4>
192       
193            <div class="comments"></div>
194           
195            <h4 id="_read_grads_keyword_TIMESTEP">TIMESTEP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
196             
197             
198             
199             
200             
201             
202             
203             
204            </h4>
205       
206            <div class="comments"> to specify that the dates are time steps instead of
207       true calendar.
208</div>
209           
210            <h4 id="_read_grads_keyword_EVERYTHING">EVERYTHING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
211             
212             
213             
214             
215             
216             
217             
218             
219            </h4>
220       
221            <div class="comments"></div>
222           
223            <h4 id="_read_grads_keyword_NOSTRUCT">NOSTRUCT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
224             
225             
226             
227             
228             
229             
230             
231             
232            </h4>
233       
234            <div class="comments"></div>
235           
236            <h4 id="_read_grads_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
237             
238             
239             
240             
241             
242             
243             
244             
245            </h4>
246       
247            <div class="comments"></div>
248           
249         
250
251         
252         
253         
254         
255         
256         
257         
258         
259         
260         
261         
262         
263       
264         
265         
266         
267         
268         
269         
270         
271       
272         
273       
274        </div>
275       
276      </div>
277
278     
279
280      <div id="tagline">Produced by IDLdoc 2.0.</div>
281
282    </div>
283
284  </body>
285</html>
Note: See TracBrowser for help on using the repository browser.