source: TI02-CSML/trunk/csml/csmlscan.py @ 2176

#!/usr/bin/env python

#**************************************************************************************
#cd2csml.py 
#read netcdf/pp files through cdunif/cdat and produce CSML documents
#V0.56 Dominic Lowe, BADC 06th December 2005
#V0.55 Dominic Lowe, BADC  08th November 2005
#V0.5 Dominic Lowe, BADC  27th October 2005
#
#**************************************************************************************

import sys, string
import ConfigParser
import getopt
import os
#CSML modules
import csmllibs
import parser
import parser_extra
import profile


usage = """Usage:
    Coapec2CSML [options] <files>

    Scan a list of files (netCDF/PP/GRIB) producing a CSML file for those files 
    (as a single CSML Dataset)

Arguments:

    <files> is a list of file paths to scan. The files can be listed in any order, 
    and may be in multiple directories. 
    These files will be marked up as a single CSML Dataset. 
    Please note that use of the 'directory' option will override any file arguments here.
        
Options:

    -d directory: All netcdf files in the directory are marked up in a single CSML file
                        
                
    -f csmlfeaturetype: The csmlFeatureType of the data. Only GridSeriesProfile is 
                currently implemented. Other feature types are PointFeature
                PointSeriesFeature ProfileFeature ProfileSeriesFeature and GridFeature.
                                                
     -t timedimension:  The default time dimension is 't'. If your files use a
                different variable name you may supply it with this option.

    -o outputfile:      Provide the name of the output file, default is csmloutput.xml
                                which can be found in the directory from which the program is run
        -h help:                Shows this help information.
        
        
Example:
        
        python Coapec2csml.py -d /home/users/me/mynetcdffiles/ -o myoutput.xml
                - processes all netcdf files in the mynetcdffiles directory, outputs to
                  file called myoutput.xml
        
        
        python Coapec2csml.py myfile1.nc myfile2.nc myfile3.nc -t timevar
                - processes the three named files, aggregating with the time dimension
                  'timevar'. Output to default file csmloutput.xml
        
        python Coapec2csml.py -d /home/users/me/mynetcdffiles/
                                 -o myoutput.xml myfile1.nc myfile2.nc myfile3.nc 
        
                - same as the first example. The -d option overrides the file list so files 
                  myfile1.nc, myfile2.nc and myfile3.nc are all ignored. Outputs to
                  file called myoutput.xml.
        
        TODO: more examples     
        
"""
#this should go in ndg.utils
def getConfigNoError(self, section, option):
    # get the config option, returning None if not present
    try:
        value = self.get(section, option)
    except ConfigParser.NoSectionError,ConfigParser.NoOptionError:
        #config value is not set
        value =None 
    return value
    
def main(optargs=None):
    #assign extra method to configparser
    ConfigParser.ConfigParser.getConfigNoError=getConfigNoError
    config = ConfigParser.ConfigParser()
    #Get command line arguments
    if optargs:
        #if called as main(args) from another python module use these args, else use 
        #sys.argv if called from command line.
        sys.argv =optargs
    try:
            opts, args = getopt.getopt(sys.argv[1:], "c:d:f:xt:m:rpo:h", ["configfile=,directory=", "csmlfeaturetype=", "exitafterconfig","timedimension=", "filemapping=", "recursive", "printscreen", "outputfile=", "help"])
    except getopt.error, msg:
            print "Invalid options, use --help for help"
            sys.exit()
    hasConfig=False
    for o, v in opts:
            if o in ("-c", "--configfile"):
                configfile = v
                hasConfig=True
                configTest=False
                for o, v in opts:
                    if o in ("-x", "--exitafterconfig"):
                        configTest=True
            
    #set default values for required configs
    PRINTSCREEN = 0
    MAPPING=None
    TIMEDIMENSION=None
    TIMESTORAGE='inline'
    VALUESTORAGE='fileextract'
    SPATIALSTORAGE='fileextract'
    
    #...
    if hasConfig == True:
        config.read(configfile)
        FEATURETYPE = config.getConfigNoError('features', 'type')
        FEATURENUMBER = config.getConfigNoError('features', 'number')
        ROOTDIRECTORY = config.getConfigNoError('files', 'root')
        MAPPING = config.getConfigNoError('files', 'mapping')
        OUTPUTFILE = config.getConfigNoError('files', 'output')
        PRINTSCREEN = config.getConfigNoError('files', 'printscreen')
        SRSNAME = config.getConfigNoError('SpatialReference', 'srs')
        TIMEDIMENSION=config.getConfigNoError('time','timedimension')
        TIMESTORAGE=config.getConfigNoError('time','timestorage')
        VALUESTORAGE=config.getConfigNoError('values','valuestorage')
        SPATIALSTORAGE=config.getConfigNoError('spatialaxes','spatialstorage')
        
        if configTest==True:
            print 'Testing config file:'
            print 'Enables you to check your config file has been correctly interpreted.'
            print '\n'
            print 'The following config options have been set:'
            print '\n features:type =%s'%FEATURETYPE
            print '\n features:number =%s'%FEATURENUMBER
            print '\n files:root =%s'%ROOTDIRECTORY
            print '\n files:mapping =%s'%MAPPING
            print '\n files:output =%s'%OUTPUTFILE
            print '\n files:printscreen =%s'%PRINTSCREEN
            print '\n SpatialReference:srs =%s'%SRSNAME
            print '\n time:timedimension =%s'%TIMEDIMENSION
            print '\n time:timestorage =%s'%TIMESTORAGE
            print '\n spatialaxes:spatialstorage =%s'%SPATIALSTORAGE
            print '\n values:valuestorage =%s'%VALUESTORAGE
            sys.exit()
    
    else: #no config file, get command line args
        for o, v in opts:
            print o,v
        for o, v in opts:
            if o in ("-d", "--directory"):
                    ROOTDIRECTORY = v
            elif o in ("-f", "--csmlfeaturetype"):
                    FEATURETYPE = v
            elif o in ("-t", "--timedimension"):
                    TIMEDIMENSION = v
            elif o in ("-f", "--filemapping"):
                    MAPPING=v
            elif o in ("-p", "--printscreen"):
                    PRINTSCREEN = 1
            elif o in ("-o", "--outputfile"):
                    OUTPUTFILE = v
            elif o in ("-h", "--help"):
                    print usage
                    sys.exit()  
                    
    # Handle defaults in case of no file mapping:
    if MAPPING is None:
        if FEATURETYPE == "Point":
            MAPPING = 'onetoone' #default filemapping for PointFeature (?)
        elif FEATURETYPE == "Profile":            
            MAPPING = 'onetoone' #default filemapping for ProfileFeature (?)
        elif FEATURETYPE == "Grid":
            MAPPING = 'onetoone' #default filemapping for GridFeature 
        elif FEATURETYPE == "PointSeries":
            MAPPING = 'onetomany'
        elif FEATURETYPE == "ProfileSeries":
            MAPPING = 'onetomany' #default filemapping for ProfileSeriesFeature (?)
        elif FEATURETYPE == "GridSeries":
            MAPPING = 'onetomany' #default filemapping for GridSeriesFeature
    
    #build CSML document
    print ROOTDIRECTORY
    csmldataset=csmllibs.csmlbuilder.csmlBuilder(ROOTDIRECTORY,FEATURETYPE,MAPPING,TIMEDIMENSION, OUTPUTFILE, PRINTSCREEN,TIMESTORAGE,SPATIALSTORAGE,VALUESTORAGE)
    csmldataset.build()

    print ''
    print '********************************************************************'
    print 'CSML file is at: ' + OUTPUTFILE
    print '********************************************************************'                
    print ''


if __name__=='__main__':
    print 'profiling..'
    profile.run(main())