afrt.py

Go to the documentation of this file.

'''
* NAME: afrt.py
*
* DESCRIPTION: Executable program to automate running of afrt (radiative
* transfer) application in configurable increments of the inputs and outputs
 
* USAGE: python afrt.py -p [PCF file path] -wl [wavelength range] 
                -sd [particle model range] -tau [optical depth range] 
                -wnd [wind speed range]
 
* Created on October 09, 2018
 
* Author: Samuel Anderson
'''
 
import os
import sys
from datetime import datetime as dt
import optparse as optparse
import logging
LOG = logging.getLogger('afrt')
 
 
 
 
def main():
 
    args = sys.argv
    
    description = '''Execute afrt and generate NetCDF output files.'''
    usage = "usage: python afrt.py -p [PCF] -wl [wavelength id range] -sd [model id range] -tau [tau id range] -wnd [wind id range] -o [output directory] [options]"
    version = "v1"
 
    parser = optparse.OptionParser(description=description,usage=usage,version=version)
 
    # Mandatory arguments
    mandatoryGroup = optparse.OptionGroup(parser, "Mandatory Arguments",
                        "At a minimum these arguments must be specified")
 
    parser.add_option_group(mandatoryGroup)
 
    mandatoryGroup.add_option('-p','--par',
                      action="store",
                      dest="parfile" ,
                      type="string",
                      help="The full path of the parameters file")
 
    # Optional arguments
    optionalGroup = optparse.OptionGroup(parser, "Extra Options",
                        "These options may be used to customize behavior of this program.")
 
    optionalGroup.add_option('-l','--wl',
                      action="store",
                      dest="wl" ,
                      type="int",
                      nargs=2,
                      help="Range of wavelength indices")
 
    optionalGroup.add_option('-s','--sd',
                      action="store",
                      dest="sd" ,
                      type="int",
                      nargs=2,
                      help="Range of particle model indices")
 
    optionalGroup.add_option('-t','--tau',
                      action="store",
                      dest="tau" ,
                      type="int",
                      nargs=2,
                      help="Range of optical depth indices")
 
    optionalGroup.add_option('-w','--wnd',
                      action="store",
                      dest="wnd" ,
                      type="int",
                      nargs=2,
                      help="Range of optical depth indices")
 
    optionalGroup.add_option('-o','--odir',
                      action="store",
                      dest="odir" ,
                      type="string",
                      help="The full path of the output directories")
 
    parser.add_option('-v', '--verbose',
                      dest='verbosity',
                      action="count",
                      default=0,
                      help='each occurrence increases verbosity 1 level from ERROR: -v=WARNING -vv=INFO -vvv=DEBUG')
 
    parser.add_option_group(optionalGroup)
 
    # Parse the arguments from the command line
    (opt, args) = parser.parse_args()
 
    # Set up the logging levels
    levels = [logging.ERROR, logging.WARN, logging.INFO, logging.DEBUG]
    logging.basicConfig(level = levels[opt.verbosity])
 
    # Check that all of the mandatory options are given. If one or more 
    # are missing, print error message and exit...
    mandatories = []
    mand_errors = []
    isMissingMand = False
    for m,m_err in zip(mandatories,mand_errors):
        if not opt.__dict__[m]:
            isMissingMand = True
            print (m_err)
    if isMissingMand :
        parser.error("Incomplete mandatory arguments, aborting...")
 
    # Check that the output directory actually exist
    if opt.odir:
        opt.odir = os.path.expanduser(opt.odir)
        
    # Check for mutually exclusive options
    LOG.info('Generating radiative transfer tables in  %s' % (opt.odir) )
 
    if os.path.isdir(opt.odir):
        o_path = opt.odir
    elif os.path.isdir(os.path.dirname(opt.odir)):
        o_path = opt.odir
        os.mkdir(o_path)            
    else:
        print ("Output path invalid")
        return
 
    # Read and parse parameters file 
    if opt.parfile:
        spcf = opt.parfile
    else:
        spcf = ""
 
    # Process radiative transfer tables
    rid = 0
    for isd in range(opt.sd[0],opt.sd[1]+1):
        for iwl in range(opt.wl[0],opt.wl[1]+1):
            for itau in range(opt.tau[0],opt.tau[1]+1):
                for iwnd in range(opt.wnd[0],opt.wnd[1]+1):
                    print ("wl:" + str(iwl) + " sd:" + str(isd) + " tau:" + str(itau) + " wnd:" + str(iwnd))
                    wl_istr = " wave_id=" + str(iwl) + "," + str(iwl)
                    sd_istr = " model_id=" + str(isd) + "," + str(isd) 
                    tau_istr = " tau_id=" + str(itau) + "," + str(itau)
                    wnd_istr = " wind_id=" + str(iwnd) + "," + str(iwnd)
                    ofile_istr = " ofile=" + opt.odir + "/RT" + str(rid)  + "_MD" + str(isd) + "_WL" + str(iwl) + "_TA" + str(itau) + "_WD" + str(iwnd) + ".nc"
                    command = "afrt_nc4 " + spcf + sd_istr + wl_istr + tau_istr + wnd_istr + ofile_istr
                    print (command)                             
                    result = os.system(command)
                    rid += 1
 
    print( 'Processing completed')
    LOG.info('Exiting...')
    return 0
 
if __name__=='__main__':
    sys.exit(main())