Ignore:
Timestamp:
Jul 23, 2018, 8:49:04 PM (7 years ago)
Author:
lfita
Message:

Adding documentation for U. Wyoming transformer
Fixing typos in OBS netcdf documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/tools/documentation/other/obs_netcdf.html

    r1957 r1958  
    1313      Python script to create a netCDF file from observational ASCII files<BR>
    1414      <BR>
    15       <P STYLE="text-align:left;font-size:0.7em;">
    16       netCDF files are generated from a given ASCII file with observational data. Observational data can be of different types:
     15      <P STYLE="text-align:left;font-size:0.9em;">
     16      netCDF files are generated from a given ASCII file with observational data. Observational data can be of different types:<BR></P>
    1717      <UL>
     18      <P STYLE="text-align:left;font-size:0.9em;">
    1819        <LI><B>stations-map:</B> multiple individual punctual observations at no fixed locations and not fixed times (e.g., lightning strikes)</LI>
    1920        <LI><B>multi-points:</B> multiple observations at fixed locations and fixed times</LI>
    2021        <LI><B>single-station:</B> multiple observations on a single station at different times</LI>
    2122        <LI><B>trajectory:</B> multiple observations following a trajectory</LI>
    22       </UL>
    23       Transformation is controlled by an ASCII file with the description of the data. As example a template of this file called <CODE>description.dat.template</CODE> is provided. <BR>
    24       Observational ASCII file is expected to contain measurements of different variables at a same time like:<BR>
    25       <CODE>[Time1] [Var1] [Var2] [Var3] ... [varN]</CODE><BR>
    26       <CODE>(...)</CODE><BR>
    27       <CODE>[TimeM] [Var1] [Var2] [Var3] ... [varN]</CODE><BR>
    28       According to the type of observation file might contain observations at different locations, fixed or time-changing
     23      </UL></P>
     24      <P STYLE="text-align:left;font-size:0.9em;">
     25      Transformation is controlled by an ASCII file with the description of the data. As example a template of this file called <CODE>description.dat.template</CODE> is provided.<BR></P>
     26      <P STYLE="text-align:left;font-size:0.9em;">
     27      Observational ASCII file is expected to contain measurements of different variables at a same time like:<BR></P>
     28      <P STYLE="text-align:left;font-size:0.9em;">
     29      <CODE>[Time1] [Var1] [Var2] [Var3] ... [varN]<BR>
     30      (...)<BR>
     31      [TimeM] [Var1] [Var2] [Var3] ... [varN]</CODE><BR></P>
     32      <P STYLE="text-align:left;font-size:0.9em;">
     33      According to the type of observation file might contain observations at different locations, fixed or time-changing</P>
    2934      </P>
    3035    </DIV>
     
    3338      &nbsp;&nbsp;Script has the following attributes to be used with:
    3439      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>[comvals]</CODE>':' separated list of characters used for comments inside the <BR>
    35       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ASCII observational file
     40      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ASCII observational file<BR>
    3641      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>[descobsfilen]</CODE>name of the file with the description of the ASCII file with the <BR>
    37       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;observations to transform
     42      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;observations to transform<BR>
    3843      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>[endcol]</CODE>character to indicate end of the column for each observed <BR>
    39       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;variable. There are two special cases:
     44      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;variable. There are two special cases:<BR>
    4045      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>'space'</CODE>, for spaces <BR>
    4146      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>'None',[fixcoljumps]</CODE> for files with the measurements provided by fixed size columns<BR>
     
    4348      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>[ASCIIobsfilen]</CODE> ASCII file with the observations<BR>
    4449      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>[dbg]</CODE> whether debug is required ('false', 'true')<BR>
    45       &nbsp;&nbsp;&nbsp;&nbsp;<CODE>[obskind]</CODE>kind of observations one of: <CODE>'stations-map'</CODE>, <CODE>'multi-points'</CODE>, <CODE>'single-station'</CODE>, <CODE>'trajectory'</CODE><BR>
     50      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>[obskind]</CODE>kind of observations one of: <CODE>'stations-map'</CODE>, <CODE>'multi-points'</CODE>,<BR>
     51      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>'single-station'</CODE>, <CODE>'trajectory'</CODE><BR>
    4652      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>[stvals]=[stname],[stlong],[stlat],[stheight]</CODE> Values to describe the station, <BR>
    47       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; only valid for <CODE>'single-station'</CODE>:
    48       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[stname]</CODE> name of the station ('!' for spaces)
    49       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[stlon]</CODE> longitude of the station
    50       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[stlat]</CODE> latitude of the station
    51       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[stheight]</CODE> height of the station
     53      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; only valid for <CODE>'single-station'</CODE>:<BR>
     54      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[stname]</CODE> name of the station ('!' for spaces)<BR>
     55      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[stlon]</CODE> longitude of the station<BR>
     56      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[stlat]</CODE> latitude of the station<BR>
     57      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[stheight]</CODE> height of the station<BR>
    5258      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>[cftimeval]=[Refdate],[tunits]</CODE> values to generate the time following <BR>
    5359      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CF conventions with reference date in <CODE>[YYYY][MM][DD][HH][MI][SS]</CODE> format and <BR>
    54       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;time units: 'weeks', 'days', 'hours', 'miuntes', 'seconds'
     60      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;time units: 'weeks', 'days', 'hours', 'miuntes', 'seconds'<BR>
     61      &nbsp;&nbsp;<BR>
    5562      &nbsp;&nbsp;Inside the description file, user has to specify:<BR>
    5663      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>institution=</CODE>Institution who creates the data<BR>
     
    7178      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <B>NOTE:</B> in case observation is tabulled following a WMO code, <BR>
    7279      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;user can use <CODE>wmo_code_[NUM]</CODE> as units and if <BR>
    73       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;a given file called <CODE>wmo_[NUM].code</CODE> exists <BR>
    74       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;additional dimensions and variables will be added:<BR>
     80      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;a given file called <CODE>wmo_[NUM].code</CODE> exists (already available: <BR>
     81      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0200, 020012, 0509, 4561, 0513, 4677, 0500, 0515) additional dimensions and <BR>
     82      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;variables will be added (see below):<BR>
    7583      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>wmo_code_[NUM]</CODE>: Values of the code<BR>
    76       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>wmo_code_[NUM]_meaning</CODE>: meaning of <BR>
    77       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;each code<BR>
    78       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;------- ------ ----- ---- --- -- -<BR>
    79       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>wmo_code_[NUM]</CODE> with structure: <BR>
    80       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>reference|</CODE>web page, document reference with the code<BR>
    81       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>short_description|</CODE>main description of the code<BR>
    82       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>wmo_code|</CODE>[NUM]<BR>
    83       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>long_description|</CODE>long description of the code<BR>
    84       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>codeTYPE|</CODE>type of the code (andy of 'D', 'F', 'I', 'S')<BR>
    85       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>@| Values</CODE>line giving the start of the values<BR>
    86       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[val1]|</CODE>[meaning of first value]<BR>
    87       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>(...)</CODE><BR>
    88       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[valN]|</CODE>[meaning of last value]<BR>
     84      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>wmo_code_[NUM]_meaning</CODE>: meaning of each code<BR>
    8985      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>varBUFR=</CODE>'|' list BUFR code of the variables (optional, can not be provided)<BR>
    9086      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>varTYPE=</CODE>'|' list of variable types ('D', 'F', 'I', 'I64', 'S')<BR>
    91       &nbsp;&nbsp;&nbsp;&nbsp;<CODE>varOPER=</CODE>'|' list of operations to do to the variables to meet their units ([oper],[val]) (optional)<BR>
     87      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>varOPER=</CODE>'|' list of operations to do to the variables to meet their <BR>
     88      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;units ([oper],[val]) (optional)<BR>
    9289      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[oper]:<BR>
    9390      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-, nothing<BR>
     
    9794      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;divc, divide by [val]<BR>
    9895      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;rmchar,[val],[pos], remove [val] characters from [pos]='B', beginning, 'E', end<BR>
    99       &nbsp;&nbsp;&nbsp;&nbsp;<CODE>NAMElon=</CODE>name of the variable (from <CODE>varN</CODE>, if applicable) <BR>
    100       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;with the longitude (x position)<BR>
    101       &nbsp;&nbsp;&nbsp;&nbsp;<CODE>NAMElat=</CODE>name of the variable (from <CODE>varN</CODE>, if applicable) <BR>
    102       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;with the latitude (y position)<BR>
    103       &nbsp;&nbsp;&nbsp;&nbsp;<CODE>NAMEheight=</CODE>name of the variable (from <CODE>varN</CODE>, if applicable) <BR>
    104       &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;with the height (z position)<BR>
     96      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>NAMElon=</CODE>name of the variable (from <CODE>varN</CODE>, if applicable) with the longitude <BR>
     97      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(x position)<BR>
     98      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>NAMElat=</CODE>name of the variable (from <CODE>varN</CODE>, if applicable) with the latitude <BR>
     99      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(y position)<BR>
     100      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>NAMEheight=</CODE>name of the variable (from <CODE>varN</CODE>, if applicable) with the height <BR>
     101      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(z position)<BR>
    105102      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>NAMEtime=</CODE>name of the varibale with the time (from <CODE>varN</CODE>) <BR>
    106103      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>NOTE:</B> It can be a combination of different variables from <CODE>varN</CODE> separated <BR>
     
    108105      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>FMTtime=</CODE>format of the time (as in 'C' (e.g.: %Y-%m-%d@%H:%M:%S), or use <BR>
    109106      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>'CFtime'</CODE> for observational times which are already in CF-like format)<BR>
     107
     108      &nbsp;&nbsp;------- ------ ----- ---- --- -- -<BR>
     109      &nbsp;&nbsp;&nbsp;&nbsp;<CODE>wmo_[NUM].code</CODE> file with structure: <BR>
     110      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>reference|</CODE>web page, document reference with the code<BR>
     111      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>short_description|</CODE>main description of the code <CODE>wmo_code|</CODE>[NUM]<BR>
     112      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>long_description|</CODE>long description of the code<BR>
     113      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>codeTYPE|</CODE>type of the code (andy of 'D', 'F', 'I', 'S')<BR>
     114      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>@| Values</CODE>line giving the start of the values<BR>
     115      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[val1]|</CODE>[meaning of first value]<BR>
     116      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>(...)</CODE><BR>
     117      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<CODE>[valN]|</CODE>[meaning of last value]<BR>
    110118    </DIV>
    111119    <DIV CLASS="valins">
Note: See TracChangeset for help on using the changeset viewer.