Ignore:
Timestamp:
07/23/09 11:18:49 (15 years ago)
Author:
smasson
Message:

update documentation

Location:
trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite
Files:
12 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/idl-NetCDF/ncdf_listvars.html

    r321 r402  
    110110 
    111111    <h3>Examples</h3><pre> 
    112  IDL> varnames = ncdf_listvars('toto.nc') 
     112 
     113   IDL> varnames = ncdf_listvars('toto.nc') 
     114 
    113115   or 
    114  IDL> i=ncdf_open('toto.nc') 
    115  IDL> varnames = ncdf_listvars(id) 
     116 
     117   IDL> i=ncdf_open('toto.nc') 
     118   IDL> varnames = ncdf_listvars(id) 
    116119  
    117120    </pre><h3>Version history</h3> 
    118121     
    119122    <h4>Version</h4> 
    120  $Id: ncdf_listvars.pro 308 2007-11-05 10:20:28Z smasson $ 
     123 $Id: ncdf_listvars.pro 371 2008-08-07 09:32:02Z pinsard $ 
    121124 
    122125    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/ncdf_getatt.html

    r363 r402  
    286286 
    287287     
    288  defined only to be able to call ncdf_getatt with the _extra keyword 
     288 defined only to be able to call <a href="..//ReadWrite/ncdf_getatt.html">ncdf_getatt</a> with the  
     289 _EXTRA keyword 
    289290 
    290291     
    … …  
    292293 
    293294    <h3>Examples</h3><pre> 
    294  IDL> ncdf_getatt, cdfid, 'sst', add_offset = add_offset, scale_factor = scale_factor, units = units 
     295 
     296   IDL> ncdf_getatt, cdfid, 'sst', add_offset = add_offset, scale_factor = scale_factor, units = units 
    295297 
    296298    </pre><h3>Version history</h3> 
    297299     
    298300    <h4>Version</h4> 
    299  $Id: ncdf_getatt.pro 344 2008-04-15 11:05:43Z smasson $ 
     301 $Id: ncdf_getatt.pro 396 2009-04-08 16:14:31Z smasson $ 
    300302 
    301303    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/ncdf_getaxis.html

    r338 r402  
    7474</font></h2> 
    7575 
    76       <p><font face="Courier">ncdf_getaxis<i>, <a href="#_ncdf_getaxis_keyword_fileid">fileid</a>, <a href="#_ncdf_getaxis_keyword_dimidx">dimidx</a>, <a href="#_ncdf_getaxis_keyword_dimidy">dimidy</a>, <a href="#_ncdf_getaxis_keyword_xaxis">xaxis</a>, <a href="#_ncdf_getaxis_keyword_yaxis">yaxis</a></i>, <a href="#_ncdf_getaxis_keyword_XAXISNAME">XAXISNAME</a>=<i>scalar string</i>, <a href="#_ncdf_getaxis_keyword_YAXISNAME">YAXISNAME</a>=<i>scalar string</i>, <a href="#_ncdf_getaxis_keyword_XDIMNAME">XDIMNAME</a>=<i>scalar string</i>, <a href="#_ncdf_getaxis_keyword_YDIMNAME">YDIMNAME</a>=<i>scalar string</i>, <a href="#_ncdf_getaxis_keyword_XYINDEX">XYINDEX</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getaxis_keyword_START1">START1</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getaxis_keyword_ROMSGRID">ROMSGRID</a>=<i>variable</i>, <a href="#_ncdf_getaxis_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p> 
     76      <p><font face="Courier">ncdf_getaxis<i>, <a href="#_ncdf_getaxis_keyword_fileid">fileid</a>, <a href="#_ncdf_getaxis_keyword_dimidx">dimidx</a>, <a href="#_ncdf_getaxis_keyword_dimidy">dimidy</a>, <a href="#_ncdf_getaxis_keyword_xaxis">xaxis</a>, <a href="#_ncdf_getaxis_keyword_yaxis">yaxis</a></i>, <a href="#_ncdf_getaxis_keyword_XAXISNAME">XAXISNAME</a>=<i>scalar string</i>, <a href="#_ncdf_getaxis_keyword_YAXISNAME">YAXISNAME</a>=<i>scalar string</i>, <a href="#_ncdf_getaxis_keyword_XDIMNAME">XDIMNAME</a>=<i>scalar string</i>, <a href="#_ncdf_getaxis_keyword_YDIMNAME">YDIMNAME</a>=<i>scalar string</i>, <a href="#_ncdf_getaxis_keyword_XYINDEX">XYINDEX</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getaxis_keyword_START1">START1</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getaxis_keyword_XMINMESH">XMINMESH</a>=<i>scalar</i>, <a href="#_ncdf_getaxis_keyword_XMAXMESH">XMAXMESH</a>=<i>scalar</i>, <a href="#_ncdf_getaxis_keyword_YMINMESH">YMINMESH</a>=<i>scalar</i>, <a href="#_ncdf_getaxis_keyword_YMAXMESH">YMAXMESH</a>=<i>scalar</i>, <a href="#_ncdf_getaxis_keyword_ROMSGRID">ROMSGRID</a>=<i>variable</i>, <a href="#_ncdf_getaxis_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p> 
    7777 
    7878     
    … …  
    279279 
    280280     
     281    <a name="#_ncdf_getaxis_keyword_XMINMESH"></a> 
     282    <h4>XMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     283       
     284       
     285       
     286       
     287       
     288      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     289      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font> 
     290       
     291    </h4> 
     292 
     293     
     294 Define common (cm_4mesh) variables ixminmesh used to define the localization 
     295 of the first point of the grid along the x direction in a zoom of the original grid 
     296 
     297     
     298    <a name="#_ncdf_getaxis_keyword_XMAXMESH"></a> 
     299    <h4>XMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     300       
     301       
     302       
     303       
     304       
     305      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     306      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpiglo-1</i></font> 
     307       
     308    </h4> 
     309 
     310     
     311 Define common (cm_4mesh) variables ixmaxmesh used to define the localization 
     312 of the last point of the grid along the x direction in a zoom of the original grid 
     313 Note that if XMAXMESH < 0 then ixmaxmesh is defined as ixmaxmesh = jpiglo -1 + xmaxmesh 
     314 
     315     
     316    <a name="#_ncdf_getaxis_keyword_YMINMESH"></a> 
     317    <h4>YMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     318       
     319       
     320       
     321       
     322       
     323      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     324      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font> 
     325       
     326    </h4> 
     327 
     328     
     329 Define common (cm_4mesh) variables iyminmesh used to define the localization 
     330 of the first point of the grid along the y direction in a zoom of the original grid 
     331 
     332     
     333    <a name="#_ncdf_getaxis_keyword_YMAXMESH"></a> 
     334    <h4>YMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     335       
     336       
     337       
     338       
     339       
     340      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     341      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpjglo-1</i></font> 
     342       
     343    </h4> 
     344 
     345     
     346 Define common (cm_4mesh) variables iymaxmesh used to define the localization 
     347 of the last point of the grid along the y direction in a zoom of the original grid 
     348 Note that if YMAXMESH < 0 then iymaxmesh is defined as iymaxmesh = jpjglo -1 + ymaxmesh 
     349 
     350     
    281351    <a name="#_ncdf_getaxis_keyword_ROMSGRID"></a> 
    282352    <h4>ROMSGRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    317387     
    318388    <h4>Version</h4> 
    319  $Id: ncdf_getaxis.pro 327 2007-12-13 16:22:35Z pinsard $ 
     389 $Id: ncdf_getaxis.pro 399 2009-07-02 08:38:54Z smasson $ 
    320390    <h4>History</h4> 
    321391 March 2007: Sebastien Masson (smasson@locean-ipsl.upmc.fr) 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/ncdf_getmask.html

    r363 r402  
    7474</font></h2> 
    7575 
    76       <p><font face="Courier"><i>result = </i>ncdf_getmask(<i><a href="#_ncdf_getmask_keyword_fileid">fileid</a></i>, <a href="#_ncdf_getmask_keyword_ADDSCL_BEFORE">ADDSCL_BEFORE</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getmask_keyword_MASKNAME">MASKNAME</a>=<i>string</i>, <a href="#_ncdf_getmask_keyword_USEASMASK">USEASMASK</a>=<i>scalar string</i>, <a href="#_ncdf_getmask_keyword_MISSING_VALUE">MISSING_VALUE</a>=<i>scalar</i>, <a href="#_ncdf_getmask_keyword_INVMASK">INVMASK</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getmask_keyword_TESTOP">TESTOP</a>=<i>scalar string, for example 'GT 0.5'</i>, <a href="#_ncdf_getmask_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> 
     76      <p><font face="Courier"><i>result = </i>ncdf_getmask(<i><a href="#_ncdf_getmask_keyword_fileid">fileid</a></i>, <a href="#_ncdf_getmask_keyword_ADDSCL_BEFORE">ADDSCL_BEFORE</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getmask_keyword_MASKNAME">MASKNAME</a>=<i>string</i>, <a href="#_ncdf_getmask_keyword_USEASMASK">USEASMASK</a>=<i>scalar string</i>, <a href="#_ncdf_getmask_keyword_MISSING_VALUE">MISSING_VALUE</a>=<i>scalar</i>, <a href="#_ncdf_getmask_keyword_INVMASK">INVMASK</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_getmask_keyword_XMINMESH">XMINMESH</a>=<i>scalar</i>, <a href="#_ncdf_getmask_keyword_XMAXMESH">XMAXMESH</a>=<i>scalar</i>, <a href="#_ncdf_getmask_keyword_YMINMESH">YMINMESH</a>=<i>scalar</i>, <a href="#_ncdf_getmask_keyword_YMAXMESH">YMAXMESH</a>=<i>scalar</i>, <a href="#_ncdf_getmask_keyword_ZMINMESH">ZMINMESH</a>=<i>scalar</i>, <a href="#_ncdf_getmask_keyword_ZMAXMESH">ZMAXMESH</a>=<i>scalar</i>, <a href="#_ncdf_getmask_keyword_TESTOP">TESTOP</a>=<i>scalar string, for example 'GT 0.5'</i>, <a href="#_ncdf_getmask_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> 
    7777 
    7878     
    … …  
    103103 the full path) to be opened (in that case, the file will be opened 
    104104 and closed within ncdf_getmask). 
     105 
    105106 if fileid is a scalar then it is the id of the file return by a call 
    106107 to ncdf_open outside of ncdf_getmask (in that case, the file will 
    … …  
    127128 
    128129     
    129  put 1 to apply add_offset ad scale factor on data before looking for 
     130 put 1 to apply add_offset and scale factor on data before looking for 
    130131 missing values when using USEASMASK keyword 
    131132 
    … …  
    206207 
    207208     
     209    <a name="#_ncdf_getmask_keyword_XMINMESH"></a> 
     210    <h4>XMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     211       
     212       
     213       
     214       
     215       
     216      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     217      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font> 
     218       
     219    </h4> 
     220 
     221     
     222       Define common (cm_4mesh) variables ixminmesh used to define the localization 
     223       of the first point of the grid along the x direction in a zoom of the original grid 
     224 
     225     
     226    <a name="#_ncdf_getmask_keyword_XMAXMESH"></a> 
     227    <h4>XMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     228       
     229       
     230       
     231       
     232       
     233      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     234      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpiglo-1</i></font> 
     235       
     236    </h4> 
     237 
     238     
     239       Define common (cm_4mesh) variables ixmaxmesh used to define the localization 
     240       of the last point of the grid along the x direction in a zoom of the original grid 
     241       Note that if XMAXMESH < 0 then ixmaxmesh is defined as ixmaxmesh = jpiglo -1 + xmaxmesh 
     242 
     243     
     244    <a name="#_ncdf_getmask_keyword_YMINMESH"></a> 
     245    <h4>YMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     246       
     247       
     248       
     249       
     250       
     251      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     252      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font> 
     253       
     254    </h4> 
     255 
     256     
     257       Define common (cm_4mesh) variables iyminmesh used to define the localization 
     258       of the first point of the grid along the y direction in a zoom of the original grid 
     259 
     260     
     261    <a name="#_ncdf_getmask_keyword_YMAXMESH"></a> 
     262    <h4>YMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     263       
     264       
     265       
     266       
     267       
     268      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     269      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpjglo-1</i></font> 
     270       
     271    </h4> 
     272 
     273     
     274       Define common (cm_4mesh) variables iymaxmesh used to define the localization 
     275       of the last point of the grid along the y direction in a zoom of the original grid 
     276       Note that if YMAXMESH < 0 then iymaxmesh is defined as iymaxmesh = jpjglo -1 + ymaxmesh 
     277 
     278     
     279    <a name="#_ncdf_getmask_keyword_ZMINMESH"></a> 
     280    <h4>ZMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     281       
     282       
     283       
     284       
     285       
     286      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     287      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font> 
     288       
     289    </h4> 
     290 
     291     
     292       Define common (cm_4mesh) variables izminmesh used to define the localization 
     293       of the first point of the grid along the z direction in a zoom of the original grid 
     294 
     295     
     296    <a name="#_ncdf_getmask_keyword_ZMAXMESH"></a> 
     297    <h4>ZMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     298       
     299       
     300       
     301       
     302       
     303      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     304      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpkglo-1</i></font> 
     305       
     306    </h4> 
     307 
     308     
     309       Define common (cm_4mesh) variables izmaxmesh used to define the localization 
     310       of the last point of the grid along the z direction in a zoom of the original grid 
     311       Note that if ZMAXMESH < 0 then izmaxmesh is defined as izmaxmesh = jpkglo -1 + maxmesh 
     312 
     313     
    208314    <a name="#_ncdf_getmask_keyword_TESTOP"></a> 
    209315    <h4>TESTOP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    222328 mask. The test is performed on the variable specified by USEASMASK 
    223329 keyword. 
     330 
    224331 TESTOP can contain 1 or 2 words. The first word is the operator 
    225332 definition: "EQ" "NE" "GE" "GT" "LE" "LT" (default is NE). The 
    … …  
    250357    <h3>Examples</h3><pre> 
    251358 
    252  IDL> mask = ncdf_getmask('HadISST1_1m_187001_200702_sst_reg1m.nc',useasmask = 'sst', missing_value = -1.00000e+30) 
    253  
    254  IDL> mask = ncdf_getmask('meshmaskORCA2.nc', maskname = 'tmask') 
    255  
    256  IDL> mask = ncdf_getmask('t106.nc', useasmask = 'SLM', testop = 'le 0.5') 
     359   IDL> mask = ncdf_getmask('HadISST1_1m_187001_200702_sst_reg1m.nc',useasmask = 'sst', missing_value = -1.00000e+30) 
     360 
     361   IDL> mask = ncdf_getmask('meshmaskORCA2.nc', maskname = 'tmask') 
     362 
     363   IDL> mask = ncdf_getmask('t106.nc', useasmask = 'SLM', testop = 'le 0.5') 
    257364 
    258365    </pre><h3>Version history</h3> 
    259366     
    260367    <h4>Version</h4> 
    261  $Id: ncdf_getmask.pro 361 2008-07-07 14:23:42Z smasson $ 
     368 $Id: ncdf_getmask.pro 399 2009-07-02 08:38:54Z smasson $ 
    262369 
    263370    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/ncdf_gettime.html

    r363 r402  
    7575</font></h2> 
    7676 
    77       <p><font face="Courier"><i>result = </i>ncdf_gettime(<i><a href="#_ncdf_gettime_keyword_filename">filename</a>, <a href="#_ncdf_gettime_keyword_cdfid">cdfid</a></i>, <a href="#_ncdf_gettime_keyword_TIMEVAR">TIMEVAR</a>=<i>string</i>, <a href="#_ncdf_gettime_keyword_CALLER">CALLER</a>=<i>scalar</i>, <a href="#_ncdf_gettime_keyword_ERR">ERR</a>=<i>ERR</i>, <a href="#_ncdf_gettime_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> 
     77      <p><font face="Courier"><i>result = </i>ncdf_gettime(<i><a href="#_ncdf_gettime_keyword_filename">filename</a>[, <a href="#_ncdf_gettime_keyword_cdfid">cdfid</a>]</i>, <a href="#_ncdf_gettime_keyword_CALTYPE">CALTYPE</a>=<i>CALTYPE</i>, <a href="#_ncdf_gettime_keyword_TIMEVAR">TIMEVAR</a>=<i>string</i>, <a href="#_ncdf_gettime_keyword_CALLER">CALLER</a>=<i>string</i>, <a href="#_ncdf_gettime_keyword_ERR">ERR</a>=<i>ERR</i>, <a href="#_ncdf_gettime_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> 
    7878 
    7979     
    … …  
    111111      <font size="-1" color="#006633">in</font> 
    112112       
    113        
    114       <font size="-1" color="#006633">required</font> 
     113      <font size="-1" color="#006633">optional</font> 
     114       
    115115       
    116116      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
    … …  
    120120 
    121121     
    122  the ID of the ncdf_file, which is already open 
     122 the ID of the ncdf_file, if the file is already open.  
     123 if not provided, ncdf_gettime open the file defined by filename 
    123124 
    124125     
    … …  
    127128     
    128129    <h3>Keywords</h3> 
     130 
     131     
     132    <a name="#_ncdf_gettime_keyword_CALTYPE"></a> 
     133    <h4>CALTYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     134       
     135       
     136       
     137       
     138       
     139       
     140       
     141       
     142    </h4> 
     143 
     144     
     145 Used to specify (or orverwrite) the type of calendar that should be 
     146 used. We accept only 'noleap', '360d', 'greg' and 'gregorian'. By 
     147 default, we use the type of calendar defied in the attibute 
     148 calendar. if not, we define it as gregorian. 
    129149 
    130150     
    … …  
    155175      <font size="-1" color="#006633">required</font> 
    156176       
    157       <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     177      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font> 
    158178       
    159179       
    … …  
    162182     
    163183 Used to specify the error messages. Give the name of the calling 
    164  procedure. It can be only 'read_ncdf' or 'scanfile'. 
     184 procedure. It can be only '<a href="..//ToBeReviewed/LECTURE/read_ncdf.html">read_ncdf</a>' or '<a href="..//ToBeReviewed/WIDGET/AUTOUR_de_XXX/scanfile.html">scanfile</a>'. 
     185 
    165186 
    166187     
    … …  
    204225     
    205226    <h4>Version</h4> 
    206  $Id: ncdf_gettime.pro 358 2008-04-28 09:41:14Z pinsard $ 
     227 $Id: ncdf_gettime.pro 401 2009-07-23 08:48:16Z smasson $ 
    207228    <h4>History</h4> 
    208229 August 2007: Sebastien Masson (smasson@lodyc.jussieu.fr) 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/ncdf_timeget.html

    r363 r402  
    163163 
    164164     
    165     </pre></pre></pre></pre></pre><h3>Version history</h3> 
     165    </pre></pre></pre></pre></pre></pre><h3>Version history</h3> 
    166166     
    167167    <h4>Version</h4> 

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

    r338 r402  
    243243 
    244244    <h3>Examples</h3><pre> 
    245  IDL> a=read_grads('sst',19900101,19900131,filename='outputs.ctl') 
    246  IDL> plt, a 
     245 
     246   IDL> a=read_grads('sst',19900101,19900131,filename='outputs.ctl') 
     247   IDL> plt, a 
    247248 
    248249    </pre><h3>Version history</h3> 
    249250     
    250251    <h4>Version</h4> 
    251  $Id: read_grads.pro 327 2007-12-13 16:22:35Z pinsard $ 
     252 $Id: read_grads.pro 370 2008-08-07 07:59:15Z pinsard $ 
    252253 
    253254    <h4>History</h4> 
    … …  
    261262     
    262263    <h4>Restrictions</h4> 
    263  define all the grid parameters (defined in common.pro) 
     264 define all the grid parameters (defined in <a href="..//Obsolete/common.html">common</a>) 
    264265 associated to the data. 
    265266 
    266  this function call the procedure scanfile that use the 
     267 this function call the procedure <a href="..//ToBeReviewed/WIDGET/AUTOUR_de_XXX/scanfile.html">scanfile</a> that use the 
    267268 unix commands grep and sed 
    268269 
    … …  
    272273     
    273274    <h4>Uses routines</h4> 
    274  common 
     275 <a href="..//Obsolete/common.html">common</a> 
    275276 
    276277     

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/read_oasis.html

    r338 r402  
    220220 
    221221    <h3>Examples</h3><pre> 
    222  IDL> a=read_oasis('grids_orca_t106','a106.lon',320,160) 
    223  IDL> m=read_oasis('masks_orca_t106','or1t.msk',182,149,/i4) 
    224  
    225  see also IDL> scanoasis,'grids_orca_t106' 
     222 
     223   IDL> a=read_oasis('grids_orca_t106','a106.lon',320,160) 
     224   IDL> m=read_oasis('masks_orca_t106','or1t.msk',182,149,/i4) 
     225 
     226 see also  
     227 
     228   IDL> scanoasis,'grids_orca_t106' 
    226229 
    227230    </pre><h3>Version history</h3> 
    228231     
    229232    <h4>Version</h4> 
    230  $Id: read_oasis.pro 327 2007-12-13 16:22:35Z pinsard $ 
     233 $Id: read_oasis.pro 371 2008-08-07 09:32:02Z pinsard $ 
    231234 
    232235    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/readbat.html

    r338 r402  
    121121    </h4> 
    122122 
    123      to put 0 on land instead of negatives values for the islands. 
     123     
     124 to put 0 on land instead of negatives values for the islands. 
    124125 
    125126     
    … …  
    130131     
    131132    <h4>Version</h4> 
    132   $Id: readbat.pro 327 2007-12-13 16:22:35Z pinsard $ 
     133  $Id: readbat.pro 372 2008-08-08 12:31:53Z pinsard $ 
    133134 
    134135    <h4>History</h4> 
    135136 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    136137                      May 31, 2002 
    137     based on batlec2.pro, written by Maurice Imbard, March 17, 1998 
     138 based on batlec2.pro, written by Maurice Imbard, March 17, 1998 
    138139 
    139140     

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/readoldopadistcoast.html

    r338 r402  
    6464 read the old binary direct access file that contains the 
    6565 distance to the coast in OPA. 
     66 
    6667 based on the OPA subroutines dtacof and parctl 
    6768 
    … …  
    162163     
    163164    <h4>Version</h4> 
    164  $Id: readoldopadistcoast.pro 327 2007-12-13 16:22:35Z pinsard $ 
     165 $Id: readoldopadistcoast.pro 372 2008-08-08 12:31:53Z pinsard $ 
    165166 
    166167    <h4>History</h4> 
    … …  
    328329     
    329330    <h4>Version</h4> 
    330  $Id: readoldopadistcoast.pro 327 2007-12-13 16:22:35Z pinsard $ 
     331 $Id: readoldopadistcoast.pro 372 2008-08-08 12:31:53Z pinsard $ 
    331332 
    332333    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/scanoasis.html

    r338 r402  
    105105 
    106106    <h3>Examples</h3><pre> 
    107  IDL> scanoasis,'grids_orca_t106' 
     107 
     108   IDL> scanoasis,'grids_orca_t106' 
    108109 
    109110    </pre><h3>Version history</h3> 
    110111     
    111112    <h4>Version</h4> 
    112  $Id: scanoasis.pro 325 2007-12-06 10:04:53Z pinsard $ 
     113 $Id: scanoasis.pro 371 2008-08-07 09:32:02Z pinsard $ 
    113114 
    114115    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/write_ncdf.html

    r338 r402  
    8282      <dd><font size="-1">   SUBROUTINE (3)/(3) :    convertit une structure contenant une liste  chainee en structure classique utilisee par le main prog (utile pour  passer ces structures en argument au sous-prog  writenc_unlimdim_update, i.</font></dd> 
    8383       
    84       <dt><a href="#_write_ncdf">write_ncdf<i>, var01[, var02], var03, var04, var05, var06, var07, var08, var09, var10, var11, var12, var13, var14, var15, var16, var17, var18, var19, var20, var21, var22, var23, var24, var25, var26, var27, var28, var29, var30</i>[, FILENAME=<i>FILENAME</i>][, GLOBATTR=<i>GLOBATTR</i>], VARNAME=<i>VARNAME</i>, NOT_SDISV=<i>NOT_SDISV</i>, NOT_OUASSALU=<i>NOT_OUASSALU</i>, OKNAN=<i>OKNAN</i></a><dt> 
     84      <dt><a href="#_write_ncdf">write_ncdf<i>, var01[, var02], var03, var04, var05, var06, var07, var08, var09, var10, var11, var12, var13, var14, var15, var16, var17, var18, var19, var20, var21, var22, var23, var24, var25, var26, var27, var28, var29, var30</i>[, FILENAME=<i>FILENAME</i>][, GLOBATTR=<i>GLOBATTR</i>][, VARNAME=<i>VARNAME</i>], NOT_SDISV=<i>NOT_SDISV</i>, NOT_OUASSALU=<i>NOT_OUASSALU</i>, OKNAN=<i>OKNAN</i></a><dt> 
    8585      <dd><font size="-1">     pro write_ncdf, var01,var02,var03,var04,var05,var06,var07,var08,var09,var10               $                  ,var11,var12,var13,var14,var15,var16,var17,var18,var19,var20               $                 ,var21,var22,var23,var24,var25,var26,var27,var28,var29,var30               $                 ,FILENAME=filename                                                         $                  ,GLOBATTR=globattr                                                         $                 ,VARNAME=namevquick   --------------------------------------------------------------------------------------------- </font></dd> 
    8686       
    … …  
    516516      <h2>write_ncdf  </h2> 
    517517 
    518       <p><font face="Courier">write_ncdf<i>, <a href="#_write_ncdf_keyword_var01">var01</a>[, <a href="#_write_ncdf_keyword_var02">var02</a>], <a href="#_write_ncdf_keyword_var03">var03</a>, <a href="#_write_ncdf_keyword_var04">var04</a>, <a href="#_write_ncdf_keyword_var05">var05</a>, <a href="#_write_ncdf_keyword_var06">var06</a>, <a href="#_write_ncdf_keyword_var07">var07</a>, <a href="#_write_ncdf_keyword_var08">var08</a>, <a href="#_write_ncdf_keyword_var09">var09</a>, <a href="#_write_ncdf_keyword_var10">var10</a>, <a href="#_write_ncdf_keyword_var11">var11</a>, <a href="#_write_ncdf_keyword_var12">var12</a>, <a href="#_write_ncdf_keyword_var13">var13</a>, <a href="#_write_ncdf_keyword_var14">var14</a>, <a href="#_write_ncdf_keyword_var15">var15</a>, <a href="#_write_ncdf_keyword_var16">var16</a>, <a href="#_write_ncdf_keyword_var17">var17</a>, <a href="#_write_ncdf_keyword_var18">var18</a>, <a href="#_write_ncdf_keyword_var19">var19</a>, <a href="#_write_ncdf_keyword_var20">var20</a>, <a href="#_write_ncdf_keyword_var21">var21</a>, <a href="#_write_ncdf_keyword_var22">var22</a>, <a href="#_write_ncdf_keyword_var23">var23</a>, <a href="#_write_ncdf_keyword_var24">var24</a>, <a href="#_write_ncdf_keyword_var25">var25</a>, <a href="#_write_ncdf_keyword_var26">var26</a>, <a href="#_write_ncdf_keyword_var27">var27</a>, <a href="#_write_ncdf_keyword_var28">var28</a>, <a href="#_write_ncdf_keyword_var29">var29</a>, <a href="#_write_ncdf_keyword_var30">var30</a></i>[, <a href="#_write_ncdf_keyword_FILENAME">FILENAME</a>=<i>FILENAME</i>][, <a href="#_write_ncdf_keyword_GLOBATTR">GLOBATTR</a>=<i>GLOBATTR</i>], <a href="#_write_ncdf_keyword_VARNAME">VARNAME</a>=<i>VARNAME</i>, <a href="#_write_ncdf_keyword_NOT_SDISV">NOT_SDISV</a>=<i>NOT_SDISV</i>, <a href="#_write_ncdf_keyword_NOT_OUASSALU">NOT_OUASSALU</a>=<i>NOT_OUASSALU</i>, <a href="#_write_ncdf_keyword_OKNAN">OKNAN</a>=<i>OKNAN</i></font></p> 
     518      <p><font face="Courier">write_ncdf<i>, <a href="#_write_ncdf_keyword_var01">var01</a>[, <a href="#_write_ncdf_keyword_var02">var02</a>], <a href="#_write_ncdf_keyword_var03">var03</a>, <a href="#_write_ncdf_keyword_var04">var04</a>, <a href="#_write_ncdf_keyword_var05">var05</a>, <a href="#_write_ncdf_keyword_var06">var06</a>, <a href="#_write_ncdf_keyword_var07">var07</a>, <a href="#_write_ncdf_keyword_var08">var08</a>, <a href="#_write_ncdf_keyword_var09">var09</a>, <a href="#_write_ncdf_keyword_var10">var10</a>, <a href="#_write_ncdf_keyword_var11">var11</a>, <a href="#_write_ncdf_keyword_var12">var12</a>, <a href="#_write_ncdf_keyword_var13">var13</a>, <a href="#_write_ncdf_keyword_var14">var14</a>, <a href="#_write_ncdf_keyword_var15">var15</a>, <a href="#_write_ncdf_keyword_var16">var16</a>, <a href="#_write_ncdf_keyword_var17">var17</a>, <a href="#_write_ncdf_keyword_var18">var18</a>, <a href="#_write_ncdf_keyword_var19">var19</a>, <a href="#_write_ncdf_keyword_var20">var20</a>, <a href="#_write_ncdf_keyword_var21">var21</a>, <a href="#_write_ncdf_keyword_var22">var22</a>, <a href="#_write_ncdf_keyword_var23">var23</a>, <a href="#_write_ncdf_keyword_var24">var24</a>, <a href="#_write_ncdf_keyword_var25">var25</a>, <a href="#_write_ncdf_keyword_var26">var26</a>, <a href="#_write_ncdf_keyword_var27">var27</a>, <a href="#_write_ncdf_keyword_var28">var28</a>, <a href="#_write_ncdf_keyword_var29">var29</a>, <a href="#_write_ncdf_keyword_var30">var30</a></i>[, <a href="#_write_ncdf_keyword_FILENAME">FILENAME</a>=<i>FILENAME</i>][, <a href="#_write_ncdf_keyword_GLOBATTR">GLOBATTR</a>=<i>GLOBATTR</i>][, <a href="#_write_ncdf_keyword_VARNAME">VARNAME</a>=<i>VARNAME</i>], <a href="#_write_ncdf_keyword_NOT_SDISV">NOT_SDISV</a>=<i>NOT_SDISV</i>, <a href="#_write_ncdf_keyword_NOT_OUASSALU">NOT_OUASSALU</a>=<i>NOT_OUASSALU</i>, <a href="#_write_ncdf_keyword_OKNAN">OKNAN</a>=<i>OKNAN</i></font></p> 
    519519 
    520520     
    … …  
    531531 
    532532 
    533      
     533    <h3>Return value</h3> 
     534 a netcdf file containing the variable in the format specified 
     535 through keywords and variables  
     536 
    534537 
    535538     
    … …  
    10481051    <a name="#_write_ncdf_keyword_VARNAME"></a> 
    10491052    <h4>VARNAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1050        
    1051        
    1052        
    1053        
    1054        
    1055        
    1056        
    1057        
    1058     </h4> 
    1059  
    1060      
     1053      <font size="-1" color="#006633">in</font> 
     1054       
     1055      <font size="-1" color="#006633">optional</font> 
     1056       
     1057       
     1058       
     1059       
     1060       
     1061    </h4> 
     1062 
     1063      
     1064  - an array of char, same number of elements as the number of given 
     1065    var 
     1066  - if specified, it gives the names of the variables as an array for 
     1067    the default name values (if one of the var is structure and also has 
     1068    the name field given, then the latter will be the one chosen and not namevquick) 
     1069 
    10611070     
    10621071    <a name="#_write_ncdf_keyword_NOT_SDISV"></a> 
    … …  
    11071116 
    11081117 1) 
    1109  write_ncdf, vvsst, btoa 
     1118   IDL> write_ncdf, vvsst, btoa 
    11101119 
    11111120 2) 
    1112  write_ncdf, a1, {var:a2,name:'rain'}, ['up','down','fix'], a4, a5, {var:a6,unlim:1,name:'sst',dname:['x','y','z','time']} 
     1121   IDL> write_ncdf, a1, {var:a2,name:'rain'}, ['up','down','fix'], a4, a5, {var:a6,unlim:1,name:'sst',dname:['x','y','z','time']} 
    11131122 
    11141123 3) 
    1115  write_ncdf,v031tr,msf031dn,msf031up,v031,vmaskloc,btoa,runame,titplo1,vargrid,nytt                                    $ 
     1124   IDL> write_ncdf,v031tr,msf031dn,msf031up,v031,vmaskloc,btoa,runame,titplo1,vargrid,nytt                                    $ 
    11161125           ,varname = ['v031tr','msf031dn','msf031up','v031','vmaskloc','btoa','runame','titplo1','vargrid','nytt'] $ 
    11171126           ,filename = iodir+'IDL_DATA/'+'waza3.nc' 
    11181127 
    11191128 4) 
    1120  fileoutnc = iodir+'OBS/TRMM/'+'trmm_1d_'+iyystr+'0101_'+iyystr+'1231_reg0.25.nc' 
    1121  vv1 = {var:xaxis,name:'nav_lon',dname:'x',at1:{a:'units',b:'degrees_east'},at2:{a:'title',b:'longitude'}} 
    1122  vv2 = {var:yaxis,name:'nav_lat',dname:'y',at1:{a:'units',b:'degrees_north'},at2:{a:'title',b:'latitude'}} 
    1123  vv3 = {var:ttt,name:'time',dname:'time_counter',unlim:1,at1:{a:'units',b:timeunit},at2:{a:'title',b:'julian days'}  $ 
    1124  vv4 = {var:rain_i2, name:'rain'                                                                    $ 
    1125         ,at1:{a:'units',b:'mm/day'}                                                                  $ 
     1129   IDL> fileoutnc = iodir+'OBS/TRMM/'+'trmm_1d_'+iyystr+'0101_'+iyystr+'1231_reg0.25.nc' 
     1130   IDL> vv1 = {var:xaxis,name:'nav_lon',dname:'x',at1:{a:'units',b:'degrees_east'},at2:{a:'title',b:'longitude'}} 
     1131   IDL> vv2 = {var:yaxis,name:'nav_lat',dname:'y',at1:{a:'units',b:'degrees_north'},at2:{a:'title',b:'latitude'}} 
     1132   IDL> vv3 = {var:ttt,name:'time',dname:'time_counter',unlim:1,at1:{a:'units',b:timeunit},at2:{a:'title',b:'julian days'}  $ 
     1133   IDL> vv4 = {var:rain_i2, name:'rain' $ 
     1134        ,at1:{a:'units',b:'mm/day'} $ 
    11261135        ,at2:{a:'title',b:'trmm daily accumulated rainfall derived from the 3-hourly product (mm)'}  $ 
    1127         ,at3:{a:'scale_factor',b:scala_factor}                                                       $ 
    1128         ,at4:{a:'add_offset',b:adda_offset}                                                          $ 
    1129         ,at5:{a:'missing_value',b:missaval_i2}                                                       $ 
     1136        ,at3:{a:'scale_factor',b:scala_factor} $ 
     1137        ,at4:{a:'add_offset',b:adda_offset}    $ 
     1138        ,at5:{a:'missing_value',b:missaval_i2} $ 
    11301139       } 
    1131  glbatt={  gb1:{a:'File_Name', b:'trmm_1d_'+iyystr+'0101_'+iyystr+'1231_reg0.25.nc'}                                              $ 
    1132           ,gb2:{a:'Model_Name', b:'TRMM 3B42_V6 derived product'}                                                                  $ 
     1140   IDL> glbatt={  gb1:{a:'File_Name', b:'trmm_1d_'+iyystr+'0101_'+iyystr+'1231_reg0.25.nc'} $ 
     1141          ,gb2:{a:'Model_Name', b:'TRMM 3B42_V6 derived product'} $ 
    11331142          ,gb3:{a:'Source_File',b:'ftp://disc2.nascom.nasa.gov/data/TRMM/Gridded/Derived_Products/3B42_V6/Daily/'+iyystr+'/*.bin'} $ 
    11341143    </pre><h3>Version history</h3> 
    … …  
    11431152     
    11441153     
    1145     <h4>Todo items</h4> clem  
     1154    <h4>Todo items</h4>  
     1155 clem  
    11461156 
    11471157     
    … …  
    11511161     
    11521162    <h4>Uses routines</h4> 
    1153  cm_general --> pour la var iodir 
     1163 <a href="..//Commons/cm_general.html">cm_general</a> for iodir variable 
    11541164 
    11551165     
Note: See TracChangeset for help on using the changeset viewer.