source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/GRIB/read_grib.html @ 290

Last change on this file since 290 was 290, checked in by smasson, 17 years ago

update documentation
File size: 4.9 KB
RevLine 
[89]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>
[104]9    <title>read_grib.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="read_grib.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../../../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../../../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../../../ToBeReviewed/LECTURE/GRIB//read_grib.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[189]74<a href="bit2int.html">&lt;&lt;prev file</a> | <a href="read_grib_bds.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="read_grib.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>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/LECTURE/GRIB/</a></h1>
[89]82      <h2 class="pro_file">read_grib.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[234]89      <div id="file_comments">
90</div>
[89]91
92     
93
94     
95
96     
97
98     
99
100      <div id="routine_details">
101       
102
103        <div class="routine_details" id="_read_grib">
104
[157]105          <h2><a class="top" href="#container">top</a>read_grib <span class="categories">
[234]106</span></h2>
[89]107       
108          <p class="header">
[290]109            <span class="result">result = </span>read_grib(<span class="result"><a href="#_read_grib_param_varcode">varcode</a>[, <a href="#_read_grib_param_date1">date1</a>][, <a href="#_read_grib_param_date2">date2</a>]</span>, <a href="#_read_grib_keyword_FILE">FILE</a>=<span class="result">array or string</span>)</p>
[89]110       
111          <div class="comments"></div>
112
[157]113          <h3>Return value</h3><div class="preformat">
[234]114</div>
[89]115
116         
117            <h3>Parameters</h3>
118       
119           
120            <h4 id="_read_grib_param_varcode">varcode&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
121             
122             
123             
124             
125             
126             
127             
128             
129            </h4>
130       
[234]131          <div class="comments">
[157]132</div>
[89]133           
134            <h4 id="_read_grib_param_date1">date1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[157]135              <span class="attr">in</span>
[89]136             
[157]137              <span class="attr">optional</span>
[89]138             
139             
140             
141             
142             
143            </h4>
144       
[157]145          <div class="comments">
146 Date of the beginning (yyyymmdd if TIMESTEP is not activate)
147</div>
[89]148           
149            <h4 id="_read_grib_param_date2">date2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[157]150              <span class="attr">in</span>
[89]151             
[157]152              <span class="attr">optional</span>
[89]153             
154             
155             
156             
157             
158            </h4>
159       
[157]160          <div class="comments">
161 Last date. Optional, if not specified date2=date1
[234]162</div>
[89]163           
164
165         
166
167         
168
169            <h3>Keywords</h3>
170           
[290]171            <h4 id="_read_grib_keyword_FILE">FILE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]172             
173             
174             
175             
176             
[163]177              <span class="attr">type:</span> <span class="value">array or string</span>
[89]178             
179             
180            </h4>
181       
[157]182            <div class="comments">
183 A single filename or an array of filenames to be retrieved.
[234]184</div>
[89]185           
186         
187
[157]188          <h3>Examples</h3><div class="preformat">
189</div>
190          <h3>Version history</h3>
[89]191         
[157]192          <h4>Version</h4><div class="preformat">
[290]193 $Id: read_grib.pro 262 2007-08-21 14:19:32Z pinsard $
[234]194</div>
[157]195          <h4>History</h4><div class="preformat">
196</div>
[89]197         
198         
[157]199          <h3>Known issues</h3>
[89]200         
201         
202         
[157]203          <h4>Restrictions</h4><div class="preformat">
[234]204</div>
[89]205       
206         
207         
208         
209         
210         
211         
212         
213       
[163]214          <h3>Statistics</h3>
215          <table class="statistics">
216            <tr><td>McCabe cyclic</td><td>          34</td></tr>
217            <tr><td>McCabe essential</td><td>           1</td></tr>
218            <tr><td>McCabe modular design</td><td>           1</td></tr>
219          </table>
[89]220         
221       
222        </div>
223       
224      </div>
225
226     
227
228      <div id="tagline">Produced by IDLdoc 2.0.</div>
229
230    </div>
231
232  </body>
[249]233</html>
Note: See TracBrowser for help on using the repository browser.