Changeset 136 for trunk/SRC/ReadWrite


Ignore:
Timestamp:
07/10/06 17:20:19 (18 years ago)
Author:
pinsard
Message:

some improvements and corrections in some .pro file according to
aspell and idldoc log file

Location:
trunk/SRC/ReadWrite
Files:
9 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/ReadWrite/ncdf_timeget.pro

    r130 r136  
    44;+ 
    55; @file_comments 
    6 ; get the time axis fom a netcdf_file and transforms it in 
    7 ; julian days of IDL. 
     6; get the time axis from a netcdf_file and transforms it in 
     7; Julian days of IDL. 
    88; 
    99; @categories reading ncdf_file 
    … …  
    1616; 
    1717; @keyword YYYYMMDD 
    18 ; active to obtain the date as a longinterger with 
     18; active to obtain the date as a long integer with 
    1919; the format YearYearYearYearMonthMonthDayDay 
    2020; 
    … …  
    2323; 
    2424; @returns 
    25 ; a long array of IDL julian days 
     25; a long array of IDL Julian days 
    2626; 
    2727; @restrictions 
    2828; the calendar variable must have the units attribute 
    29 ; following the syntaxe bellow: 
     29; following the syntax bellow: 
    3030; 
    3131; time_counter:units = "seconds since 0001-01-01 00:00:00" ; 

  • trunk/SRC/ReadWrite/read_grads.pro

    r130 r136  
    1616; 
    1717; @param date2 {in}{optional} 
    18 ; last date. Optionnal, if not scpecified date2=date1 
     18; last date. Optional, if not specified date2=date1 
    1919; 
    2020; @keyword FILENAME 
    … …  
    141141   varid = varid[0] 
    142142   if varid EQ -1 then begin 
    143       print, var+' not found in the variable liste of '+filename 
     143      print, var+' not found in the variable list of '+filename 
    144144      return,  -1 
    145145   ENDIF 
    … …  
    149149;------------------------ 
    150150;------------------------ 
    151 ; find the first file to be read according to the lile list,, the 
     151; find the first file to be read according to the file list, the 
    152152; number of time step in each file and t1 and t2 
    153153;------------------------ 
    … …  
    164164;------------------------ 
    165165;------------------------; 
    166 ; check the existance of the file 
     166; check the existence of the file 
    167167   f2read = isafile(filename = f2read, iodirectory = iodir, _EXTRA = ex) 
    168168; if the file is stored on tape 
    … …  
    306306   triangles_list = triangule() 
    307307;------------------------ 
    308 ; subdomain extration 
     308; subdomain extraction 
    309309 
    310310;------------------------ 
    311 ; time aguments 
     311; time arguments 
    312312;------------------------ 
    313313   time = time[t1:t2] 

  • trunk/SRC/ReadWrite/read_oasis.pro

    r130 r136  
    44;+ 
    55; @file_comments 
    6 ; read the f77 unformated files used in Oasis (version < 2.5) 
     6; read the f77 unformatted files used in Oasis (version < 2.5) 
    77; 
    88; @categories reading 
    99; 
    10 ; @param filename {in}{required} the filename 
     10; @param filename {in}{required}  
     11; the filename 
    1112; 
    12 ; @param varname {in}{required} the name of the variable to be read 
     13; @param varname {in}{required}  
     14; the name of the variable to be read 
    1315; 
    1416; @param jpi {in}{required} 

  • trunk/SRC/ReadWrite/readoldopadistcoast.pro

    r130 r136  
    1010; @categories for OPA before NetCDF 
    1111; 
    12 ; @returns  a structure that contains two elements: tdistcoast (the 
     12; @returns   
     13; a structure that contains two elements: tdistcoast (the 
    1314; distance for the t-points) and fdiscoast (the distance for the 
    1415; f-points). 

  • trunk/SRC/ReadWrite/readoldoparestart.pro

    r130 r136  
    66; @categories for OPA before NetCDF 
    77; 
    8 ; @restrictions bug for etab and etan written on the same record??? 
     8; @restrictions  
     9; bug for etab and etan written on the same record??? 
    910; 
    1011; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    … …  
    210211;CC   ------- 
    211212;CC      Read the previous fields on the file numrst 
    212 ;CC      the first record indicates previous characterics 
     213;CC      the first record indicates previous characteristics 
    213214;CC      after control with the present run, we read : 
    214215;CC      - prognostic variables on the second record 

  • trunk/SRC/ReadWrite/scanctl.pro

    r130 r136  
    146146;------------------------ 
    147147; initial date: y0, m0, d0, h0, mn0 
    148 ;             -> julian day of IDL: julady(m0, d0, y0, h0, mn0, 00) 
     148;             -> Julian day of IDL: julday(m0, d0, y0, h0, mn0, 00) 
    149149;------------------------ 
    150150   t0 = timedef[3] 
    … …  
    197197   ENDCASE 
    198198;------------------------ 
    199 ; increment date and definition of the calendar with IDL julian days 
     199; increment date and definition of the calendar with IDL Julian days 
    200200;------------------------ 
    201201   tstep = timedef[4] 
    … …  
    241241   files = strsplit(files,/extract) 
    242242   if n_elements(files) NE 2 then begin 
    243       print, 'Bad definition of the filename. There shoud be 2 elements:' 
     243      print, 'Bad definition of the filename. There should be 2 elements:' 
    244244      print, 'DEST and 1 filename (that may define many files)' 
    245245      stop 

  • trunk/SRC/ReadWrite/scanoasis.pro

    r130 r136  
    88; @categories know what is inside 
    99; 
    10 ; @param filename {in}{required} the file name 
     10; @param filename {in}{required}  
     11; the file name 
    1112; 
    12 ; @restrictions List the variable names included in a Oasis file 
     13; @restrictions  
     14; List the variable names included in a Oasis file 
    1315; 
    1416; @examples 

  • trunk/SRC/ReadWrite/write_oasis.pro

    r130 r136  
    77; write an Oasis file (version < 2.5) 
    88; 
    9 ; @param filename {in}{required} the filename 
    10 ; @param varname {in}{required} the name of the variable to be written 
    11 ; @param z2d {in}{required} the variable (2D array) to be written 
     9; @param filename {in}{required}  
     10; the filename 
     11; 
     12; @param varname {in}{required}  
     13; the name of the variable to be written 
     14; 
     15; @param z2d {in}{required}  
     16; the variable (2D array) to be written 
    1217; 
    1318; @keyword I2 
    … …  
    1722; to change the default format (R8) of the data to be written. 
    1823; 
    19 ; @keyword APPEND to open the file with the file pointer at the end of 
    20 ;        the file, ready for data to be appended. 
     24; @keyword APPEND  
     25; to open the file with the file pointer at the end of the file, ready for  
     26; data to be appended. 
    2127; 
    22 ; 
    23 ; @restrictions varname is automatically written as a "charactere*8" 
    24 ;              by default z2d is written as an R8 array 
     28; @restrictions  
     29; varname is automatically written as a "character*8" 
     30; by default z2d is written as an R8 array 
    2531; 
    2632; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 

  • trunk/SRC/ReadWrite/writebat.pro

    r130 r136  
    99; @categories for OPA 
    1010; 
    11 ; @param zbat {in}{required} the bathymetry, a 2d array 
    12 ; @param filename {in}{required} a string containing the filename, 
     11; @param zbat {in}{required}  
     12; the bathymetry, a 2d array 
     13; 
     14; @param filename {in}{required}  
     15; a string containing the filename 
    1316; 
    1417; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    … …  
    2427; basic checks 
    2528  IF n_params() NE 2 THEN BEGIN 
    26     print, 'bad number of aguments in the call of writebat' 
     29    print, 'bad number of arguments in the call of writebat' 
    2730    return 
    2831  ENDIF 
Note: See TracChangeset for help on using the changeset viewer.