Changeset 371 for trunk/SRC/ReadWrite

Timestamp:

08/07/08 11:32:02 (16 years ago)

Author:

pinsard

Message:

improvements of headers (alignments of IDL prompt in examples)

Location:

trunk/SRC/ReadWrite

Files:

• idl-NetCDF/ncdf_listvars.pro (modified) (1 diff)
• ncdf_getatt.pro (modified) (1 diff)
• ncdf_getmask.pro (modified) (1 diff)
• read_oasis.pro (modified) (1 diff)
• scanoasis.pro (modified) (1 diff)
• write_ncdf.pro (modified) (2 diffs)

trunk/SRC/ReadWrite/idl-NetCDF/ncdf_listvars.pro

@@ -16 +16 @@
 ;
 ; @examples
-; IDL> varnames = ncdf_listvars('toto.nc')
+;
+;   IDL> varnames = ncdf_listvars('toto.nc')
+;
 ;   or
-; IDL> i=ncdf_open('toto.nc')
-; IDL> varnames = ncdf_listvars(id)
+;
+;   IDL> i=ncdf_open('toto.nc')
+;   IDL> varnames = ncdf_listvars(id)
 ; 
 ; @history

trunk/SRC/ReadWrite/ncdf_getatt.pro

@@ -62 +62 @@
 ;
 ; @examples
-; IDL> ncdf_getatt, cdfid, 'sst', add_offset = add_offset, scale_factor = scale_factor, units = units
+;
+;   IDL> ncdf_getatt, cdfid, 'sst', add_offset = add_offset, scale_factor = scale_factor, units = units
 ;
 ; @history

trunk/SRC/ReadWrite/ncdf_getmask.pro

@@ -62 +62 @@
 ; @examples
 ;
-; IDL> mask = ncdf_getmask('HadISST1_1m_187001_200702_sst_reg1m.nc',useasmask = 'sst', missing_value = -1.00000e+30)
+;   IDL> mask = ncdf_getmask('HadISST1_1m_187001_200702_sst_reg1m.nc',useasmask = 'sst', missing_value = -1.00000e+30)
 ;
-; IDL> mask = ncdf_getmask('meshmaskORCA2.nc', maskname = 'tmask')
+;   IDL> mask = ncdf_getmask('meshmaskORCA2.nc', maskname = 'tmask')
 ;
-; IDL> mask = ncdf_getmask('t106.nc', useasmask = 'SLM', testop = 'le 0.5')
+;   IDL> mask = ncdf_getmask('t106.nc', useasmask = 'SLM', testop = 'le 0.5')
 ;
 ; @history

trunk/SRC/ReadWrite/read_oasis.pro

@@ -28 +28 @@
 ;
 ; @examples
-; IDL> a=read_oasis('grids_orca_t106','a106.lon',320,160)
-; IDL> m=read_oasis('masks_orca_t106','or1t.msk',182,149,/i4)
 ;
-; see also IDL> scanoasis,'grids_orca_t106'
+;   IDL> a=read_oasis('grids_orca_t106','a106.lon',320,160)
+;   IDL> m=read_oasis('masks_orca_t106','or1t.msk',182,149,/i4)
+;
+; see also 
+;
+;   IDL> scanoasis,'grids_orca_t106'
 ;
 ; @history

trunk/SRC/ReadWrite/scanoasis.pro

@@ -13 +13 @@
 ;
 ; @examples
-; IDL> scanoasis,'grids_orca_t106'
+;
+;   IDL> scanoasis,'grids_orca_t106'
 ;
 ; @history

trunk/SRC/ReadWrite/write_ncdf.pro

@@ -574 +574 @@
 ;
 ; @uses
-; cm_general --> pour la var iodir
+; <pro>cm_general</pro> for iodir variable
 ;
 ; @examples
 ;
 ; 1)
-; write_ncdf, vvsst, btoa
+;   IDL> write_ncdf, vvsst, btoa
 ;
 ; 2)
-; write_ncdf, a1, {var:a2,name:'rain'}, ['up','down','fix'], a4, a5, {var:a6,unlim:1,name:'sst',dname:['x','y','z','time']}
+;   IDL> write_ncdf, a1, {var:a2,name:'rain'}, ['up','down','fix'], a4, a5, {var:a6,unlim:1,name:'sst',dname:['x','y','z','time']}
 ;
 ; 3)
-; write_ncdf,v031tr,msf031dn,msf031up,v031,vmaskloc,btoa,runame,titplo1,vargrid,nytt                                    $
+;   IDL> write_ncdf,v031tr,msf031dn,msf031up,v031,vmaskloc,btoa,runame,titplo1,vargrid,nytt                                    $
 ;           ,varname = ['v031tr','msf031dn','msf031up','v031','vmaskloc','btoa','runame','titplo1','vargrid','nytt'] $
 ;           ,filename = iodir+'IDL_DATA/'+'waza3.nc'
 ;
 ; 4)
-; fileoutnc = iodir+'OBS/TRMM/'+'trmm_1d_'+iyystr+'0101_'+iyystr+'1231_reg0.25.nc'
-; vv1 = {var:xaxis,name:'nav_lon',dname:'x',at1:{a:'units',b:'degrees_east'},at2:{a:'title',b:'longitude'}}
-; vv2 = {var:yaxis,name:'nav_lat',dname:'y',at1:{a:'units',b:'degrees_north'},at2:{a:'title',b:'latitude'}}
-; vv3 = {var:ttt,name:'time',dname:'time_counter',unlim:1,at1:{a:'units',b:timeunit},at2:{a:'title',b:'julian days'}  $
-; vv4 = {var:rain_i2, name:'rain'                                                                     $
-;        ,at1:{a:'units',b:'mm/day'}                                                                  $
+;   IDL> fileoutnc = iodir+'OBS/TRMM/'+'trmm_1d_'+iyystr+'0101_'+iyystr+'1231_reg0.25.nc'
+;   IDL> vv1 = {var:xaxis,name:'nav_lon',dname:'x',at1:{a:'units',b:'degrees_east'},at2:{a:'title',b:'longitude'}}
+;   IDL> vv2 = {var:yaxis,name:'nav_lat',dname:'y',at1:{a:'units',b:'degrees_north'},at2:{a:'title',b:'latitude'}}
+;   IDL> vv3 = {var:ttt,name:'time',dname:'time_counter',unlim:1,at1:{a:'units',b:timeunit},at2:{a:'title',b:'julian days'}  $
+;   IDL> vv4 = {var:rain_i2, name:'rain' $
+;        ,at1:{a:'units',b:'mm/day'} $
 ;        ,at2:{a:'title',b:'trmm daily accumulated rainfall derived from the 3-hourly product (mm)'}  $
-;        ,at3:{a:'scale_factor',b:scala_factor}                                                       $
-;        ,at4:{a:'add_offset',b:adda_offset}                                                          $
-;        ,at5:{a:'missing_value',b:missaval_i2}                                                       $
+;        ,at3:{a:'scale_factor',b:scala_factor} $
+;        ,at4:{a:'add_offset',b:adda_offset}    $
+;        ,at5:{a:'missing_value',b:missaval_i2} $
 ;       }
-; glbatt={  gb1:{a:'File_Name', b:'trmm_1d_'+iyystr+'0101_'+iyystr+'1231_reg0.25.nc'}                                               $
-;          ,gb2:{a:'Model_Name', b:'TRMM 3B42_V6 derived product'}                                                                  $
+;   IDL> glbatt={  gb1:{a:'File_Name', b:'trmm_1d_'+iyystr+'0101_'+iyystr+'1231_reg0.25.nc'} $
+;          ,gb2:{a:'Model_Name', b:'TRMM 3B42_V6 derived product'} $
 ;          ,gb3:{a:'Source_File',b:'ftp://disc2.nascom.nasa.gov/data/TRMM/Gridded/Derived_Products/3B42_V6/Daily/'+iyystr+'/*.bin'} $
 ;          ,gb4:{a:'IDL_Program_Name', b:'zz08_read_plot_row_trmm_precip.pro (clement@jamstec.go.jp)'}                              $
-;          ,gb5:{a:'Grid', b:'regular 0.25 degres resolution'}                                                                      $
+;          ,gb5:{a:'Grid', b:'regular 0.25 degres resolution'}$
 ;        }
-; write_ncdf, vv1, vv2, vv3, vv4, filename=fileoutnc, globattr=glbatt 
-;
+;   IDL> write_ncdf, vv1, vv2, vv3, vv4, filename=fileoutnc, globattr=glbatt 
 ;
 ; @side effects
@@ -615 +614 @@
 ; CBM 2007-09-10
 ; 
-; @todo clem 
+; @todo 
+; clem 
 ;
 ;-