source: trunk/SRC/Documentation/idldoc_assistant_output/Grid/checkperio.html @ 242

Last change on this file since 242 was 242, checked in by pinsard, 17 years ago

improvements/corrections of some *.pro headers + replace some message by some report
File size: 4.2 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>checkperio.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="changemsk.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="computegrid.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Grid/</font></h1>
58    <h2>checkperio.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 check ORCA2 and ORCA05 periodicity (east-west and noth fold) for files related to the T GRID ONLY
65
66
67   
68
69     
70      <a name="#_checkperio"></a>
71
72      <h2>checkperio  <font size="-1" color="#006633">
73 Grid
74</font></h2>
75
76      <p><font face="Courier">checkperio<i>, <a href="#_checkperio_keyword_file">file</a></i>, <a href="#_checkperio_keyword_WRITE">WRITE</a>=<i>scalar: 0 or 1</i></font></p>
77
78   
79
80
81   
82
83   
84    <h3>Parameters</h3>
85   
86
87    <a name="#_checkperio_keyword_file"></a>
88    <h4>file&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
89      <font size="-1" color="#006633">in</font>
90     
91     
92      <font size="-1" color="#006633">required</font>
93     
94      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
95     
96     
97    </h4>
98
99   
100 A string giving the name of the NetCdf file
101
102   
103   
104
105   
106    <h3>Keywords</h3>
107
108   
109    <a name="#_checkperio_keyword_WRITE"></a>
110    <h4>WRITE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
111     
112     
113     
114     
115     
116      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
117      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
118     
119    </h4>
120
121   
122 Define to 1 to write the good periodicity in the file.
123 By default print only message of periodicity errors
124
125   
126   
127
128    <h3>Examples</h3><pre>
129    IDL> checkperio, '/Users/smasson/OPA/modipsl/bin/runoff_1m_nomask.nc'
130    checkperio, '/Users/smasson/OPA/modipsl/bin/runoff_1m_nomask.nc'
131    nav_lon bad y periodicity (1)
132    nav_lon bad y periodicity (2)
133    nav_lon bad x periodicity (1)
134    nav_lon bad x periodicity (2)
135    nav_lat bad y periodicity (1)
136    nav_lat bad y periodicity (2)
137    nav_lat bad x periodicity (1)
138    nav_lat bad x periodicity (2)
139    socoefr bad y periodicity (1)
140    socoefr bad x periodicity (1)
141    socoefr bad x periodicity (2)
142    sorunoff bad x periodicity (1)
143    sorunoff bad x periodicity (2)
144    IDL> checkperio, '/Users/smasson/OPA/modipsl/bin/runoff_1m_nomask.nc', /WRITE
145    IDL> checkperio, '/Users/smasson/OPA/modipsl/bin/runoff_1m_nomask.nc'
146
147    </pre><h3>Version history</h3>
148   
149    <h4>Version</h4>
150 $Id: checkperio.pro 238 2007-03-27 13:43:18Z pinsard $
151    <h4>History</h4>
152 October 2006: Sebastien Masson (smasson@locean-ipsl.upmc.fr)
153
154   
155
156    <h3>Known issues</h3>
157   
158   
159   
160    <h4>Restrictions</h4>
161 Works only for grid T points
162 if the WRITE keyword is activated, we need the writing access on the file!
163
164
165   
166   
167   
168   
169   
170   
171   
172
173    <font size="-3"><p>&nbsp;</p></font>
174    <hr size="1" color="#CCCCCC"/>
175     
176
177   
178
179    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
180
181  </body>
182</html>
Note: See TracBrowser for help on using the repository browser.