Changeset 157 for trunk/SRC/ReadWrite


Ignore:
Timestamp:
08/21/06 11:01:50 (18 years ago)
Author:
navarro
Message:

header improvements + xxx doc

Location:
trunk/SRC/ReadWrite
Files:
16 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/ReadWrite/idl-NetCDF/ncdf_listdims.pro

    r134 r157  
     1;+ 
     2; @file_comments 
     3; 
     4; 
     5; @categories 
     6; 
     7; 
     8; @param NCID 
     9; 
     10; 
     11; @restrictions 
     12; 
     13; 
     14; @examples 
     15;  
     16;  
     17; @history 
     18; 
     19; 
     20; @version 
     21; $Id$ 
     22; 
     23;- 
    124FUNCTION ncdf_listdims,ncid 
    225; 

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

    r134 r157  
     1;+ 
     2; @file_comments 
     3; 
     4; 
     5; @categories 
     6; 
     7; 
     8; @param NCID 
     9;  
     10; 
     11; @returns 
     12; 
     13; 
     14; @restrictions 
     15; 
     16; 
     17; @examples 
     18;  
     19;  
     20; @history 
     21; 
     22; 
     23; @version 
     24; $Id$ 
     25; 
     26;- 
    127FUNCTION ncdf_listvars,ncid 
    228; 

  • trunk/SRC/ReadWrite/idl-NetCDF/ncdf_quickread/ncdf_quickread_helper.pro

    r134 r157  
    3737;                           Also, only stringify attributes of type CHAR. 
    3838;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 
    39  
     39;+ 
     40; @file_comments 
     41; This function returns the filename name from the full path. 
     42; 
     43; @categories 
     44; 
     45; 
     46; @param FULLPATH 
     47; full directory+file path 
     48; 
     49; @keyword SUFFIX 
     50; include inptu suffix in output file name 
     51; 
     52; @returns 
     53; file - filename 
     54; 
     55; @restrictions 
     56; 
     57; 
     58; @examples 
     59; Call: file = ncdf_quickread_getfile(fullpath) 
     60;  
     61; @history 
     62; 
     63; 
     64; @version 
     65; $Id$ 
     66;- 
    4067function ncdf_quickread_getFile, fullpath, suffix=suffix 
    4168on_error,2 
    4269compile_opt hidden 
    43 ; func_description 
    44 ; This function returns the filename name from the full path. 
    45 ; Inputs:    fullpath - full directory+file path 
    46 ; Keyword:   /suffix:   include inptu suffix in output file name 
    47 ; Outputs:   file - filename 
    48 ; Example Call: file = ncdf_quickread_getfile(fullpath) 
    49  
    5070; Retrieve the postion at which the first '/' character occurs from 
    5171; the end of the string. 
    … …  
    7393end 
    7494 
     95;+ 
     96; @file_comments 
     97; This function returns the directory name from the full path. 
     98; 
     99; @categories 
     100; 
     101; 
     102; @param FULLPATH 
     103; full directory+file path 
     104; 
     105; @returns 
     106; directory path 
     107; 
     108; @restrictions 
     109; 
     110; 
     111; @examples 
     112; Call: dir = ncdf_quickread_getdir(fullpath) 
     113;  
     114; @history 
     115; 
     116; 
     117; @version 
     118; $Id$ 
     119;- 
    75120 
    76121function ncdf_quickread_getDir, fullpath 
    77122on_error,2 
    78123compile_opt hidden 
    79 ; func_description 
    80 ; This function returns the directory name from the full path. 
    81 ; Inputs:   fullpath - full directory+file path 
    82 ; Outputs:  dir - directory path 
    83 ; Example Call: dir = ncdf_quickread_getdir(fullpath) 
    84  
    85124; Retrieve the postion at which the first '/' character occurs from 
    86125; the end of the string. 
    … …  
    97136end 
    98137 
    99  
    100 function ncdf_quickread_validateName, varname 
    101 on_error,2 
    102 compile_opt hidden 
    103 ; func_description 
     138;+ 
     139; @file_comments 
    104140; This routine ensures that the given name does not start with a number, 
    105141; nor contain a dash.  IDL cannot accept a variable starting with a  
    … …  
    107143; underscore is prepended to the name, and if it contains a dash, the  
    108144; dash is replaced with an underscore.   
     145; 
     146; @categories 
     147; 
     148; 
     149; @param VARNAME 
     150; The name of the variable to be read 
     151;  
     152; 
     153; @returns 
     154; 
     155; 
     156; @restrictions 
     157; 
     158; 
     159; @examples 
     160;  
     161;  
     162; @history 
     163; 
     164; 
     165; @version 
     166; $Id$ 
     167;- 
     168 
     169function ncdf_quickread_validateName, varname 
     170on_error,2 
     171compile_opt hidden 
    109172 
    110173; Initialize the name. 
    … …  
    138201; End function. 
    139202end 
    140  
    141  
     203;+ 
     204; @file_comments 
     205; This procedure creates a script to read the data in a given netCDF 
     206; file into IDL.  The default output file is the name of the netCDF 
     207; file with idl replacing any existing suffix.  The default output is 
     208; variable data only. 
     209; 
     210; @categories 
     211; 
     212; 
     213; @param INFILE 
     214; full path to netCDF file of interest 
     215; 
     216; @keyword VERBOSE   
     217; Set this keyword to return an error message in case of an error. 
     218; 
     219; @keyword PREFIX 
     220; see changelog above. 
     221; 
     222; @keyword FIELDS 
     223; 
     224; 
     225; @keyword REFORM 
     226; see changelog above.  
     227; 
     228; @returns 
     229; array of commands to run at top level 
     230; 
     231; @restrictions 
     232; 
     233; 
     234; @examples 
     235;  
     236;  
     237; @history 
     238; 
     239; 
     240; @version 
     241; $Id$ 
     242; 
     243;- 
    142244function ncdf_quickread_helper, infile, verbose=verbose,  $ 
    143245                                prefix=prefix, fields=fields, $ 
    … …  
    146248compile_opt hidden 
    147249; 
    148 ; This procedure creates a script to read the data in a given netCDF 
    149 ; file into IDL.  The default output file is the name of the netCDF 
    150 ; file with idl replacing any existing suffix.  The default output is 
    151 ; variable data only. 
    152 ; Inputs:           infile  - full path to netCDF file of interest 
    153 ; Optional Inputs:  verbose - includes extractions of all input file  
    154 ;                             attributes in idl script 
    155 ;                   prefix, reform - see changelog above. 
    156 ; 
    157 ; Return value:  array of commands to run at top level 
     250; 
    158251 
    159252; Ensure that the netCDF format is supported on the current platform. 

  • trunk/SRC/ReadWrite/idl-NetCDF/ncdf_quickwrite/ncdf_quickwrite_helper1.pro

    r134 r157  
     1;+ 
     2; @file_comments 
     3; 
     4; 
     5; @categories 
     6; 
     7; 
     8; @param NCVARSTRING 
     9; 
     10; 
     11; @param NCDFSTRUCT 
     12; 
     13; 
     14; @param STRUCTNAME 
     15;  
     16; 
     17; @returns 
     18; 
     19; 
     20; @restrictions 
     21; 
     22; 
     23; @examples 
     24;  
     25;  
     26; @history 
     27; 
     28; 
     29; @version 
     30; $Id$ 
     31; 
     32;- 
    133pro ncdf_quickwrite_helper1,ncvarstring,ncdfstruct,structname 
    234;; 

  • trunk/SRC/ReadWrite/idl-NetCDF/ncdf_quickwrite/ncdf_quickwrite_helper2.pro

    r134 r157  
    1414;; we use this function enough to give it a short name, but the underscore 
    1515;; is to make it unlikely to conflict with a user's function. 
    16  
     16;+ 
     17; @file_comments 
     18; 
     19; 
     20; @categories 
     21; 
     22; 
     23; @param STRING 
     24; String to be split. Contains text after in, out token on output. 
     25;  
     26; 
     27; @returns 
     28; 
     29; 
     30; @restrictions 
     31; 
     32; 
     33; @examples 
     34;  
     35;  
     36; @history 
     37; 
     38; 
     39; @version 
     40; $Id$ 
     41; 
     42;- 
    1743function _str,string 
    1844return,strcompress(string,/remove_all) 
    … …  
    2046 
    2147;------------------------------------------------------ 
     48;+ 
     49; @file_comments 
     50; 
     51; 
     52; @categories 
     53; 
     54; 
     55; @param NUM 
     56; 
     57; 
     58; @param NAME 
     59; It is a string giving the name of the file to be opened. If NAME does not contain 
     60; the separating character of directories ('/' under unix for example), the file 
     61; will be looked for in the current directory. 
     62;  
     63; 
     64; @returns 
     65; 
     66; 
     67; @restrictions 
     68; 
     69; 
     70; @examples 
     71;  
     72;  
     73; @history 
     74; 
     75; 
     76; @version 
     77; $Id$ 
     78; 
     79;- 
    2280function ncdf_quickwrite_typename,num,name 
    2381on_error,2 
    … …  
    63121;----------------------------------------------------- 
    64122 
     123;+ 
     124; @file_comments 
     125; 
     126; 
     127; @categories 
     128; 
     129; 
     130; @param NCFILENAME 
     131; 
     132; 
     133; @param S 
     134; The string to be searched 
     135; 
     136; @param SNAME 
     137;  
     138; 
     139; @returns 
     140; 
     141; 
     142; @restrictions 
     143; 
     144; 
     145; @examples 
     146;  
     147;  
     148; @history 
     149; 
     150; 
     151; @version 
     152; $Id$ 
     153; 
     154;- 
    65155 
    66156pro ncdf_quickwrite_helper2,ncfilename,s,sname 

  • trunk/SRC/ReadWrite/idl-NetCDF/ncdf_quickwrite/ncdf_quickwrite_helper3.pro

    r134 r157  
     1;+ 
     2; @file_comments 
     3; 
     4; 
     5; @categories 
     6; 
     7; 
     8; @param S 
     9; The string to be searched 
     10;  
     11; 
     12; @returns 
     13; 
     14; 
     15; @restrictions 
     16; 
     17; 
     18; @examples 
     19;  
     20;  
     21; @history 
     22; 
     23; 
     24; @version 
     25; $Id$ 
     26; 
     27;- 
    128pro ncdf_quickwrite_helper3,s 
    229;; 

  • trunk/SRC/ReadWrite/idl-NetCDF/ncdf_read.pro

    r134 r157  
     1;+ 
     2; @file_comments 
     3; 
     4; 
     5; @categories 
     6; 
     7; 
     8; @param FILENAME 
     9; The filename 
     10; 
     11; @param INFO 
     12; General info 
     13; 
     14; @param DINFO 
     15; Dimension info 
     16;  
     17; @param VINFO 
     18; Variable info 
     19; 
     20; @param GATTS 
     21; Global attributes 
     22; 
     23; @param VATTS 
     24; Variable attributes 
     25; 
     26; @param DATA 
     27; Data 
     28;  
     29; 
     30; @returns 
     31; 
     32; 
     33; @restrictions 
     34; 
     35; 
     36; @examples 
     37;  
     38;  
     39; @history 
     40; 
     41; 
     42; @version 
     43; $Id$ 
     44; 
     45;- 
    146PRO ncdf_read,filename,info,dinfo,vinfo,gatts,vatts,data 
    247;             -------- ---- ----- ----- ----- ----- ---- 

  • trunk/SRC/ReadWrite/idl-NetCDF/ncdf_struct.pro

    r134 r157  
     1;+ 
     2; @file_comments 
     3; 
     4; 
     5; @categories 
     6; 
     7; 
     8; @param FILENAME 
     9; The file's name 
     10;  
     11; @keyword NODATA 
     12; 
     13; 
     14; @keyword NOATTRIBUTES 
     15;  
     16; 
     17; @returns 
     18; 
     19; 
     20; @restrictions 
     21; 
     22; 
     23; @examples 
     24;  
     25;  
     26; @history 
     27; 
     28; 
     29; @version 
     30; $Id$ 
     31; 
     32;- 
    133FUNCTION ncdf_struct,filename,nodata=nodata,noattributes=noattributes 
    234; 

  • trunk/SRC/ReadWrite/idl-NetCDF/ncdf_struct_free.pro

    r134 r157  
     1;+ 
     2; @file_comments 
     3; 
     4; 
     5; @categories 
     6; 
     7; 
     8; @param S 
     9; The string to be searched 
     10;  
     11; 
     12; @returns 
     13; 
     14; 
     15; @restrictions 
     16; 
     17; 
     18; @examples 
     19;  
     20;  
     21; @history 
     22; 
     23; 
     24; @version 
     25; $Id$ 
     26; 
     27;- 
    128PRO ncdf_struct_free,s 
    229; 

  • trunk/SRC/ReadWrite/ncdf_timeget.pro

    r136 r157  
    77; Julian days of IDL. 
    88; 
    9 ; @categories reading ncdf_file 
     9; @categories  
     10; Reading 
    1011; 
    1112; @param cdfid {in}{required} 

  • trunk/SRC/ReadWrite/read_grads.pro

    r150 r157  
    77; from the grads control file even if there is multiple data files. 
    88; 
    9 ; @categories reading function 
     9; @categories  
     10; Reading 
    1011; 
    1112; @param var {in}{required} 
    … …  
    2122; the grads control file name: 'xxxx.ctl' 
    2223; 
    23 ; @file_comments 
    24 ; keyword GLAMBOUNDARY (via computegrid.pro) a 2 elements vector, 
    25 ; {lon1,lon2], giving the longitude boundaries that should be 
    26 ; used to visualize the data. 
    27 ;         lon2 > lon1 
    28 ;         lon2 - lon1 eq 360 
    29 ; key_shift will be automatically defined according to GLAMBOUNDARY. 
    30 ; 
    3124; @keyword TIMESTEP 
    3225; to specify that the dates are time steps instead of true calendar. 
    33 ; 
    34 ; @file_comments 
    35 ; keyword IODIRECTORY 
    36 ; a string giving the name of iodirectory 
    37 ; (see isafile.pro for all possibilities). 
    38 ; default value is common variable iodir 
    3926; 
    4027;--------------- 
    … …  
    4229;--------------- 
    4330; 
    44 ;       BOX a 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1, 
    45 ;       depth2], that specifies the area where data must be read 
    46 ; 
    47 ;       EVERYTHING 
    48 ; 
    49 ;       NOSTRUCTURE 
     31; @keyword BOX 
     32; A 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1, 
     33; depth2], that specifies the area where data must be read 
     34; 
     35; @keyword EVERYTHING 
     36; 
     37; 
     38; @keyword NOSTRUCT 
     39; 
     40; 
     41; @keyword _EXTRA 
     42; Used to pass your keywords 
    5043; 
    5144; @returns 
    5245; an array 
    5346; 
    54 ; @uses common 
     47; @uses  
     48; common 
    5549; 
    5650; @restriction 
    … …  
    6660; IDL> plt, a 
    6761; 
    68 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    69 ; 
    70 ; @version $Id$ 
     62; @history  
     63; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     64; 
     65; @version 
     66; $Id$ 
    7167; 
    7268;- 

  • trunk/SRC/ReadWrite/read_oasis.pro

    r136 r157  
    66; read the f77 unformatted files used in Oasis (version < 2.5) 
    77; 
    8 ; @categories reading 
     8; @categories 
     9; Reading 
    910; 
    1011; @param filename {in}{required}  

  • trunk/SRC/ReadWrite/readbat.pro

    r130 r157  
    66; reading the bathymetry ASCII file of OPA 
    77; 
    8 ; @categories for OPA 
     8; @categories 
     9; For OPA 
    910; 
    1011; @param filename {in}{required} a string containing the filename, 

  • trunk/SRC/ReadWrite/readoldopadistcoast.pro

    r136 r157  
    88; based on the OPA subroutines dtacof and parctl 
    99; 
    10 ; @categories for OPA before NetCDF 
     10; @categories  
     11; For OPA 
     12; 
     13; @param UNIT 
     14; 
     15; 
     16; @param PARAMS 
     17;  
     18;  
     19; @param NUM 
     20;  
    1121; 
    1222; @returns   
    … …  
    3444 
    3545;+ 
    36 ; @param filename {in}{required} filename (with the whole path if necessary) 
    37 ; @param jpiglo {in}{required} 
    38 ; @param jpjglo {in}{required} 
    39 ; @param jpk {in}{required} 
    40 ; dimensions of the opa grid 
     46; @file_comments 
    4147; 
    42 ; @keyword IBLOC {default=4096L} ibloc size 
    43 ; @keyword JPBYT {default=8L} jpbyt size 
    44 ; @keyword NUMREC {default=19L*jpk} number of records in the file. 
    4548; 
    46 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     49; @categories 
     50; For OPA 
     51; 
     52; @param FILENAME {in}{required} 
     53; Filename (with the whole path if necessary) 
     54; 
     55; @param JPIGLO {in}{required} 
     56; 
     57; 
     58; @param JPJGLO {in}{required} 
     59; 
     60; 
     61; @param JPK {in}{required} 
     62; Dimensions of the opa grid 
     63; 
     64; @keyword IBLOC {default=4096L} 
     65; Ibloc size 
     66;  
     67; @keyword JPBYT {default=8L} 
     68; Jpbyt size 
     69;  
     70; @keyword NUMREC {default=19L*jpk} 
     71; Number of records in the file. 
     72; 
     73; @history 
     74; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    4775;                      June, 2002 
     76; 
     77; @version 
     78; $Id$ 
    4879;- 
    4980FUNCTION readoldopadistcoast, filename, jpiglo, jpjglo, jpk, IBLOC = ibloc, JPBYT = jpbyt, NUMREC = numrec 

  • trunk/SRC/ReadWrite/readoldoparestart.pro

    r136 r157  
    44;+ 
    55; 
    6 ; @categories for OPA before NetCDF 
     6; @categories 
     7; For OPA 
     8; 
     9; @param UNIT 
     10; 
     11; 
     12; @param PARAMS 
     13;  
     14;  
     15; @param NUM 
     16;  
    717; 
    818; @restrictions  
    … …  
    2737end 
    2838;+ 
     39; @categories 
     40; For OPA 
     41; 
     42; @param UNIT 
     43; 
     44; 
     45; @param PARAMS 
     46;  
     47;  
     48; @param NUM 
     49;  
     50; 
    2951; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    3052;                      June 2002 
    … …  
    4466; based on the OPA subroutine dtrlec included at the end of the file. 
    4567; 
    46 ; @categories for OPA before NetCDF 
     68; @categories  
     69; For OPA 
    4770; 
    4871; @param filename {in}{required} 
    … …  
    5073; 
    5174; @param jpiglo {in}{required} 
     75;  
     76;  
    5277; @param jpjglo {in}{required} 
     78;  
     79;  
    5380; @param jpk {in}{required} 
    5481; dimensions of the opa grid 
    5582; 
    56 ; @keyword IBLOC {default=4096L} ibloc size 
    57 ; @keyword JPBYT {default=8L} jpbyt size 
    58 ; @keyword NUMREC {default=19L*jpk} number of records in the file 
     83; @keyword IBLOC {default=4096L}  
     84; Ibloc size 
     85;  
     86; @keyword JPBYT {default=8L} 
     87; Jpbyt size 
     88;  
     89; @keyword NUMREC {default=19L*jpk}  
     90; Number of records in the file 
     91;  
    5992; @keyword UB 
     93;  
     94;  
    6095; @keyword VB 
     96;  
     97;  
    6198; @keyword TB 
     99;  
     100;  
    62101; @keyword SB 
     102;  
     103;  
    63104; @keyword ROTB 
     105;  
     106;  
    64107; @keyword HDIVB 
     108;  
     109;  
    65110; @keyword UN 
     111;  
     112;  
    66113; @keyword VN 
     114;  
     115;  
    67116; @keyword TN 
     117;  
     118;  
    68119; @keyword SN 
     120;  
     121;  
    69122; @keyword ROTN 
     123;  
     124;  
    70125; @keyword HDIVN 
     126;  
     127;  
    71128; @keyword GCX 
     129;  
     130;  
    72131; @keyword GCXB 
     132;  
     133;  
    73134; @keyword ETAB 
     135;  
     136;  
    74137; @keyword ETAN 
     138;  
     139;  
    75140; @keyword BSFB 
     141;  
     142;  
    76143; @keyword BSFN 
     144;  
     145;  
    77146; @keyword BSFD 
     147;  
     148;  
    78149; @keyword EN 
    79150; the variable we want to read. 
    80151; 
    81 ; @returns according to the given keywords. 
    82 ; @restrictions bug for etab and etan written on the same record??? 
    83 ; 
    84 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     152; @returns  
     153; According to the given keywords. 
     154;  
     155; @restrictions  
     156; Bug for etab and etan written on the same record??? 
     157; 
     158; @history  
     159; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    85160;                      June 2002 
    86 ; @version $Id$ 
     161;  
     162; @version 
     163; $Id$ 
    87164;- 
    88165 

  • trunk/SRC/ReadWrite/writebat.pro

    r136 r157  
    77; write the bathymetry ASCII file of OPA 
    88; 
    9 ; @categories for OPA 
     9; @categories  
     10; For OPA 
    1011; 
    1112; @param zbat {in}{required}  
Note: See TracChangeset for help on using the changeset viewer.