source: lmdz_wrf/trunk/tools/create_OBSnetcdf.py @ 592

Last change on this file since 592 was 587, checked in by lfita, 10 years ago

Adding `rmchar'; rmchar,[val],[pos], remove [val] characters from [pos]='B', beginning, 'E', end as operation
File size: 40.5 KB
Line 
1# -*- coding: iso-8859-15 -*-
2# Generic program to transfrom ASCII observational data in columns to a netcdf
3# L. Fita, LMD February 2015
4## e.g. # create_OBSnetcdf.py -c '#' -d ACAR/description.dat -e space -f ACAR/2012/10/ACAR_121018.asc -g true -t 19491201000000,seconds -k trajectory
5
6import numpy as np
7from netCDF4 import Dataset as NetCDFFile
8import os
9import re
10from optparse import OptionParser
11
12# version
13version=1.1
14
15# Filling values for floats, integer and string
16fillValueF = 1.e20
17fillValueI = -99999
18fillValueS = '---'
19
20# Length of the string variables
21StringLength = 200
22
23# Size of the map for the complementary variables/maps
24Ndim2D = 100
25
26main = 'create_OBSnetcdf.py'
27errormsg = 'ERROR -- error -- ERROR -- error'
28warnmsg = 'WARNING -- warning -- WARNING -- warning'
29
30fillValue = 1.e20
31
32def searchInlist(listname, nameFind):
33    """ Function to search a value within a list
34    listname = list
35    nameFind = value to find
36    >>> searInlist(['1', '2', '3', '5'], '5')
37    True
38    """
39    for x in listname:
40      if x == nameFind:
41        return True
42    return False
43
44def set_attribute(ncvar, attrname, attrvalue):
45    """ Sets a value of an attribute of a netCDF variable. Removes previous attribute value if exists
46    ncvar = object netcdf variable
47    attrname = name of the attribute
48    attrvalue = value of the attribute
49    """
50    import numpy as np
51    from netCDF4 import Dataset as NetCDFFile
52
53    attvar = ncvar.ncattrs()
54    if searchInlist(attvar, attrname):
55        attr = ncvar.delncattr(attrname)
56
57    attr = ncvar.setncattr(attrname, attrvalue)
58
59    return ncvar
60
61def basicvardef(varobj, vstname, vlname, vunits):
62    """ Function to give the basic attributes to a variable
63    varobj= netCDF variable object
64    vstname= standard name of the variable
65    vlname= long name of the variable
66    vunits= units of the variable
67    """
68    attr = varobj.setncattr('standard_name', vstname)
69    attr = varobj.setncattr('long_name', vlname)
70    attr = varobj.setncattr('units', vunits)
71
72    return
73
74def remove_NONascii(string):
75    """ Function to remove that characters which are not in the standard 127 ASCII
76      string= string to transform
77    >>> remove_NONascii('Lluís')
78    Lluis
79    """
80    fname = 'remove_NONascii'
81
82    newstring = string
83
84    RTFchar= ['á', 'é', 'í', 'ó', 'ú', 'à', 'Ú', 'ì', 'ò', 'ù', 'â', 'ê', 'î', 'ÃŽ',  \
85      'û', 'À', 'ë', 'ï', 'ö', 'ÃŒ', 'ç', 'ñ','Ê', 'œ', 'Á', 'É', 'Í', 'Ó', 'Ú', 'À', \
86      'È', 'Ì', 'Ò', 'Ù', 'Â', 'Ê', 'Î', 'Ô', 'Û', 'Ä', 'Ë', 'Ï', 'Ö', 'Ü', 'Ç', 'Ñ',\
87      'Æ', 'Œ', '\n', '\t']
88    ASCchar= ['a', 'e', 'i', 'o', 'u', 'a', 'e', 'i', 'o', 'u', 'a', 'e', 'i', 'o',  \
89      'u', 'a', 'e', 'i', 'o', 'u', 'c', 'n','ae', 'oe', 'A', 'E', 'I', 'O', 'U', 'A', \
90      'E', 'I', 'O', 'U', 'A', 'E', 'I', 'O', 'U', 'A', 'E', 'I', 'O', 'U', 'C', 'N',\
91      'AE', 'OE', '', ' ']
92
93    Nchars = len(RTFchar)
94    for ichar in range(Nchars):
95        foundchar = string.find(RTFchar[ichar])
96        if foundchar != -1:
97            newstring = newstring.replace(RTFchar[ichar], ASCchar[ichar])
98
99    return newstring
100
101def read_description(fdobs, dbg):
102    """ reads the description file of the observational data-set
103    fdobs= descriptive observational data-set
104    dbg= boolean argument for debugging
105    * Each station should have a 'description.dat' file with:
106      institution=Institution who creates the data
107      department=Department within the institution
108      scientists=names of the data producers
109      contact=contact of the data producers
110      description=description of the observations
111      acknowledgement=sentence of acknowlegement
112      comment=comment for the measurements
113
114      MissingValue='|' list of ASCII values for missing values within the data
115        (as they appear!, 'empty' for no value at all)
116      comment=comments
117
118      varN='|' list of variable names
119      varLN='|' list of long variable names
120      varU='|' list units of the variables
121      varBUFR='|' list BUFR code of the variables
122      varTYPE='|' list of variable types ('D', 'F', 'I', 'I64', 'S')
123      varOPER='|' list of operations to do to the variables to meet their units ([oper],[val])
124        [oper]:
125          -, nothing
126          sumc, add [val]
127          subc, rest [val]
128          mulc, multiply by [val]
129          divc, divide by [val]
130          rmchar,[val],[pos], remove [val] characters from [pos]='B', beginning, 'E', end
131      NAMElon=name of the variable with the longitude (x position)
132      NAMElat=name of the variable with the latitude (y position)
133      NAMEheight=ind_alt
134      NAMEtime=name of the varibale with the time
135      FMTtime=format of the time (as in 'C', 'CFtime' for already CF-like time)
136
137    """
138    fname = 'read_description'
139
140    descobj = open(fdobs, 'r')
141    desc = {}
142
143    namevalues = []
144
145    for line in descobj:
146        if line[0:1] != '#' and len(line) > 1 :
147            descn = remove_NONascii(line.split('=')[0])
148            descv = remove_NONascii(line.split('=')[1])
149            namevalues.append(descn)
150            if descn[0:3] != 'var':
151                if descn != 'MissingValue':
152                    desc[descn] = descv
153                else:
154                    desc[descn] = []
155                    for dn in descv.split('|'): desc[descn].append(dn)
156                    print '  ' + fname + ': missing values found:',desc[descn]
157            elif descn[0:3] == 'var':
158                desc[descn] = descv.split('|')
159            elif descn[0:4] == 'NAME':
160                desc[descn] = descv
161            elif descn[0:3] == 'FMT':
162                desc[descn] = descv
163    if not desc.has_key('varOPER'): desc['varOPER'] = None
164
165    if dbg:
166        Nvars = len(desc['varN'])
167        print '  ' + fname + ": description content of '" + fdobs + "'______________"
168        for varn in namevalues:
169            if varn[0:3] != 'var':
170                print '    ' + varn + ':',desc[varn]
171            elif varn == 'varN':
172                print '    * Variables:'
173                for ivar in range(Nvars):
174                    varname = desc['varN'][ivar]
175                    varLname = desc['varLN'][ivar]
176                    varunits = desc['varU'][ivar]
177                    if desc.has_key('varBUFR'): 
178                        varbufr = desc['varBUFR'][ivar]
179                    else:
180                        varbufr = None
181                    if desc['varOPER'] is not None:
182                        opv = desc['varOPER'][ivar]
183                    else:
184                        opv = None
185                    print '      ', ivar, varname+':',varLname,'[',varunits, \
186                       ']','bufr code:',varbufr,'oper:',opv
187
188    descobj.close()
189
190    return desc
191
192def value_fmt(val, miss, op, fmt):
193    """ Function to transform an ASCII value to a given format
194      val= value to transform
195      miss= list of possible missing values
196      op= operation to perform to the value
197      fmt= format to take:
198        'D': float double precission
199        'F': float
200        'I': integer
201        'I64': 64-bits integer
202        'S': string
203    >>> value_fmt('9876.12', '-999', 'F')
204    9876.12
205    """
206
207    fname = 'value_fmt'
208
209    aopers = ['sumc','subc','mulc','divc', 'rmchar']
210
211    fmts = ['D', 'F', 'I', 'I64', 'S']
212    Nfmts = len(fmts)
213
214    if not searchInlist(miss,val):
215        if searchInlist(miss,'empty') and len(val) == 0: 
216            newval = None
217        else:
218            print 'op: **' + op + '**'
219            if op != '-':
220                opern = op.split(',')[0]
221                operv = op.split(',')[1]
222
223                if not searchInlist(aopers,opern):
224                    print errormsg
225                    print '  ' + fname + ": operation '" + opern + "' not ready!!"
226                    print '    availables:',aopers
227                    quit(-1)
228            else:
229                opern = 'sumc'
230                operv = '0.'
231
232            if not searchInlist(fmts, fmt):
233                print errormsg
234                print '  ' + fname + ": format '" + fmt + "' not ready !!"
235                quit(-1)
236            else:
237                if fmt == 'D':
238                    opv = np.float32(operv)
239                    if opern == 'sumc': newval = np.float32(val) + opv
240                    elif opern == 'subc': newval = np.float32(val) - opv
241                    elif opern == 'mulc': newval = np.float32(val) * opv
242                    elif opern == 'divc': newval = np.float32(val) / opv
243                    elif opern == 'rmchar': 
244                        opv = int(operv)
245                        Lval = len(val)
246                        if op.split(',')[2] == 'B':
247                            newval = np.float32(val[opv:Lval+1])
248                        elif op.split(',')[2] == 'E':
249                            newval = np.float32(val[Lval-opv:Lval])
250                        else:
251                            print errormsg
252                            print '  ' + fname + ": operation '" + opern + "' not " +\
253                              " work with '" + op.split(',')[2] + "' !!"
254                            quit(-1)
255                elif fmt == 'F':
256                    opv = np.float(operv)
257                    if opern == 'sumc': newval = np.float(val) + opv
258                    elif opern == 'subc': newval = np.float(val) - opv
259                    elif opern == 'mulc': newval = np.float(val) * opv
260                    elif opern == 'divc': newval = np.float(val) / opv
261                    elif opern == 'rmchar': 
262                        opv = int(operv)
263                        Lval = len(val)
264                        if op.split(',')[2] == 'B':
265                            newval = np.float(val[opv:Lval+1])
266                        elif op.split(',')[2] == 'E':
267                            newval = np.float(val[0:Lval-opv])
268                        else:
269                            print errormsg
270                            print '  ' + fname + ": operation '" + opern + "' not " +\
271                              " work with '" + op.split(',')[2] + "' !!"
272                            quit(-1)
273
274                elif fmt == 'I':
275                    opv = int(operv)
276                    if opern == 'sumc': newval = int(val) + opv
277                    elif opern == 'subc': newval = int(val) - opv
278                    elif opern == 'mulc': newval = int(val) * opv
279                    elif opern == 'divc': newval = int(val) / opv
280                    elif opern == 'rmchar': 
281                        opv = int(operv)
282                        Lval = len(val)
283                        if op.split(',')[2] == 'B':
284                            newval = int(val[opv:Lval+1])
285                        elif op.split(',')[2] == 'E':
286                            newval = int(val[0:Lval-opv])
287                        else:
288                            print errormsg
289                            print '  ' + fname + ": operation '" + opern + "' not " +\
290                              " work with '" + op.split(',')[2] + "' !!"
291                            quit(-1)
292                elif fmt == 'I64':
293                    opv = np.int64(operv)
294                    if opern == 'sumc': newval = np.int64(val) + opv
295                    elif opern == 'subc': newval = np.int64(val) - opv
296                    elif opern == 'mulc': newval = np.int64(val) * opv
297                    elif opern == 'divc': newval = np.int64(val) / opv
298                    elif opern == 'rmchar': 
299                        opv = int(operv)
300                        Lval = len(val)
301                        if op.split(',')[2] == 'B':
302                            newval = np.int64(val[opv:Lval+1])
303                        elif op.split(',')[2] == 'E':
304                            newval = np.int64(val[0:Lval-opv])
305                        else:
306                            print errormsg
307                            print '  ' + fname + ": operation '" + opern + "' not " +\
308                              " work with '" + op.split(',')[2] + "' !!"
309                            quit(-1)
310                elif fmt == 'S':
311                    if opern == 'rmchar': 
312                        opv = int(operv)
313                        Lval = len(val)
314                        if op.split(',')[2] == 'B':
315                            newval = val[opv:Lval+1]
316                        elif op.split(',')[2] == 'E':
317                            newval = val[0:Lval-opv]
318                        else:
319                            print errormsg
320                            print '  ' + fname + ": operation '" + opern + "' not " +\
321                              " work with '" + op.split(',')[2] + "' !!"
322                            quit(-1)
323                    else:
324                        newval = val
325
326    else:
327        newval = None
328
329    return newval
330
331def read_datavalues(dataf, comchar, colchar, fmt, oper, miss, varns, dbg):
332    """ Function to read from an ASCII file values in column
333      dataf= data file
334      comchar= list of the characters indicating comment in the file
335      colchar= character which indicate end of value in the column
336      dbg= debug mode or not
337      fmt= list of kind of values to be found
338      oper= list of operations to perform
339      miss= missing value
340      varns= list of name of the variables to find
341    """
342
343    fname = 'read_datavalues'
344
345    ofile = open(dataf, 'r')
346    Nvals = len(fmt)
347
348    if oper is None:
349        opers = []
350        for ioper in range(Nvals):
351            opers.append('-')
352    else:
353        opers = oper
354
355    finalvalues = {}
356
357    iline = 0
358    for line in ofile:
359        line = line.replace('\n','').replace(chr(13),'')
360        if not searchInlist(comchar,line[0:1]) and len(line) > 1:
361            values0 = line.split(colchar)
362# Removing no-value columns
363            values = []
364            for iv in values0:
365                if len(iv) > 0: values.append(iv)
366
367            Nvalues = len(values)
368# Checkings for wierd characters at the end of lines (use it to check)
369#            if values[Nvalues-1][0:4] == '-999':
370#                print line,'last v:',values[Nvalues-1],'len:',len(values[Nvalues-1])
371#                for ic in range(len(values[Nvalues-1])):
372#                    print ic,ord(values[Nvalues-1][ic:ic+1])
373#                quit()
374
375            if len(values[Nvalues-1]) == 0:
376                Nvalues = Nvalues - 1
377               
378            if Nvalues != Nvals:
379                print warnmsg
380                print '  ' + fname + ': number of formats:',Nvals,' and number of ', \
381                  'values:',Nvalues,' with split character *' + colchar +            \
382                  '* does not coincide!!'
383                print '    * what is found is ________'
384                if Nvalues > Nvals:
385                    Nshow = Nvals
386                    for ivar in range(Nshow):
387                        print '    ',varns[ivar],'fmt:',fmt[ivar],'value:',values[ivar]
388                    print '      missing formats for:',values[Nshow:Nvalues+1]
389                    print '      values not considered, continue'
390                else:
391                    Nshow = Nvalues
392                    for ivar in range(Nshow):
393                        print '   ',varns[ivar],'fmt:',fmt[ivar],'value:',values[ivar]
394                    print '      excess of formats:',fmt[Nshow:Nvals+1]
395                    quit(-1)
396
397# Reading and transforming values
398            if dbg: print '  ' + fname + ': values found _________'
399
400            for ivar in range(Nvals):
401                if dbg: 
402                    print iline, varns[ivar],'value:',values[ivar],miss,opers[ivar], \
403                      fmt[ivar]
404
405                if iline == 0:
406                    listvals = []
407                    listvals.append(value_fmt(values[ivar], miss, opers[ivar],       \
408                      fmt[ivar]))
409                    finalvalues[varns[ivar]] = listvals
410                else:
411                    listvals = finalvalues[varns[ivar]]
412                    listvals.append(value_fmt(values[ivar], miss, opers[ivar],       \
413                      fmt[ivar]))
414                    finalvalues[varns[ivar]] = listvals
415        else:
416# First line without values
417            if iline == 0: iline = -1
418   
419        iline = iline + 1
420
421    ofile.close()
422
423    return finalvalues
424
425def writing_str_nc(varo, values, Lchar):
426    """ Function to write string values in a netCDF variable as a chain of 1char values
427    varo= netCDF variable object
428    values = list of values to introduce
429    Lchar = length of the string in the netCDF file
430    """
431
432    Nvals = len(values)
433
434    for iv in range(Nvals):   
435        stringv=values[iv] 
436        charvals = np.chararray(Lchar)
437        Lstr = len(stringv)
438        charvals[Lstr:Lchar] = ''
439
440        for ich in range(Lstr):
441            charvals[ich] = stringv[ich:ich+1]
442
443        varo[iv,:] = charvals
444
445    return
446
447def Stringtimes_CF(tvals, fmt, Srefdate, tunits, dbg):
448    """ Function to transform a given data in String formats to a CF date
449      tvals= string temporal values
450      fmt= format of the the time values
451      Srefdate= reference date in [YYYY][MM][DD][HH][MI][SS] format
452      tunits= units to use ('weeks', 'days', 'hours', 'minutes', 'seconds')
453      dbg= debug
454    >>> Stringtimes_CF(['19760217082712','20150213101837'], '%Y%m%d%H%M%S',
455      '19491201000000', 'hours', False)
456    [229784.45333333  571570.31027778]
457    """
458    import datetime as dt
459
460    fname = 'Stringtimes'
461
462    dimt = len(tvals)
463
464    yrref = int(Srefdate[0:4])
465    monref = int(Srefdate[4:6])
466    dayref = int(Srefdate[6:8])
467    horref = int(Srefdate[8:10])
468    minref = int(Srefdate[10:12])
469    secref = int(Srefdate[12:14])
470    refdate = dt.datetime( yrref, monref, dayref, horref, minref, secref)
471
472    cftimes = np.zeros((dimt), dtype=np.float)
473
474    Nfmt=len(fmt.split('%'))
475
476    if dbg: print '  ' + fname + ': fmt=',fmt,'refdate:',Srefdate,'uits:',tunits,    \
477      'date dt_days dt_time deltaseconds CFtime _______'
478    for it in range(dimt):
479
480# Removing excess of mili-seconds (up to 6 decimals)
481        if fmt.split('%')[Nfmt-1] == 'f':
482            tpoints = tvals[it].split('.')
483            if len(tpoints[len(tpoints)-1]) > 6:
484                milisec = '{0:.6f}'.format(np.float('0.'+tpoints[len(tpoints)-1]))[0:7]
485                newtval = ''
486                for ipt in range(len(tpoints)-1):
487                    newtval = newtval + tpoints[ipt] + '.'
488                newtval = newtval + str(milisec)[2:len(milisec)+1]
489            else:
490                newtval = tvals[it]
491            tval = dt.datetime.strptime(newtval, fmt)
492        else:
493            tval = dt.datetime.strptime(tvals[it], fmt)
494
495        deltatime = tval - refdate
496        deltaseconds = deltatime.days*24.*3600. + deltatime.seconds +                \
497          deltatime.microseconds/100000.
498        if tunits == 'weeks':
499            deltat = 7.*24.*3600.
500        elif tunits == 'days':
501            deltat = 24.*3600.
502        elif tunits == 'hours':
503            deltat = 3600.
504        elif tunits == 'minutes':
505            deltat = 60.
506        elif tunits == 'seconds':
507            deltat = 1.
508        else:
509            print errormsg
510            print '  ' + fname + ": time units '" + tunits + "' not ready !!"
511            quit(-1)
512
513        cftimes[it] = deltaseconds / deltat
514        if dbg:
515            print '  ' + tvals[it], deltatime, deltaseconds, cftimes[it]
516
517    return cftimes
518
519def adding_complementary(onc, dscn, okind, dvalues, tvals, refCFt, CFtu, Nd, dbg):
520    """ Function to add complementary variables as function of the observational type
521      onc= netcdf objecto file to add the variables
522      dscn= description dictionary
523      okind= observational kind
524      dvalues= values
525      tvals= CF time values
526      refCFt= reference time of CF time (in [YYYY][MM][DD][HH][MI][SS])
527      CFtu= CF time units
528      Nd= size of the domain
529      dbg= debugging flag
530    """
531    import numpy.ma as ma
532
533    fname = 'adding_complementary'
534 
535# Kind of observations which require de integer lon/lat (for the 2D map)
536    map2D=['multi-points', 'trajectory']
537
538    SrefCFt = refCFt[0:4] +'-'+ refCFt[4:6] +'-'+ refCFt[6:8] + ' ' + refCFt[8:10] + \
539      ':'+ refCFt[10:12] +':'+ refCFt[12:14]
540
541    if dscn['NAMElon'] == '-' or dscn['NAMElat'] == '-':
542        print errormsg
543        print '  ' + fname + ": to complement a '" + okind + "' observation kind " + \
544          " a given longitude ('NAMElon':",dscn['NAMElon'],") and latitude ('" +     \
545          "'NAMElat:'", dscn['NAMElat'],') from the data has to be provided and ' +  \
546          'any are given !!'
547        quit(-1)
548
549    if not dvalues.has_key(dscn['NAMElon']) or not dvalues.has_key(dscn['NAMElat']):
550        print errormsg
551        print '  ' + fname + ": observations do not have 'NAMElon':",                \
552          dscn['NAMElon'],"and/or 'NAMElat:'", dscn['NAMElat'],' !!'
553        print '    available data:',dvalues.keys()
554        quit(-1)
555
556    if okind == 'trajectory':
557        if dscn['NAMEheight'] == '-':
558            print warnmsg
559            print '  ' + fname + ": to complement a '" + okind + "' observation " +  \
560              "kind a given height ('NAMEheight':",dscn['NAMEheight'],"') might " +  \
561              'be provided and any is given !!'
562            quit(-1)
563
564        if not dvalues.has_key(dscn['NAMEheight']):
565            print errormsg
566            print '  ' + fname + ": observations do not have 'NAMEtime':",           \
567              dscn['NAMEtime'],' !!'
568            print '    available data:',dvalues.keys()
569            quit(-1)
570
571    if searchInlist(map2D, okind):
572# A new 2D map with the number of observation will be added for that 'NAMElon'
573#   and 'NAMElat' are necessary. A NdxNd domain space size will be used.
574        objfile.createDimension('lon2D',Nd)
575        objfile.createDimension('lat2D',Nd)
576        lonvals = ma.masked_equal(dvalues[dscn['NAMElon']], None)
577        latvals = ma.masked_equal(dvalues[dscn['NAMElat']], None)
578
579        minlon = min(lonvals)
580        maxlon = max(lonvals)
581        minlat = min(latvals)
582        maxlat = max(latvals)
583
584        blon = (maxlon - minlon)/(Nd-1)
585        blat = (maxlat - minlat)/(Nd-1)
586
587        newvar = onc.createVariable( 'lon2D', 'f8', ('lon2D'))
588        basicvardef(newvar, 'longitude', 'longitude map observations','degrees_East')
589        newvar[:] = minlon + np.arange(Nd)*blon
590        newattr = set_attribute(newvar, 'axis', 'X')
591
592        newvar = onc.createVariable( 'lat2D', 'f8', ('lat2D'))
593        basicvardef(newvar, 'latitude', 'latitude map observations', 'degrees_North')
594        newvar[:] = minlat + np.arange(Nd)*blat
595        newattr = set_attribute(newvar, 'axis', 'Y')
596
597        if dbg: 
598            print '  ' + fname + ': minlon=',minlon,'maxlon=',maxlon
599            print '  ' + fname + ': minlat=',minlat,'maxlat=',maxlat
600            print '  ' + fname + ': precission on x-axis=', blon*(Nd-1), 'y-axis=',  \
601              blat*(Nd-1)
602       
603    if okind == 'multi-points':
604        map2D = np.ones((Nd, Nd), dtype=np.float)*fillValueI
605
606        dimt = len(tvals)
607        Nlost = 0
608        for it in range(dimt):
609            lon = dvalues[dscn['NAMElon']][it]
610            lat = dvalues[dscn['NAMElat']][it]
611            if lon is not None and lat is not None:
612                ilon = int((Nd-1)*(lon - minlon)/(maxlon - minlon))
613                ilat = int((Nd-1)*(lat - minlat)/(maxlat - minlat))
614
615                if map2D[ilat,ilon] == fillValueI: 
616                    map2D[ilat,ilon] = 1
617                else:
618                    map2D[ilat,ilon] = map2D[ilat,ilon] + 1
619                if dbg: print it, lon, lat, ilon, ilat, map2D[ilat,ilon]
620
621        newvar = onc.createVariable( 'mapobs', 'f4', ('lat2D', 'lon2D'),             \
622          fill_value = fillValueI)
623        basicvardef(newvar, 'map_observations', 'number of observations', '-')
624        newvar[:] = map2D
625        newattr = set_attribute(newvar, 'coordinates', 'lon2D lat2D')
626
627    elif okind == 'trajectory':
628# A new 2D map with the trajectory 'NAMElon' and 'NAMElat' and maybe 'NAMEheight'
629#   are necessary. A NdxNdxNd domain space size will be used. Using time as
630#   reference variable
631        if dscn['NAMEheight'] == '-':
632# No height
633            map2D = np.ones((Nd, Nd), dtype=np.float)*fillValueI
634
635            dimt = len(tvals)
636            Nlost = 0
637            if dbg: print ' time-step lon lat ix iy passes _______'
638            for it in range(dimt):
639                lon = dvalues[dscn['NAMElon']][it]
640                lat = dvalues[dscn['NAMElat']][it]
641                if lon is  not None and lat is not None:
642                    ilon = int((Nd-1)*(lon - minlon)/(maxlon - minlon))
643                    ilat = int((Nd-1)*(lat - minlat)/(maxlat - minlat))
644
645                    if map2D[ilat,ilon] == fillValueI: 
646                        map2D[ilat,ilon] = 1
647                    else:
648                        map2D[ilat,ilon] = map2D[ilat,ilon] + 1
649                    if dbg: print it, lon, lat, ilon, ilat, map2D[ilat,ilon]
650
651            newvar = onc.createVariable( 'trjobs', 'i', ('lat2D', 'lon2D'),          \
652              fill_value = fillValueI)
653            basicvardef(newvar, 'trajectory_observations', 'number of passes', '-' )
654            newvar[:] = map2D
655            newattr = set_attribute(newvar, 'coordinates', 'lon2D lat2D')
656
657        else:
658            ivn = 0
659            for vn in dscn['varN']:
660                if vn == dscn['NAMEheight']: 
661                    zu = dscn['varU'][ivn]
662                    break
663                ivn = ivn + 1
664                   
665            objfile.createDimension('z2D',Nd)
666            zvals = ma.masked_equal(dvalues[dscn['NAMEheight']], None)
667            minz = min(zvals)
668            maxz = max(zvals)
669
670            bz = (maxz - minz)/(Nd-1)
671
672            newvar = onc.createVariable( 'z2D', 'f8', ('z2D'))
673            basicvardef(newvar, 'z2D', 'z-coordinate map observations', zu)
674            newvar[:] = minz + np.arange(Nd)*bz
675            newattr = set_attribute(newvar, 'axis', 'Z')
676
677            if dbg:
678                print '  ' + fname + ': zmin=',minz,zu,'zmax=',maxz,zu
679                print '  ' + fname + ': precission on z-axis=', bz*(Nd-1), zu
680
681            map3D = np.ones((Nd, Nd, Nd), dtype=int)*fillValueI
682            dimt = len(tvals)
683            Nlost = 0
684            if dbg: print ' time-step lon lat z ix iy iz passes _______'
685            for it in range(dimt):
686                lon = dvalues[dscn['NAMElon']][it]
687                lat = dvalues[dscn['NAMElat']][it]
688                z = dvalues[dscn['NAMEheight']][it]
689                if lon is  not None and lat is not None and z is not None:
690                    ilon = int((Nd-1)*(lon - minlon)/(maxlon - minlon))
691                    ilat = int((Nd-1)*(lat - minlat)/(maxlat - minlat))
692                    iz = int((Nd-1)*(z - minz)/(maxz - minz))
693
694                    if map3D[iz,ilat,ilon] == fillValueI: 
695                        map3D[iz,ilat,ilon] = 1
696                    else:
697                        map3D[iz,ilat,ilon] = map3D[iz,ilat,ilon] + 1
698                    if dbg: print it, lon, lat, z, ilon, ilat, iz, map3D[iz,ilat,ilon]
699
700            newvar = onc.createVariable( 'trjobs', 'i', ('z2D', 'lat2D', 'lon2D'),   \
701              fill_value = fillValueI)
702            basicvardef(newvar, 'trajectory_observations', 'number of passes', '-')
703            newvar[:] = map3D
704            newattr = set_attribute(newvar, 'coordinates', 'lon2D lat2D z2D')
705
706    onc.sync()
707    return
708
709def adding_station_desc(onc,stdesc):
710    """ Function to add a station description in a netCDF file
711      onc= netCDF object
712      stdesc= station description name, lon, lat, height
713    """
714    fname = 'adding_station_desc'
715
716    newdim = onc.createDimension('nst',1)
717
718    newvar = objfile.createVariable( 'station', 'c', ('nst','StrLength'))
719    writing_str_nc(newvar, [stdesc[0].replace('!', ' ')], StringLength)
720
721    newvar = objfile.createVariable( 'lonstGDM', 'c', ('nst','StrLength'))
722    Gv = int(stdesc[1])
723    Dv = int((stdesc[1] - Gv)*60.)
724    Mv = int((stdesc[1] - Gv - Dv/60.)*3600.)
725    writing_str_nc(newvar, [str(Gv)+"d" + str(Dv)+"m" + str(Mv)+'s'], StringLength)
726
727    if onc.variables.has_key('lon'):
728        print warnmsg
729        print '  ' + fname + ": variable 'lon' already exist !!"
730        print "    renaming it as 'lonst'"
731        lonname = 'lonst'
732    else:
733        lonname = 'lon'
734
735    newvar = objfile.createVariable( lonname, 'f4', ('nst'))
736    basicvardef(newvar, lonname, 'longitude', 'degrees_West' )
737    newvar[:] = stdesc[1]
738
739    newvar = objfile.createVariable( 'latstGDM', 'c', ('nst','StrLength'))
740    Gv = int(stdesc[2])
741    Dv = int((stdesc[2] - Gv)*60.)
742    Mv = int((stdesc[2] - Gv - Dv/60.)*3600.)
743    writing_str_nc(newvar, [str(Gv)+"d" + str(Dv)+"m" + str(Mv)+'s'], StringLength)
744
745    if onc.variables.has_key('lat'):
746        print warnmsg
747        print '  ' + fname + ": variable 'lat' already exist !!"
748        print "    renaming it as 'latst'"
749        latname = 'latst'
750    else:
751        latname = 'lat'
752
753    newvar = objfile.createVariable( latname, 'f4', ('nst'))
754    basicvardef(newvar, lonname, 'latitude', 'degrees_North' )
755    newvar[:] = stdesc[2]
756
757    if onc.variables.has_key('height'):
758        print warnmsg
759        print '  ' + fname + ": variable 'height' already exist !!"
760        print "    renaming it as 'heightst'"
761        heightname = 'heightst'
762    else:
763        heightname = 'height'
764
765    newvar = objfile.createVariable( heightname, 'f4', ('nst'))
766    basicvardef(newvar, heightname, 'height above sea level', 'm' )
767    newvar[:] = stdesc[3]
768
769    return
770
771def oper_values(dvals, opers):
772    """ Function to operate the values according to given parameters
773      dvals= datavalues
774      opers= operations
775    """
776    fname = 'oper_values'
777
778    newdvals = {}
779    varnames = dvals.keys()
780
781    aopers = ['sumc','subc','mulc','divc']
782
783    Nopers = len(opers)
784    for iop in range(Nopers):
785        vn = varnames[iop]
786        print vn,'oper:',opers[iop]
787        if opers[iop] != '-':
788            opern = opers[iop].split(',')[0]
789            operv = np.float(opers[iop].split(',')[1])
790
791            vvals = np.array(dvals[vn])
792
793            if opern == 'sumc': 
794              newvals = np.where(vvals is None, None, vvals+operv)
795            elif opern == 'subc': 
796              newvals = np.where(vvals is None, None, vvals-operv)
797            elif opern == 'mulc': 
798              newvals = np.where(vvals is None, None, vvals*operv)
799            elif opern == 'divc': 
800              newvals = np.where(vvals is None, None, vvals/operv)
801            else: 
802                print errormsg
803                print '  ' + fname + ": operation '" + opern + "' not ready!!"
804                print '    availables:',aopers
805                quit(-1)
806
807            newdvals[vn] = list(newvals)
808        else:
809            newdvals[vn] = dvals[vn]
810
811    return newdvals
812
813####### ###### ##### #### ### ## #
814
815strCFt="Refdate,tunits (CF reference date [YYYY][MM][DD][HH][MI][SS] format and " +  \
816  " and time units: 'weeks', 'days', 'hours', 'miuntes', 'seconds')"
817
818kindobs=['multi-points', 'single-station', 'trajectory']
819strkObs="kind of observations; 'multi-points': multiple individual punctual obs " +  \
820  "(e.g., lightning strikes), 'single-station': single station on a fixed position,"+\
821  "'trajectory': following a trajectory"
822
823parser = OptionParser()
824parser.add_option("-c", "--comments", dest="charcom",
825  help="':', list of characters used for comments", metavar="VALUES")
826parser.add_option("-d", "--descriptionfile", dest="fdesc",
827  help="description file to use" + read_description.__doc__, metavar="FILE")
828parser.add_option("-e", "--end_column", dest="endcol",
829  help="character to indicate end of the column ('space', for ' ')", metavar="VALUE")
830parser.add_option("-f", "--file", dest="obsfile",
831  help="observational file to use", metavar="FILE")
832parser.add_option("-g", "--debug", dest="debug",
833  help="whther debug is required ('false', 'true')", metavar="VALUE")
834parser.add_option("-k", "--kindObs", dest="obskind", type='choice', choices=kindobs, 
835  help=strkObs, metavar="VALUE")
836parser.add_option("-s", "--stationLocation", dest="stloc", 
837  help="name ('!' for spaces), longitude, latitude and height of the station (only for 'single-station')", 
838  metavar="FILE")
839parser.add_option("-t", "--CFtime", dest="CFtime", help=strCFt, metavar="VALUE")
840
841(opts, args) = parser.parse_args()
842
843#######    #######
844## MAIN
845    #######
846
847ofile='OBSnetcdf.nc'
848
849if opts.charcom is None:
850    print warnmsg
851    print '  ' + main + ': No list of comment characters provided!!'
852    print '    assuming no need!'
853    charcomments = []
854else:
855    charcomments = opts.charcom.split(':')   
856
857if opts.fdesc is None:
858    print errormsg
859    print '  ' + main + ': No description file for the observtional data provided!!'
860    quit(-1)
861
862if opts.endcol is None:
863    print warnmsg
864    print '  ' + main + ': No list of comment characters provided!!'
865    print "    assuming 'space'"
866    endcol = ' '
867else:
868    if opts.endcol == 'space':
869        endcol = ' '
870    else:
871        endcol = opts.endcol
872
873if opts.obsfile is None:
874    print errormsg
875    print '  ' + main + ': No observations file provided!!'
876    quit(-1)
877
878if opts.debug is None:
879    print warnmsg
880    print '  ' + main + ': No debug provided!!'
881    print "    assuming 'False'"
882    debug = False
883else:
884    if opts.debug == 'true':
885        debug = True
886    else:
887        debug = False
888
889if not os.path.isfile(opts.fdesc):
890    print errormsg
891    print '   ' + main + ": description file '" + opts.fdesc + "' does not exist !!"
892    quit(-1)
893
894if not os.path.isfile(opts.obsfile):
895    print errormsg
896    print '   ' + main + ": observational file '" + opts.obsfile + "' does not exist !!"
897    quit(-1)
898
899if opts.CFtime is None:
900    print warnmsg
901    print '  ' + main + ': No CFtime criteria are provided !!'
902    print "    either time is already in CF-format ('timeFMT=CFtime') in '" +        \
903      opts.fdesc + "'"
904    print "    or assuming refdate: '19491201000000' and time units: 'hours'"
905    referencedate = '19491201000000'
906    timeunits = 'hours'
907else:
908    referencedate = opts.CFtime.split(',')[0]
909    timeunits = opts.CFtime.split(',')[1]
910
911if opts.obskind is None:
912    print warnmsg
913    print '  ' + main + ': No kind of observations provided !!'
914    print "    assuming 'single-station': single station on a fixed position at 0,0,0"
915    obskind = 'single-station'
916    stationdesc = [0.0, 0.0, 0.0, 0.0]
917else:
918    obskind = opts.obskind
919    if obskind == 'single-station':
920        if opts.stloc is None:
921            print errornmsg
922            print '  ' + main + ': No station location provided !!'
923            quit(-1)
924        else:
925            stvals = opts.stloc.split(',')
926            stationdesc = [stvals[0], np.float(stvals[1]), np.float(stvals[2]),      \
927              np.float(stvals[3])]
928    else:
929        obskind = opts.obskind
930
931# Reading description file
932##
933description = read_description(opts.fdesc, debug)
934
935Nvariables=len(description['varN'])
936formats = description['varTYPE']
937
938if len(formats) != Nvariables: 
939    print errormsg
940    print '  ' + main + ': number of formats:',len(formats),' and number of ' +     \
941      'variables', Nvariables,' does not coincide!!'
942    print '    * what is found is _______'
943    if Nvariables > len(formats):
944        Nshow = len(formats)
945        for ivar in range(Nshow):
946            print '      ',description['varN'][ivar],':', description['varLN'][ivar],\
947               '[', description['varU'][ivar], '] fmt:', formats[ivar]
948        print '      missing values for:', description['varN'][Nshow:Nvariables+1]
949    else:
950        Nshow = Nvariables
951        for ivar in range(Nshow):
952            print '      ',description['varN'][ivar],':', description['varLN'][ivar],\
953               '[', description['varU'][ivar], '] fmt:', formats[ivar]
954        print '      excess of formats for:', formats[Nshow:len(formats)+1]
955
956#    quit(-1)
957
958# Reading values
959##
960datavalues = read_datavalues(opts.obsfile, charcomments, endcol, formats, 
961  description['varOPER'], description['MissingValue'], description['varN'], debug)
962
963# Total number of values
964Ntvalues = len(datavalues[description['varN'][0]])
965print main + ': total temporal values found:',Ntvalues
966
967objfile = NetCDFFile(ofile, 'w')
968 
969# Creation of dimensions
970##
971objfile.createDimension('time',None)
972objfile.createDimension('StrLength',StringLength)
973
974# Creation of variables
975##
976for ivar in range(Nvariables):
977    varn = description['varN'][ivar]
978    print "  including: '" + varn + "' ... .. ."
979
980    if formats[ivar] == 'D':
981        newvar = objfile.createVariable(varn, 'f32', ('time'), fill_value=fillValueF)
982        basicvardef(newvar, varn, description['varLN'][ivar],                        \
983          description['varU'][ivar])
984        newvar[:] = np.where(datavalues[varn] is None, fillValueF, datavalues[varn])
985    elif formats[ivar] == 'F':
986        newvar = objfile.createVariable(varn, 'f', ('time'), fill_value=fillValueF)
987        basicvardef(newvar, varn, description['varLN'][ivar],                        \
988          description['varU'][ivar])
989        newvar[:] = np.where(datavalues[varn] is None, fillValueF, datavalues[varn])
990    elif formats[ivar] == 'I':
991        newvar = objfile.createVariable(varn, 'i', ('time'), fill_value=fillValueI)
992        basicvardef(newvar, varn, description['varLN'][ivar],                        \
993          description['varU'][ivar])
994# Why is not wotking with integers?
995        vals = np.array(datavalues[varn])
996        for iv in range(Ntvalues):
997            if vals[iv] is None: vals[iv] = fillValueI
998        newvar[:] = vals
999    elif formats[ivar] == 'S':
1000        newvar = objfile.createVariable(varn, 'c', ('time','StrLength'))
1001        basicvardef(newvar, varn, description['varLN'][ivar],                        \
1002          description['varU'][ivar])
1003        writing_str_nc(newvar, datavalues[varn], StringLength)
1004
1005# Extra variable descriptions/attributes
1006    if description.has_key('varBUFR'): 
1007        set_attribute(newvar,'bufr_code',description['varBUFR'][ivar])
1008
1009    objfile.sync()
1010
1011# Time variable in CF format
1012##
1013if description['FMTtime'] == 'CFtime':
1014    timevals = datavalues[description['NAMEtime']]
1015    iv = 0
1016    for ivn in description['varN']:
1017        if ivn == description['NAMEtime']:
1018            tunits = description['varU'][iv]
1019            break
1020        iv = iv + 1
1021else:
1022    # Time as a composition of different columns
1023    tcomposite = description['NAMEtime'].find('@')
1024    if tcomposite != -1:
1025        timevars = description['NAMEtime'].split('@')
1026
1027        print warnmsg
1028        print '  ' + main + ': time values as combination of different columns!'
1029        print '    combining:',timevars,' with a final format: ',description['FMTtime']
1030
1031        timeSvals = []
1032        if debug: print '  ' + main + ': creating times _______'
1033        for it in range(Ntvalues):
1034            tSvals = ''
1035            for tvar in timevars:
1036                tSvals = tSvals + datavalues[tvar][it] + ' '
1037
1038            timeSvals.append(tSvals[0:len(tSvals)-1])
1039            if debug: print it, '*' + timeSvals[it] + '*'
1040
1041        timevals = Stringtimes_CF(timeSvals, description['FMTtime'], referencedate,      \
1042          timeunits, debug)
1043    else:
1044        timevals = Stringtimes_CF(datavalues[description['NAMEtime']],                   \
1045          description['FMTtime'], referencedate, timeunits, debug)
1046
1047    CFtimeRef = referencedate[0:4] +'-'+ referencedate[4:6] +'-'+ referencedate[6:8] +   \
1048      ' ' + referencedate[8:10] +':'+ referencedate[10:12] +':'+ referencedate[12:14]
1049    tunits = timeunits + ' since ' + CFtimeRef
1050
1051if objfile.variables.has_key('time'):
1052    print warnmsg
1053    print '  ' + main + ": variable 'time' already exist !!"
1054    print "    renaming it as 'CFtime'"
1055    timeCFname = 'CFtime'
1056    newdim = objfile.renameDimension('time','CFtime')
1057    newvar = objfile.createVariable( timeCFname, 'f8', ('CFtime'))
1058    basicvardef(newvar, timeCFname, 'time', tunits )
1059else:
1060    timeCFname = 'time'
1061    newvar = objfile.createVariable( timeCFname, 'f8', ('time'))
1062    basicvardef(newvar, timeCFname, 'time', tunits )
1063
1064set_attribute(newvar, 'calendar', 'standard')
1065newvar[:] = timevals
1066
1067# Global attributes
1068##
1069for descn in description.keys():
1070    if descn[0:3] != 'var' and descn[0:4] != 'NAME' and descn[0:3] != 'FMT':
1071        set_attribute(objfile, descn, description[descn])
1072
1073set_attribute(objfile,'author_nc','Lluis Fita')
1074set_attribute(objfile,'institution_nc','Laboratoire de Meteorology Dynamique, ' +    \
1075  'LMD-Jussieu, UPMC, Paris')
1076set_attribute(objfile,'country_nc','France')
1077set_attribute(objfile,'script_nc','create_OBSnetcdf.py')
1078set_attribute(objfile,'version_script',version)
1079set_attribute(objfile,'information',                                                 \
1080  'http://www.lmd.jussieu.fr/~lflmd/ASCIIobs_nc/index.html')
1081
1082objfile.sync()
1083
1084# Adding new variables as function of the observational type
1085## 'multi-points', 'single-station', 'trajectory'
1086
1087if obskind != 'single-station':
1088    adding_complementary(objfile, description, obskind, datavalues, timevals,        \
1089      referencedate, timeunits, Ndim2D, debug)
1090else:
1091# Adding three variables with the station location, longitude, latitude and height
1092    adding_station_desc(objfile,stationdesc)
1093
1094objfile.sync()
1095objfile.close()
1096
1097print main + ": Successfull generation of netcdf observational file '" + ofile + "' !!"
Note: See TracBrowser for help on using the repository browser.