lbl2od
index
/users/schrei_f/src/py4CAtS/lite/src/lbl2od.py

lbl2od
 computation of line-by-line optical depth due to molecular absorption
 
 usage:
 lbl2od  [options]  atm_file  line_parameter_file(s)
 
 -h               help
 -c     char      comment character(s) used in input,output file (default '#')
 -o     string    output file for saving of optical depth (if not given: write to StdOut)
                  (if the output file's extension ends with ".nc", ".ncdf" or ".netcdf",
                   a netcdf file is generated, otherwise the file is ascii tabular or pickled)
 
 -m     char      mode: 'c' ---> cumulative optical depth
                        'd' ---> difference (delta) optical depth (default)
                        'r' ---> reverse cumulative optical depth
                        't' ---> total optical depth
 
--avg   int       running average:  return mean of some points
--BoA   float     bottom-of-atmosphere altitude [km]  (compute opt.depth only for levels above)
--ToA   float     top-of-atmosphere altitude [km]     (compute opt.depth only for levels below)
                  NOTE:  no interpolation, i.e. integration starts/stops at the next level above/below BoA/ToA
--scale floats    multiply molecular concentrations with scaleFactors
                  (either a comma separated list of floats (no blanks) in the same order as for the line data files,
                   or just a single float to scale the profile of the molecule corresponding to the first lineFile.)
 -x     Interval  lower,upper wavenumbers (comma separated pair of floats [no blanks!],
                                           default set according to range of lines in datafiles)
--nm              on output write optical depth versus wavelength [nm] (default: wavenumber 1/cm)
--xFormat string  format to be used for wavenumbers,   default '%12f'   (only for ascii tabular)
--yFormat string  format to be used for optical depth, default '%11.5f' (only for ascii tabular)
                  (if xFormat or yFormat is an empty string, netcdf or pickled format will be used)
 -r               on output reverse layer optical depth order:  top <--> bottom of atmosphere
 
 For more information use
 lbl2od --help

 
Functions
       
lbl2od(atmos, lineListsDict, xLimits=None, lineShape='Voigt', sampling=5.0, nGrids=3, gridRatio=8, nWidths=25.0, lagrange=2, interpolate=2, xsFile=None, verbose=False)
Compute cross sections for some molecule(s) and some pressure(s),temperature(s) by summation of line profiles;
Compute absorption coefficients as product cross section times molecular density, summed over all molecules;
Integrate absorption coefficients along vertical path thru atmosphere to get optical depth.
 
ARGUMENTS:
----------
atmos:         atmospheric data set, notably including zGrid=atmos['z']
lineListsDict  (molecular) line parameters: a dictionary of structured arrays
xLimits:       Interval with lower and upper wavenumber [cm-1]
 
RETURNS:
--------
dodList        a list of delta (layer) optical depths (instances of odArray)
 
See the lbl2xs function for details about other optional arguments.

 
Data
        more_Help = '\n the following set of options a...llations associated with some negative xs values\n'