Changeset 103 for trunk/SRC/Grid


Ignore:
Timestamp:
06/12/06 14:12:53 (18 years ago)
Author:
pinsard
Message:

start to modify headers of Grid .pro files for better idldoc output

Location:
trunk/SRC/Grid
Files:
11 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Grid/computegrid.pro

    r74 r103  
    33;------------------------------------------------------------ 
    44;+ 
    5 ; NAME:computegrid 
    6 ; 
    7 ; PURPOSE:compute the grid parameters from cm_4mesh common: 
     5; 
     6; @file_comments compute the grid parameters from cm_4mesh common: 
     7; 
     8;       computegrid, startx, starty, stepx, stepy, nx, ny 
     9;       computegrid, startx, starty, stepx, stepy 
     10;       computegrid, xaxis = xaxis, yaxis = yaxis 
     11;       or a suitable mix... 
    812; 
    913; horizontal parameters: 
    … …  
    2428;       key_stride, key_onearth, key_partialstep 
    2529; 
    26 ; CATEGORY:grid 
    27 ; 
    28 ; CALLING SEQUENCE: 
    29 ; 
    30 ;       computegrid, startx, starty, stepx, stepy, nx, ny 
    31 ;       computegrid, startx, starty, stepx, stepy 
    32 ;       computegrid, xaxis = xaxis, yaxis = yaxis 
    33 ;       or a suitable mix... 
    34 ;  
    35 ; INPUTS:  
    36 ;       startx:scalar, x starting point 
    37 ;       starty:scalar, y starting point 
    38 ;       stepx:scalar or vector: x direction step, must be > 0 
     30; @categories grid 
     31; 
     32;       @param startx {in}{required} scalar, x starting point 
     33;       @param starty {in}{required} scalar, y starting point 
     34;       @param stepxin {in}{required} scalar or vector: x direction step, must be > 0 
    3935;             if vector nx is not used 
    40 ;       stepy:scalar or vector: y direction step,  
     36;       @param stepyin {in}{required} scalar or vector: y direction step,  
    4137;             could be > 0 (south to north) or < 0 (north to south) 
    4238;             if vector ny is not used 
    43 ;       nx:scalar, number of points in x direction  
    44 ;       ny:scalar, number of points in y direction 
    45 ; 
    46 ; KEYWORD PARAMETERS: 
    47 ; 
    48 ;       /FULLCGRID: activate to specify that you want to compute 
     39;       @param nxin {in}{required} scalar, number of points in x direction  
     40;       @param nyin {in}{required} scalar, number of points in y direction 
     41; 
     42;       @keyword /FULLCGRID activate to specify that you want to compute 
    4943;       all the paremeters of a C grid. Computation of glam[uv], 
    5044;       gphi[uv], e1[uvf], e2[uvf], [uv]maskred and fmaskred[xy] 
    5145;       will be add to the default computations 
    5246; 
    53 ;       GLAMBOUNDARY: a 2 elements vector, [lon1,lon2], the longitute 
     47;       @keyword GLAMBOUNDARY a 2 elements vector, [lon1,lon2], the longitute 
    5448;       boundaries that should be used to visualize the data. 
    5549;       we must have lon2 > lon1 and lon2 - lon1 le 360 
    … …  
    5852;       key_shift will /= 0 only if key_periodic = 1  
    5953; 
    60 ;       MASK: to specify the mask with a 2 or 3 dimension array 
    61 ; 
    62 ;       ONEARTH = 0 or 1: to force the manual definition of 
     54;       @keyword MASK to specify the mask with a 2 or 3 dimension array 
     55; 
     56;       @keyword ONEARTH = 0 or 1 to force the manual definition of 
    6357;       key_onearth (to specify if the data are on earth -> use longitude 
    6458;       /latitude etc...). By default, key_onearth = 1. 
    … …  
    6660;       and is cancelling GLAMBOUNDARY 
    6761; 
    68 ;       PERIODIC = 0 or 1: to force the manual definition of 
     62;       @keyword PERIODIC = 0 or 1 to force the manual definition of 
    6963;       key_periodic. By default, key_periodic is automaticaly 
    7064;       computed by using the first line of glamt.  
    7165; 
    72 ;       /PLAIN: force PERIODIC = 0, SHIFT = 0, STRIDE = [1, 1, 1] and 
     66;       @keyword /PLAIN force PERIODIC = 0, SHIFT = 0, STRIDE = [1, 1, 1] and 
    7367;       suppress the automatic redefinition of the domain in case of  
    7468;       x periodicity overlap, y periodicity overlap (ORCA type only) 
    7569;       and mask border to 0. 
    7670; 
    77 ;       SHIFT = scalar to force the manual definition of key_shift. By 
     71;       @keyword SHIFT = scalar to force the manual definition of key_shift. By 
    7872;       debault, key_shift is automaticaly computed according to 
    7973;       glamboundary (when defined) by using the FIRST LINE of glamt. if 
    8074;       key_periodic=0 then in any case key_shift = 0.  
    8175; 
    82 ;       STRCALLING: a string containing the calling command used to 
     76;       @keyword STRCALLING a string containing the calling command used to 
    8377;       call computegrid (this is used by xxx.pro) 
    8478; 
    85 ;       STRIDE = : a 3 elements vector to specify the stride in x, y, z 
     79;       @keyword STRIDE a 3 elements vector to specify the stride in x, y, z 
    8680;       direction. Default definition is [1, 1, 1]. The resulting value 
    8781;       will be stored in the common (cm_4mesh) variable key_stride 
    8882; 
    89 ;       XAXIS: to specify longitude1 with a 1 or 2 dimension array, in  
     83;       @keyword XAXIS to specify longitude1 with a 1 or 2 dimension array, in  
    9084;       this case startx, stepx and nx are not used but could be 
    9185;       necessary if the y axis is not defined with yaxis. It must be 
    … …  
    9387;       order by shifting its elements. 
    9488; 
    95 ;       YAXIS: to specify latitudes with a 1 or 2 dimension array, in  
     89;       @keyword YAXIS to specify latitudes with a 1 or 2 dimension array, in  
    9690;       this case starty, stepy and ny are not used but starty and 
    9791;       stepy could be necessary if the x axis is not defined with xaxis. 
    … …  
    9993;       (along each column if 2d array). 
    10094; 
    101 ;       /XYINDEX: activate to specify that the horizontal grid should  
     95;       @keyword /XYINDEX activate to specify that the horizontal grid should  
    10296;       be simply defined by using the index of the points 
    10397;          (xaxis = findgen(nx) and yaxis = findgen(ny)) 
    10498;       using this keyword forces key_onearth=0 
    10599; 
    106 ;       [XYZ]MINMESH: to define the common variables i[xyz]minmesh 
     100;       @keyword XMINMESH  
     101;       @keyword YMINMESH  
     102;       @keyword ZMINMESH  
     103;       to define the common variables i[xyz]minmesh 
    107104;       used to define the grid only in a zoomed part of the original 
    108105;       grid. Defaut values are 0L, max value is [XYZ]MAXMESH 
    109106; 
    110 ;       [XYZ]MAXMESH: to define the common variables i[xyz]maxmesh 
     107;       @keyword XMAXMESH  
     108;       @keyword YMAXMESH  
     109;       @keyword ZMAXMESH  
     110;       to define the common variables i[xyz]maxmesh 
    111111;       used to define the grid only in a zoomed part of the original 
    112112;       grid. Defaut values are jp[ijk]glo-1, max value is 
    … …  
    115115;       [XYZ]MAXMESH     
    116116; 
    117 ;       ZAXIS: to specify the vertical axis with a 1 dimension 
     117;       @keyword ZAXIS to specify the vertical axis with a 1 dimension 
    118118;       array. Must be sorted in the increasing or deceasing order 
    119119; 
    120 ; OUTPUTS: 
    121 ; 
    122 ; COMMON BLOCKS: cm_4mesh cm_4data cm_4cal 
    123 ; 
    124 ; SIDE EFFECTS: if the grid has x/y periodicity orverlap and/or if 
     120; @uses cm_4mesh cm_4data cm_4cal 
     121; 
     122; @restrictions if the grid has x/y periodicity orverlap and/or if 
    125123;    the mask has 0 everywhere at the border (like a close sea) and 
    126124;    if (we did not activate /plain and xminmesh, xmaxmesh, yminmesh, 
    … …  
    130128;    to use cell_fill = 1). 
    131129; 
    132 ; RESTRICTIONS:FUV points definition... 
    133 ; 
    134 ; EXAMPLE: 
    135 ; 
    136 ; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr) 
     130; @restrictions FUV points definition... 
     131; 
     132; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    137133;                      2000-04-20 
    138134;  Sept 2004, several bug fixs to suit C grid type... 

  • trunk/SRC/Grid/micromeshmask.pro

    r13 r103  
    11;+ 
    2 ; NAME: micromeshmask.pro 
    3 ; 
    4 ; PURPOSE: reduce the size of the NetCDF meshmask created by OPA by 
     2; 
     3; @file_comments reduce the size of the NetCDF meshmask created by OPA by 
    54; using bit (and not byte) format for the masks and the foat format 
    65; for the other fields.  
    76; 
    8 ; CATEGORY:for OPA meshmask files 
    9 ; 
    10 ; CALLING SEQUENCE: reducencmeshmask, ncfilein[, ncfileout] 
    11 ; 
    12 ; INPUTS:  
    13 ;      ncfilein: 
    14 ;      1) the name of the meshmask file to be reduced. In that case, 
    15 ;      there is only one meshmask file 
    16 ; 
    17 ;      OR 
    18 ; 
    19 ;      2) the xxx part in the names: xxx.mesh_hgr.nc xxx.mesh_zgr.nc 
    20 ;      xxx.mask.nc. In that case, the meshmask is split into 3 files. 
    21 ; 
    22 ;      ncfileout: the name of the uniq reduced meshmask file. default 
    23 ;      definition is micromeshmask.nc 
    24 ; 
    25 ; KEYWORD PARAMETERSSAT: 
    26 ; 
    27 ;    IODIR:to define the files path. 
    28 ; 
    29 ; OUTPUTS: no 
    30 ; 
    31 ; COMMON BLOCKS: no 
    32 ; 
    33 ; EXAMPLE: 
     7; @categories for OPA meshmask files 
     8; 
     9; @examples  
     10; IDL> reducencmeshmask, ncfilein[, ncfileout] 
     11; 
     12; @examples  
    3413;    IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/' 
    3514;    IDL> micromeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir 
    3615; 
    37 ; MODIFICATION HISTORY: 
    38 ;      July 2004 Sebastien Masson (smasson@lodyc.jussieu.fr) 
     16; @history 
     17;      July 2004 Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    3918;- 
    4019;------------------------------------------------------ 
    … …  
    4726END 
    4827; 
     28;+ 
     29;    @keyword IODIR to define the files path. 
     30;      @param ncfilein {in}{required} 
     31;      1) the name of the meshmask file to be reduced. In that case, 
     32;      there is only one meshmask file 
     33; 
     34;      OR 
     35; 
     36;      2) the xxx part in the names: xxx.mesh_hgr.nc xxx.mesh_zgr.nc 
     37;      xxx.mask.nc. In that case, the meshmask is split into 3 files. 
     38; 
     39;      @param ncfileout {in}{required} the name of the uniq reduced meshmask file. default 
     40;      definition is micromeshmask.nc 
     41; 
     42;- 
    4943PRO micromeshmask, ncfilein, ncfileout, IODIR = iodir 
    5044; 

  • trunk/SRC/Grid/n128gaussian.pro

    r13 r103  
    11;+ 
    2 ; NAME:n128gaussian 
    3 ; 
    4 ; PURPOSE:compute the latitudes of the n128 gaussian grid. See: 
     2; @file_comments compute the latitudes of the n128 gaussian grid. See: 
    53; http://www.ecmwf.int/products/data/technical/gaussian/n128FIS.html 
    64; 
    7 ; CATEGORY:grid 
     5; @categories grid 
    86; 
    9 ; CALLING SEQUENCE:lat=n128gaussian() 
     7; @examples  
     8; IDL> lat=n128gaussian() 
    109; 
    11 ; INPUTS:None 
     10; @returns a 1d array 
    1211; 
    13 ; KEYWORD PARAMETERS:None 
    14 ; 
    15 ; OUTPUTS:a 1d array 
    16 ; 
    17 ; COMMON BLOCKS:None 
    18 ; 
    19 ; SIDE EFFECTS:None 
    20 ; 
    21 ; RESTRICTIONS:None 
    22 ; 
    23 ; EXAMPLE: 
    24 ; 
    25 ; MODIFICATION HISTORY: 
    26 ;      Sebastien Masson (smasson@lodyc.jussieu.fr) 
     12; @history 
     13;      Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    2714;      June 2004 
    2815;- 

  • trunk/SRC/Grid/n160gaussian.pro

    r13 r103  
    11;+ 
    2 ; NAME:n160gaussian 
    32; 
    4 ; PURPOSE:compute the latitudes of the n160 gaussian grid. See: 
     3; @file_comments compute the latitudes of the n160 gaussian grid. See: 
    54; http://www.ecmwf.int/products/data/technical/gaussian/n160FIS.html 
    65; 
    7 ; CATEGORY:grid 
     6; @categories grid 
    87; 
    9 ; CALLING SEQUENCE:lat=n160gaussian() 
     8; @examples  
     9; IDL>lat=n160gaussian() 
    1010; 
    11 ; INPUTS:None 
     11; @returns a 1d array 
    1212; 
    13 ; KEYWORD PARAMETERS:None 
    14 ; 
    15 ; OUTPUTS:a 1d array 
    16 ; 
    17 ; COMMON BLOCKS:None 
    18 ; 
    19 ; SIDE EFFECTS:None 
    20 ; 
    21 ; RESTRICTIONS:None 
    22 ; 
    23 ; EXAMPLE: 
    24 ; 
    25 ; MODIFICATION HISTORY: 
    26 ;      Sebastien Masson (smasson@lodyc.jussieu.fr) 
     13; @history 
     14;      Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    2715;      June 2004 
    2816;- 

  • trunk/SRC/Grid/n256gaussian.pro

    r13 r103  
    11;+ 
    2 ; NAME:n256gaussian 
    3 ; 
    4 ; PURPOSE:compute the latitudes of the n256 gaussian grid. See: 
     2; 
     3; @file_comments compute the latitudes of the n256 gaussian grid. See: 
    54; http://www.ecmwf.int/products/data/technical/gaussian/n256FIS.html 
    65; 
    7 ; CATEGORY:grid 
    8 ; 
    9 ; CALLING SEQUENCE:lat=n256gaussian() 
    10 ; 
    11 ; INPUTS:None 
    12 ; 
    13 ; KEYWORD PARAMETERS:None 
    14 ; 
    15 ; OUTPUTS:a 1d array 
    16 ; 
    17 ; COMMON BLOCKS:None 
    18 ; 
    19 ; SIDE EFFECTS:None 
    20 ; 
    21 ; RESTRICTIONS:None 
    22 ; 
    23 ; EXAMPLE: 
    24 ; 
    25 ; MODIFICATION HISTORY: 
    26 ;      Sebastien Masson (smasson@lodyc.jussieu.fr) 
     6; @categories grid 
     7; 
     8; @examples 
     9; IDL> lat=n256gaussian() 
     10; 
     11; @returns a 1d array 
     12; 
     13; @history 
     14;      Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    2715;      June 2004 
    2816;- 

  • trunk/SRC/Grid/n48gaussian.pro

    r13 r103  
    11;+ 
    2 ; NAME:n48gaussian 
    32; 
    4 ; PURPOSE:compute the latitudes of the n48 gaussian grid. See: 
     3; @file_comments compute the latitudes of the n48 gaussian grid. See: 
    54; http://www.ecmwf.int/products/data/technical/gaussian/n48FIS.html 
    65; 
    7 ; CATEGORY:grid 
     6; @categories grid 
    87; 
    9 ; CALLING SEQUENCE:lat=n48gaussian() 
     8; @examples 
     9; IDL> lat=n48gaussian() 
    1010; 
    11 ; INPUTS:None 
     11; @returns a 1d array 
    1212; 
    13 ; KEYWORD PARAMETERS:None 
    14 ; 
    15 ; OUTPUTS:a 1d array 
    16 ; 
    17 ; COMMON BLOCKS:None 
    18 ; 
    19 ; SIDE EFFECTS:None 
    20 ; 
    21 ; RESTRICTIONS:None 
    22 ; 
    23 ; EXAMPLE: 
    24 ; 
    25 ; MODIFICATION HISTORY: 
    26 ;      Sebastien Masson (smasson@lodyc.jussieu.fr) 
     13; @history 
     14;      Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    2715;      June 2004 
    2816;- 

  • trunk/SRC/Grid/n80gaussian.pro

    r13 r103  
    11;+ 
    2 ; NAME:n80gaussian 
    32; 
    4 ; PURPOSE:compute the latitudes of the n80 gaussian grid. See: 
     3; @file_comments compute the latitudes of the n80 gaussian grid. See: 
    54; http://www.ecmwf.int/products/data/technical/gaussian/n80FIS.html 
    65; 
    7 ; CATEGORY:grid 
     6; @categories grid 
    87; 
    9 ; CALLING SEQUENCE:lat=n80gaussian() 
     8; @examples 
     9; IDL> lat=n80gaussian() 
    1010; 
    11 ; INPUTS:None 
     11; @returns a 1d array 
    1212; 
    13 ; KEYWORD PARAMETERS:None 
    14 ; 
    15 ; OUTPUTS:a 1d array 
    16 ; 
    17 ; COMMON BLOCKS:None 
    18 ; 
    19 ; SIDE EFFECTS:None 
    20 ; 
    21 ; RESTRICTIONS:None 
    22 ; 
    23 ; EXAMPLE: 
    24 ; 
    25 ; MODIFICATION HISTORY: 
    26 ;      Sebastien Masson (smasson@lodyc.jussieu.fr) 
     13; @history 
     14;      Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    2715;      June 2004 
    2816;- 

  • trunk/SRC/Grid/ncdf_meshread.pro

    r98 r103  
    33;------------------------------------------------------------ 
    44;+ 
    5 ; NAME:ncdf_meshread 
    6 ; 
    7 ; PURPOSE:read NetCDF meshmask file created by OPA 
    8 ; 
    9 ; CATEGORY:grid reading 
    10 ; 
    11 ; CALLING SEQUENCE:ncdf_meshread [,' filename'] 
     5; 
     6; @file_comments read NetCDF meshmask file created by OPA 
     7; 
     8; @categories grid reading 
     9; 
     10; @examples 
     11; IDL> ncdf_meshread [,' filename'] 
    1212;  
    13 ; INPUTS: 
    14 ; 
    15 ;    filename: the name of the meshmask file to read. Default is 
     13;    @param filename {in}{optional} the name of the meshmask file to read. Default is 
    1614;    meshmask.nc. if this name does not contain any / and if 
    1715;    iodirectory keyword is not specify, then the common variable 
    1816;    iodir will be use to define the mesh file path. 
    19  
    20 ; KEYWORD PARAMETERS: 
    21 ; 
    22 ;    GLAMBOUNDARY:a 2 elements vector, {lon1,lon2], the longitute 
     17; 
     18;    @keyword GLAMBOUNDARY a 2 elements vector, {lon1,lon2], the longitute 
    2319;    boundaries that should be used to visualize the data. 
    2420;      lon2 > lon1 
    … …  
    2622;    key_shift will be automaticaly defined according to GLAMBOUNDARY. 
    2723; 
    28 ;    /CHECKDAT: Suppressed. Use micromeshmask.pro to create an 
     24;    @keyword /CHECKDAT Suppressed. Use micromeshmask.pro to create an 
    2925;    appropriate meshmask. 
    3026; 
    31 ;    ONEARTH = 0 or 1: to force the manual definition of 
     27;    @keyword ONEARTH = 0 or 1 to force the manual definition of 
    3228;    key_onearth (to specify if the data are on earth -> use longitude 
    3329;    /latitude etc...). By default, key_onearth = 1. 
    … …  
    3531;    cancelling GLAMBOUNDARY 
    3632; 
    37 ;    PERIODIC = 0 or 1: to force the manual definition of 
     33;    @keyword PERIODIC = 0 or 1 to force the manual definition of 
    3834;    key_periodic. By default, key_periodic is automaticaly 
    3935;    computed by using the first line of glamt. 
    4036; 
    41 ;    SHIFT = : to force the manual definition of key_shift. By 
     37;    @keyword SHIFT to force the manual definition of key_shift. By 
    4238;    debault, key_shift is automaticaly computed according to the 
    4339;    glamboundary (when defined) by using the first line of glamt. if 
    4440;    key_periodic=0 then in any case key_shift = 0.  
    4541; 
    46 ;    STRCALLING: a string containing the calling command used to call 
     42;    @keyword STRCALLING a string containing the calling command used to call 
    4743;    computegrid (this is used by xxx.pro) 
    4844; 
    49 ;    STRIDE = : a 3 elements vector to specify the stride in x, y, z 
     45;    @keyword STRIDE a 3 elements vector to specify the stride in x, y, z 
    5046;    direction. Default definition is key_stride. The resulting value 
    5147;    will be stored in the common (cm_4mesh) variable key_stride 
    5248; 
    53 ; 
    54 ; OUTPUTS:none 
    55 ; 
    56 ; COMMON BLOCKS: cm_4mesh, cm_4data, cm_4cal 
    57 ; 
    58 ; SIDE EFFECTS: define and/or use common variables from  
     49; @uses cm_4mesh cm_4data cm_4cal 
     50; 
     51; @restrictions define and/or use common variables from  
    5952;               cm_4mesh, cm_4data, cm_4cal 
    6053; 
    61 ; RESTRICTIONS: 
     54; @restrictions 
    6255; 
    6356;  ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh,izminmesh,izmaxmesh must 
    … …  
    6558;  are equal to -1 they will be automatically defined  
    6659; 
    67 ; EXAMPLE: 
    68 ; 
    69 ; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr) 
     60; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    7061;                      12/1999 
    7162; July 2004, Sebastien Masson: Several modifications (micromeshmask, 

  • trunk/SRC/Grid/restoreboxparam.pro

    r13 r103  
    33;------------------------------------------------------------ 
    44;+ 
    5 ; NAME: restoreboxparam 
    65; 
    7 ; PURPOSE: restore all the zoom parameters (defined by calling domdef) 
     6; @file_comments restore all the zoom parameters (defined by calling domdef) 
    87;          perviously defined by saveboxparam 
    98; 
    10 ; CATEGORY: 
     9; @examples 
     10; IDL> restoreboxparam, filename 
     11;  
     12; @param filename {in}{required} a scalar string defining the file name  
    1113; 
    12 ; CALLING SEQUENCE: restoreboxparam, filename 
    13 ;  
    14 ; INPUTS: filename a scalar string defining the file name  
     14; @uses cm_4mesh and cm_demomode_used if we are in demo mode 
    1515; 
    16 ; KEYWORD PARAMETERS: none 
    17 ; 
    18 ; OUTPUTS:none 
    19 ; 
    20 ; COMMON BLOCKS: @cm_4mesh and @cm_demomode_used if we are in demo mode 
    21 ; 
    22 ; SIDE EFFECTS: call def_myuniquetmpdir, if myuniquetmpdir is undefined:  
     16; @restrictions all def_myuniquetmpdir, if myuniquetmpdir is undefined:  
    2317;               => define, create and add it to !path 
    2418; 
    25 ; RESTRICTIONS: 
    26 ; 
    27 ; EXAMPLE: 
    28 ; 
    29 ; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr) 
     19; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    3020;                      July 2005 
    3121;- 

  • trunk/SRC/Grid/saveboxparam.pro

    r13 r103  
    33;------------------------------------------------------------ 
    44;+ 
    5 ; NAME: saveboxparam 
    65; 
    7 ; PURPOSE: save all the zoom parameters (defined by calling domdef) 
     6; @file_comments save all the zoom parameters (defined by calling domdef) 
    87;          in a file (using save command) located in myuniquetmpdir 
    98;          (common variable defined by def_myuniquetmpdir) 
    109; 
    11 ; CATEGORY: 
     10; @examples 
     11; IDL> saveboxparam, filename 
     12;  
     13; @param filename {in}{required} a scalar string defining the file name  
    1214; 
    13 ; CALLING SEQUENCE: saveboxparam, filename 
    14 ;  
    15 ; INPUTS: filename a scalar string defining the file name  
     15; @uses cm_4mesh and cm_demomode_used if we are in demo mode 
    1616; 
    17 ; KEYWORD PARAMETERS: none 
    18 ; 
    19 ; OUTPUTS:none 
    20 ; 
    21 ; COMMON BLOCKS: @cm_4mesh and @cm_demomode_used if we are in demo mode 
    22 ; 
    23 ; SIDE EFFECTS: call def_myuniquetmpdir, if myuniquetmpdir is undefined:  
     17; @restrictions call def_myuniquetmpdir, if myuniquetmpdir is undefined:  
    2418;               => define, create and add it to !path 
    2519; 
    26 ; RESTRICTIONS: 
    27 ; 
    28 ; EXAMPLE: 
    29 ; 
    30 ; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr) 
     20; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    3121;                      June 2005 
    3222;- 

  • trunk/SRC/Grid/smallmeshmask.pro

    r13 r103  
    11;+ 
    2 ; NAME: smallmeshmask.pro 
    3 ; 
    4 ; PURPOSE: reduce the size of the NetCDF meshmask created by OPA by 
    5 ; using byte format for the masks and the foat format for the other 
    6 ; fields. 
    7 ; 
    8 ; CATEGORY:for OPA meshmask files 
    9 ; 
    10 ; CALLING SEQUENCE: smallmeshmask, ncfilein[, ncfileout] 
    11 ; 
    12 ; INPUTS:  
    13 ;      ncfilein: 
    14 ;      1) the name of the meshmask file to be reduced. In that case, 
    15 ;      there is only one meshmask file 
    16 ; 
    17 ;      OR 
    18 ; 
    19 ;      2) the xxx part in the names: xxx.mesh_hgr.nc xxx.mesh_zgr.nc 
    20 ;      xxx.mask.nc. In that case, the meshmask is split into 3 files. 
    21 ; 
    22 ;      ncfileout: the name of the reduced meshmask file. default 
    23 ;      definition is smallmeshmask.nc 
    24 ; 
    25 ; KEYWORD PARAMETERS: 
    26 ; 
    27 ;    IODIR:to define the files path. 
    28 ; 
    29 ; OUTPUTS: no 
    30 ; 
    31 ; COMMON BLOCKS: no 
    32 ; 
    33 ; EXAMPLE: 
    34 ;    IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/' 
    35 ;    IDL> smallmeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir 
    36 ; 
    37 ; MODIFICATION HISTORY: 
    38 ;      July 2004 Sebastien Masson (smasson@lodyc.jussieu.fr) 
     2; 
     3; 
     4; @categories for OPA meshmask files 
     5; 
     6; @history 
     7;      July 2004 Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    398;- 
    409;------------------------------------------------------ 
    … …  
    4716END 
    4817; 
     18;+ 
     19; @file_comments reduce the size of the NetCDF meshmask created by OPA by 
     20; using byte format for the masks and the foat format for the other 
     21; fields. 
     22; 
     23;    @keyword IODIR to define the files path. 
     24;      @param ncfilein {in}{required} 
     25;      1) the name of the meshmask file to be reduced. In that case, 
     26;      there is only one meshmask file 
     27; 
     28;      OR 
     29; 
     30;      2) the xxx part in the names: xxx.mesh_hgr.nc xxx.mesh_zgr.nc 
     31;      xxx.mask.nc. In that case, the meshmask is split into 3 files. 
     32; 
     33;      @param ncfileout {in}{optional} the name of the reduced meshmask file. default 
     34;      definition is smallmeshmask.nc 
     35; 
     36; @examples 
     37;    IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/' 
     38;    IDL> smallmeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir 
     39; 
     40; @categories for OPA meshmask files 
     41; 
     42; @history 
     43;      July 2004 Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     44;- 
    4945PRO smallmeshmask, ncfilein, ncfileout, IODIR = iodir 
    5046; 
Note: See TracChangeset for help on using the changeset viewer.