source: CCCC/tags/1.2.5/ceda_cc/utils_c4.py @ 221

Subversion URL: http://proj.badc.rl.ac.uk/svn/exarch/CCCC/tags/1.2.5/ceda_cc/utils_c4.py@1241
Revision 221, 38.3 KB checked in by mjuckes, 6 years ago (diff)

error in SPECS drsMappings fixed

Line 
1import string, re, os, sys, traceback, ctypes
2
3def strmm3( mm ):
4  return string.join( map( lambda x: '%s="%s" [correct: "%s"]' % x, mm ), '; ' )
5
6from fcc_utils import mipTableScan
7from xceptions import *
8
9class reportSection(object):
10
11  def __init__(self,id,cls,parent=None, description=None):
12    self.id = id
13    self.cls = cls
14    self.parent = parent
15    self.description = description
16    self.records = []
17    self.subsections = []
18    self.closed = False
19    self.npass = 0
20    self.fail = 0
21    self.auditDone = True
22
23  def addSubSection( self, id, cls, description=None):
24    assert not self.closed, 'Attempt to add sub-section to closed report section'
25    self.subsections.append( reportSection(id, cls, parent=self, description=description )  )
26    self.auditDone = False
27    return self.subsections[-1]
28
29  def addRecord( self, id, cls, res, msg ):
30    assert not self.closed, 'Attempt to add record to closed report section'
31    self.records.append( (id, cls, res, msg) )
32    self.auditDone = False
33
34  def close(self):
35    self.closed = True
36
37  def reopen(self):
38    self.closed = False
39
40  def audit(self):
41    if self.auditDone:
42      return
43    self.closed = True
44    self.fail = 0
45    self.npass = 0
46    for ss in self.subsections:
47      ss.audit()
48      self.fail += ss.fail
49      self.npass += ss.npass
50
51    for r in self.records:
52      if r[2]:
53        self.npass += 1
54      else:
55        self.fail += 1
56
57class checkSeq(object):
58  def __init__(self):
59    pass
60
61  def check(self,x):
62    d = map( lambda i: x[i+1] - x[i], range(len(x)-1) )
63    self.delt = sum(d)/len(d)
64    self.dmx = max(d)
65    self.dmn = min(d)
66    return self.dmx - self.dmn < abs(self.delt)*1.e-4
67
68cs = checkSeq()
69
70class checkBase(object):
71
72  def  __init__(self,cls="CORDEX",reportPass=True,parent=None,monitor=None):
73    self.cls = cls
74    self.project = cls
75    self.abortMessageCount = parent.abortMessageCount
76    self.monitor = monitor
77    ## check done earlier
78    ## assert cls in ['CORDEX','SPECS'],'This version of the checker only supports CORDEX, SPECS'
79    self.re_isInt = re.compile( '[0-9]+' )
80    self.errorCount = 0
81    self.passCount = 0
82    self.missingValue = 1.e20
83    self.missingValue = ctypes.c_float(1.00000002004e+20).value
84    from file_utils import ncLib
85    if ncLib == 'netCDF4':
86      import numpy
87      self.missingValue = numpy.float32(self.missingValue)
88    self.parent = parent
89    self.reportPass=reportPass
90    self.pcfg = parent.pcfg
91################################
92    self.requiredGlobalAttributes = self.pcfg.requiredGlobalAttributes
93    self.controlledGlobalAttributes = self.pcfg.controlledGlobalAttributes
94    self.globalAttributesInFn = self.pcfg.globalAttributesInFn
95    self.requiredVarAttributes = self.pcfg.requiredVarAttributes
96    self.drsMappings = self.pcfg.drsMappings
97#######################################
98    self.checks = ()
99    self.messageCount = 0
100    self.init()
101    if not hasattr( self.parent, 'amapListDraft' ):
102      self.parent.amapListDraft = []
103
104  def isInt(self,x):
105    return self.re_isInt.match( x ) != None
106
107  def logMessage(self, msg, error=False ):
108    self.messageCount += 1
109    assert self.abortMessageCount < 0 or self.abortMessageCount > self.messageCount, 'Raising error [TESTX01], perhaps for testing'
110    if self.parent != None and self.parent.log != None:
111       if error:
112         self.parent.log.error( msg )
113       else:
114         self.parent.log.info( msg )
115    else:
116       print msg
117
118    doThis = True
119    if self.appendLogfile[0] != None and doThis:
120      if self.monitor != None:
121         nofh0 = self.monitor.get_open_fds()
122      xlog = self.c4i.getFileLog( self.appendLogfile[1], flf=self.appendLogfile[0] )
123      if error:
124         xlog.error( msg )
125      else:
126         xlog.info( msg )
127      self.c4i.closeFileLog()
128      if self.monitor != None:
129         nofh9 = self.monitor.get_open_fds()
130         if nofh9 > nofh0:
131           print 'Leaking file handles [1]: %s --- %s' % (nofh0, nofh9)
132
133  def log_exception( self, msg):
134    if self.parent != None and self.parent.log != None:
135        self.parent.log.error("Exception has occured" ,exc_info=1)
136    else:
137        traceback.print_exc(file=sys.stdout)
138
139  def log_error( self, msg ):
140    self.lastError = msg
141    self.errorCount += 1
142    self.logMessage( '%s.%s: FAILED:: %s' % (self.id,self.getCheckId(),msg), error=True )
143
144  def log_pass( self ):
145    self.passCount = True
146    if self.reportPass:
147      self.logMessage(  '%s.%s: OK' % (self.id,self.getCheckId()) )
148
149  def log_abort( self ):
150    self.completed = False
151    self.logMessage(   '%s.%s: ABORTED:: Errors too severe to complete further checks in this module' % (self.id,'xxx') )
152    raise abortChecks
153
154  def status(self):
155    return '%s.%s' % (self.id,self.getCheckId())
156
157  def getCheckId(self,full=True):
158    if type( self.checkId ) == type( 'x' ):
159      return self.checkId
160    else:
161      if full:
162        return '%s: [%s]' % self.checkId
163      else:
164        return self.checkId[0]
165
166  def test(self,res,msg,abort=False,part=False,appendLogfile=(None,None)):
167    self.appendLogfile = appendLogfile
168    if res:
169      if not part:
170         self.log_pass()
171    else:
172      self.log_error(msg)
173      if abort:
174        self.log_abort()
175    return res
176
177  def runChecks(self):
178
179    try:
180      for c in self.checks:
181        c()  # run check
182      self.completed = True
183    except abortChecks:
184      ## error logging done before raising this exception
185      return
186    except:
187      self.log_exception( 'Exception caught by runChecks' )
188      raise loggedException
189      ##traceback.print_exc(file=open("errlog.txt","a"))
190      ##logger.error("Exception has occured" ,exc_info=1)
191   
192class checkFileName(checkBase):
193
194  def init(self):
195    self.id = 'C4.001'
196    self.checkId = 'unset'
197    self.step = 'Initialised'
198    self.checks = (self.do_check_fn,)
199####
200
201  def check(self,fn):
202    self.errorCount = 0
203    assert type(fn) in [type('x'),type(u'x')], '1st argument to "check" method of checkGrids shound be a string variable name (not %s)' % type(fn)
204    self.fn = fn
205
206    self.runChecks()
207###
208  def do_check_fn(self):
209    fn = self.fn
210    self.errorCount = 0
211    self.completed = False
212
213## check basic parsing of file name
214    self.checkId = ('001','parse_filename')
215    self.test( fn[-3:] == '.nc', 'File name ending ".nc" expected', abort=True, part=True )
216    bits = string.split( fn[:-3], '_' )
217    self.fnParts = bits[:]
218
219    if self.pcfg.domainIndex != None:
220      self.domain = self.fnParts[self.pcfg.domainIndex]
221    else:
222      self.domain = None
223
224    self.test( len(bits) in self.pcfg.fnPartsOkLen, 'File name not parsed in %s elements [%s]' % (str(self.pcfg.fnPartsOkLen),str(bits)), abort=True )
225
226    if self.pcfg.groupIndex != None:
227      self.group = self.fnParts[self.pcfg.groupIndex]
228    else:
229      self.group = None
230
231    if self.pcfg.freqIndex != None:
232      self.freq = self.fnParts[self.pcfg.freqIndex]
233    elif self.group == 'fx':
234      self.freq = 'fx'
235    else:
236      self.freq = None
237
238    ##if self.cls == 'CORDEX':
239      ##self.freq = self.fnParts[7]
240    ##elif self.cls == 'SPECS':
241      ##self.freq = self.fnParts[1]
242
243    self.var = self.fnParts[0]
244
245    self.isFixed = self.freq == 'fx'
246    if self.isFixed:
247      self.test( len(self.fnParts) in self.pcfg.fnPartsOkFixedLen, 'Number of file name elements not acceptable for fixed data' )
248
249    self.checkId = ('002','parse_filename_timerange')
250    if not self.isFixed:
251
252## test time segment
253      bits = string.split( self.fnParts[-1], '-' )
254      self.test( len(bits) == 2, 'File time segment [%s] will not parse into 2 elements' % (self.fnParts[-1] ), abort=True, part=True )
255
256      self.test(  len(bits[0]) == len(bits[1]), 'Start and end time specified in file name [%s] of unequal length' % (self.fnParts[-1] ), abort=True, part=True  )
257
258      for b in bits:
259        self.test( self.isInt(b), 'Time segment in filename [%s] contains non integer characters' % (self.fnParts[-1] ),  abort=True, part=True  )
260      self.log_pass()
261      self.fnTimeParts = bits[:]
262
263    self.checkId = '003'
264
265    self.checkId, ok = (('004','filename_timerange_length'),True)
266    if (not self.isFixed) and self.pcfg.checkTrangeLen:
267      ltr = { 'mon':6, 'sem':6, 'day':8, '3hr':[10,12], '6hr':10 }
268      ok &=self.test( self.freq in ltr.keys(), 'Frequency [%s] not recognised' % self.freq, part=True )
269      if ok:
270        if type( ltr[self.freq] ) == type(0):
271          msg = 'Length of time range parts [%s,%s] not equal to required length [%s] for frequency %s' % (self.fnTimeParts[0],self.fnTimeParts[1],ltr[self.freq],self.freq)
272          ok &= self.test( len(self.fnTimeParts[0]) == ltr[self.freq], msg, part=True )
273        elif type( ltr[self.freq] ) in [type([]),type( () )]:
274          msg = 'Length of time range parts [%s,%s] not in acceptable list [%s] for frequency %s' % (self.fnTimeParts[0],self.fnTimeParts[1],str(ltr[self.freq]),self.freq)
275          ok &= self.test( len(self.fnTimeParts[0]) in ltr[self.freq], msg, part=True )
276
277      if ok:
278        self.log_pass()
279    self.completed = True
280
281class checkGlobalAttributes(checkBase):
282
283  def init(self):
284    self.id = 'C4.002'
285    self.checkId = 'unset'
286    self.step = 'Initialised'
287    self.checks = (self.do_check_ga,)
288
289  def check(self,globalAts, varAts,varName,varGroup, vocabs, fnParts):
290    self.errorCount = 0
291    assert type(varName) in [type('x'),type(u'x')], '1st argument to "check" method of checkGrids shound be a string variable name (not %s)' % type(varName)
292    self.var = varName
293    self.globalAts = globalAts
294    self.varAts = varAts
295    self.varGroup = varGroup
296    self.vocabs = vocabs
297    self.fnParts = fnParts
298    self.runChecks()
299
300  def getDrs( self ):
301    assert self.completed, 'method getDrs should not be called if checks have not been completed successfully'
302    ee = {}
303    if not self.globalAts.has_key('product'):
304        self.globalAts['product'] = 'output'
305    for k in self.drsMappings:
306      if self.drsMappings[k] == '@var':
307        ee[k] = self.var
308      elif self.drsMappings[k] == '@ensemble':
309        ee[k] = "r%si%sp%s" % (self.globalAts["realization"],self.globalAts["initialization_method"],self.globalAts["physics_version"])
310      elif self.drsMappings[k] == '@forecast_reference_time':
311        x = self.globalAts.get("forecast_reference_time",'yyyy-mm-dd Thh:mm:ssZ' )
312        ee[k] = "%s%s%s" % (x[:4],x[5:7],x[8:10])
313      elif self.drsMappings[k] == '@mip_id':
314        ee[k] = string.split( self.globalAts["table_id"] )[1]
315      else:
316        ee[k] = self.globalAts[ self.drsMappings[k] ]
317
318    for k in ['creation_date','tracking_id']:
319      if k in self.globalAts.keys():
320        ee[k] = self.globalAts[k]
321
322    return ee
323
324  def do_check_ga(self):
325    varName = self.var
326    globalAts = self.globalAts
327    varAts = self.varAts
328    varGroup = self.varGroup
329    vocabs = self.vocabs
330    fnParts = self.fnParts
331
332    self.completed = False
333    self.checkId = ('001','global_ncattribute_present')
334    m = []
335    for k in self.requiredGlobalAttributes:
336      if not globalAts.has_key(k):
337         m.append(k)
338         self.globalAts[k] = '__errorReported__'
339
340    if not self.test( len(m)  == 0, 'Required global attributes missing: %s' % str(m) ):
341      gaerr = True
342      for k in m:
343        self.parent.amapListDraft.append( '#@;%s=%s|%s=%s' % (k,'__absent__',k,'<insert attribute value and uncomment>') )
344
345    self.checkId = ('002','variable_in_group')
346
347    self.test( varAts.has_key( varName ), 'Expected variable [%s] not present' % varName, abort=True, part=True )
348    msg = 'Variable %s not in table %s' % (varName,varGroup)
349    self.test( vocabs['variable'].isInTable( varName, varGroup ), msg, abort=True, part=True )
350
351    self.checkId = ('003','variable_type')
352
353    mipType = vocabs['variable'].getAttr( varName, varGroup, 'type' )
354    thisType = {'real':'float32', 'integer':'int32', 'float':'float32', 'double':'float64' }.get( mipType, mipType )
355    self.test( mipType == None or varAts[varName]['_type'] == thisType, 'Variable [%s/%s] not of type %s [%s]' % (varName,varGroup,str(thisType),varAts[varName]['_type']) )
356
357    self.checkId = ('004','variable_ncattribute_present')
358    m = []
359    reqAts = self.requiredVarAttributes[:]
360    if varGroup != 'fx' and self.pcfg.project in ['CORDEX']:
361      reqAts.append( 'cell_methods' )
362    for k in reqAts + vocabs['variable'].lists(varName, 'addRequiredAttributes'):
363      if not varAts[varName].has_key(k):
364         m.append(k)
365    if not self.test( len(m)  == 0, 'Required variable attributes missing: %s' % str(m) ):
366      vaerr = True
367      for k in m:
368        self.parent.amapListDraft.append( '#@var=%s;%s=%s|%s=%s' % (varName,k,'__absent__',k,'<insert attribute value and uncomment>') )
369        print self.parent.amapListDraft[-1]
370    ##vaerr = not self.test( len(m)  == 0, 'Required variable attributes missing: %s' % str(m) )
371
372    ##if vaerr or gaerr:
373      ##self.log_abort()
374
375## need to insert a check that variable is present
376    self.checkId = ('005','variable_ncattribute_mipvalues')
377    ok = True
378    hm = varAts[varName].get( 'missing_value', None ) != None
379    hf = varAts[varName].has_key( '_FillValue' )
380    if hm or hf:
381      ok &= self.test( hm, 'missing_value must be present if _FillValue is [%s]' % varName )
382      ok &= self.test( hf, '_FillValue must be present if missing_value is [%s]' % varName )
383      if mipType == 'real':
384        if varAts[varName].has_key( 'missing_value' ):
385           msg = 'Variable [%s] has incorrect attribute missing_value=%s [correct: %s]' % (varName,varAts[varName]['missing_value'],self.missingValue)
386           ## print varAts[varName]['missing_value'], type(varAts[varName]['missing_value'])
387           ## print self.missingValue, type(self.missingValue)
388### need to use ctypes here when using ncq3 to read files -- appears OK for other libraries.
389           ok &= self.test( ctypes.c_float(varAts[varName]['missing_value']).value == ctypes.c_float(self.missingValue).value, msg, part=True )
390        if varAts[varName].has_key( '_FillValue' ):
391           msg = 'Variable [%s] has incorrect attribute _FillValue=%s [correct: %s]' % (varName,varAts[varName]['_FillValue'],self.missingValue)
392           ok &= self.test( varAts[varName]['_FillValue'] == self.missingValue, msg, part=True )
393
394    mm = []
395   
396    contAts = ['long_name', 'standard_name', 'units']
397    if varGroup != 'fx':
398      contAts.append( 'cell_methods' )
399    hcm = varAts[varName].has_key( "cell_methods" )
400    for k in contAts + vocabs['variable'].lists(varName,'addControlledAttributes'):
401      targ = varAts[varName].get( k, 'Attribute not present' )
402      val = vocabs['variable'].getAttr( varName, varGroup, k )
403
404      if k == "cell_methods":
405        if val != None:
406          parenthesies1 = []
407          targ0 = targ[:]
408          while string.find( targ, '(' ) != -1:
409            i0 = targ.index( '(' )
410            i1 = targ.index( ')' )
411            parenthesies1.append( targ[i0:i1+1] )
412            targ = targ[:i0-1] + targ[i1+1:]
413          parenthesies2 = []
414          val0 = val[:]
415          while string.find( val, '(' ) != -1:
416            i0 = val.index( '(' )
417            i1 = val.index( ')' )
418            parenthesies2.append( val[i0:i1+1] )
419            val = val[:i0-1] + val[i1+1:]
420          for p in parenthesies2:
421            if p not in parenthesies1:
422              mm.append( (k,parenthesies1,p) )
423          if string.find( targ, val):
424             mm.append( (k,targ,val) )
425      elif targ != 'Attribute not present' and targ != val:
426        mm.append( (k,targ,val) )
427
428    ok &= self.test( len(mm)  == 0, 'Variable [%s] has incorrect attributes: %s' % (varName, strmm3(mm)), part=True )
429    if len( mm  ) != 0:
430      if self.parent.amapListDraft == None:
431        self.parent.amapListDraft = []
432      for m in mm:
433          self.parent.amapListDraft.append( '@var=%s;%s=%s|%s=%s' % (varName,m[0],m[1],m[0],m[2]) )
434
435    if ok:
436       self.log_pass()
437
438    if varGroup != 'fx' and hcm:
439      self.isInstantaneous = string.find( varAts[varName]['cell_methods'], 'time: point' ) != -1
440    else:
441      self.isInstantaneous = True
442
443    self.checkId = ('006','global_ncattribute_cv' )
444    m = []
445    for a in self.controlledGlobalAttributes:
446      if globalAts.has_key(a):
447        try:
448          if not vocabs[a].check( str(globalAts[a]) ):
449            m.append( (a,globalAts[a],vocabs[a].note) )
450        except:
451          print 'failed trying to check global attribute %s' % a
452          raise baseException( 'failed trying to check global attribute %s' % a )
453
454    if not self.test( len(m)  == 0, 'Global attributes do not match constraints: %s' % str(m) ):
455      for t in m:
456        self.parent.amapListDraft.append( '#@;%s=%s|%s=%s' % (t[0],str(t[1]),t[0],'<insert attribute value and uncomment>' + str(t[2]) ) )
457
458    self.checkId = ('007','filename_filemetadata_consistency')
459    m = []
460    for i in range(len(self.globalAttributesInFn)):
461       if self.globalAttributesInFn[i] != None:
462         targVal = fnParts[i]
463         if self.globalAttributesInFn[i][0] == "@":
464           if self.globalAttributesInFn[i][1:] == "mip_id":
465               bits = string.split( globalAts[ "table_id" ] ) 
466               if len( bits ) > 2 and bits[0] == "Table":
467                 thisVal = bits[1]
468               else:
469                 thisVal = globalAts[ "table_id" ]
470                 self.test( False, 'Global attribute table_id does not conform to CMOR pattern ["Table ......"]: %s' % thisVal, part=True)
471           elif self.globalAttributesInFn[i][1:] == "experiment_family":
472               thisVal = globalAts["experiment_id"][:-4]
473           elif self.globalAttributesInFn[i][1:] == "ensemble":
474               thisVal = "r%si%sp%s" % (globalAts["realization"],globalAts["initialization_method"],globalAts["physics_version"])
475           elif self.globalAttributesInFn[i][1:] == "forecast_reference_time":
476               x = self.globalAts.get("forecast_reference_time",'yyyy-mm-dd Thh:mm:ssZ' )
477               thisVal = "S%s%s%s" % (x[:4],x[5:7],x[8:10])
478           elif self.globalAttributesInFn[i][1:] == "series":
479               thisVal = 'series%s' % globalAts["series"]
480           elif self.globalAttributesInFn[i][1:] == "experiment_family":
481             thisVal = globalAts["experiment_id"][:-4]
482           else:
483               assert False, "Not coded to deal with this configuration: globalAttributesInFn[%s]=%s" % (i,self.globalAttributesInFn[i])
484           ##print "Generated text val: %s:: %s" % (self.globalAttributesInFn[i], thisVal)
485         
486         else:
487             thisVal = globalAts[self.globalAttributesInFn[i]]
488
489         if thisVal not in [targVal,'__errorReported__']:
490             m.append( (i,self.globalAttributesInFn[i]) )
491
492    self.test( len(m)  == 0,'File name segments do not match corresponding global attributes: %s' % str(m) )
493
494    self.completed = True
495       
496class checkStandardDims(checkBase):
497
498  def init(self):
499    self.id = 'C4.003'
500    self.checkId = 'unset'
501    self.step = 'Initialised'
502    self.checks = (self.do_check,)
503    self.plevRequired = self.pcfg.plevRequired
504    self.plevValues = self.pcfg.plevValues
505    self.heightRequired = self.pcfg.heightRequired
506    self.heightValues = self.pcfg.heightValues
507    self.heightRange = self.pcfg.heightRange
508
509  def check(self,varName,varGroup, da, va, isInsta):
510    self.errorCount = 0
511    assert type(varName) in [type('x'),type(u'x')], '1st argument to "check" method of checkGrids shound be a string variable name (not %s)' % type(varName)
512    self.var = varName
513    self.varGroup = varGroup
514    self.da = da
515    self.va = va
516    self.isInsta = isInsta
517    self.runChecks()
518
519  def do_check(self):
520    varName = self.var
521    varGroup = self.varGroup
522    da = self.da
523    va = self.va
524    isInsta = self.isInsta
525
526    self.errorCount = 0
527    self.completed = False
528    self.checkId = ('001','time_attributes')
529    if varGroup != 'fx':
530      ok = True
531      self.test( 'time' in da.keys(), 'Time dimension not found' , abort=True, part=True )
532      if not isInsta:
533        ok &= self.test(  da['time'].get( 'bounds', 'xxx' ) == 'time_bnds', 'Required bounds attribute not present or not correct value', part=True )
534
535## is time zone designator needed?
536      tunits = da['time'].get( 'units', 'xxx' )
537      if self.project  == 'CORDEX':
538        ok &= self.test( tunits in ["days since 1949-12-01 00:00:00Z", "days since 1949-12-01 00:00:00", "days since 1949-12-01"],
539               'Time units [%s] attribute not set correctly to "days since 1949-12-01 00:00:00Z"' % tunits, part=True )
540      else:
541        ok &= self.test( tunits[:10] == "days since", 'time units [%s] attribute not set correctly to "days since ....."' % tunits, part=True )
542
543      ok &= self.test(  da['time'].has_key( 'calendar' ), 'Time: required attribute calendar missing', part=True )
544
545      ok &= self.test( da['time']['_type'] in ["float64","double"], 'Time: data type not float64 [%s]' % da['time']['_type'], part=True )
546       
547      if ok:
548        self.log_pass()
549      self.calendar = da['time'].get( 'calendar', 'None' )
550    else:
551      self.calendar = 'None'
552
553    self.checkId = ('002','pressure_levels')
554    if varName in self.plevRequired:
555      ok = True
556      self.test( 'plev' in va.keys(), 'plev coordinate not found %s' % str(va.keys()), abort=True, part=True )
557
558      ok &= self.test( int( va['plev']['_data'][0] ) == self.plevValues[varName],  \
559                  'plev value [%s] does not match required [%s]' % (va['plev']['_data'],self.plevValues[varName] ), part=True )
560     
561      plevAtDict = {'standard_name':"air_pressure", \
562                    'long_name':"pressure", \
563                    'units':"Pa", \
564                    'positive':"down", \
565                    'axis':"Z" }
566
567      if varName in ['clh','clm','cll']:
568        plevAtDict['bounds']= "plev_bnds"
569
570      for k in plevAtDict.keys():
571        ok &= self.test( va['plev'].get( k, None ) == plevAtDict[k], 
572                     'plev attribute %s absent or wrong value (should be %s)' % (k,plevAtDict[k]), part=True )
573
574      if varName in ['clh','clm','cll']:
575         self.test( "plev_bnds" in va.keys(), 'plev_bnds variable not found %s' % str(va.keys()), abort=True, part=True )
576         mm = []
577         for k in plevAtDict.keys():
578            if k != 'bounds' and k in va['plev_bnds'].keys():
579               if va['plev_bnds'][k] != va['plev'][k]:
580                 mm.append(k)
581         ok &= self.test( len(mm) == 0, 'Attributes of plev_bnds do not match those of plev: %s' % str(mm), part=True )
582
583         bndsVals = {'clh':[44000, 0], 'clm':[68000, 44000], 'cll':[100000, 68000] }
584         res = self.test( len( va['plev_bnds']['_data'] ) == 2, 'plev_bnds array is of wrong length', part=True )
585         ok &= res
586         if res:
587            kk = 0
588            for i in [0,1]:
589               if int(va['plev_bnds']['_data'][i]) != bndsVals[varName][i]:
590                  kk+=1
591            ok &= self.test( kk == 0, 'plev_bnds values not correct: should be %s' % str(bndsVals[varName]), part=True )
592
593      if ok:
594        self.log_pass()
595
596    self.checkId = ('003','height_levels')
597    if varName in self.heightRequired:
598      heightAtDict = {'long_name':"height", 'standard_name':"height", 'units':"m", 'positive':"up", 'axis':"Z" }
599      ok = True
600      ok &= self.test( 'height' in va.keys(), 'height coordinate not found %s' % str(va.keys()), abort=True, part=True )
601      ##ok &= self.test( abs( va['height']['_data'] - self.heightValues[varName]) < 0.001, \
602                ##'height value [%s] does not match required [%s]' % (va['height']['_data'],self.heightValues[varName] ), part=True )
603
604      ok1 = self.test( len( va['height']['_data'] ) == 1, 'More height values (%s) than expected (1)' % (len( va['height']['_data'])), part=True )
605      if ok1:
606        r = self.heightRange[varName]
607        ok1 &= self.test( r[0] <= va['height']['_data'][0] <= r[1], \
608                'height value [%s] not in specified range [%s]' % (va['height']['_data'], (self.heightRange[varName] ) ), part=True )
609
610      ok &= ok1
611     
612      for k in heightAtDict.keys():
613        val =  va['height'].get( k, "none" )
614        if not self.test( val == heightAtDict[k], \
615                         'height attribute %s absent or wrong value (should be %s)' % (k,heightAtDict[k]), part=True ):
616          self.parent.amapListDraft.append( '@var=%s;%s=%s|%s=%s' % ('height',k,val,k,heightAtDict[k]) )
617          ok = False
618
619      if ok:
620        self.log_pass()
621
622    self.completed = True
623
624class checkGrids(checkBase):
625
626  def init(self):
627    self.id = 'C4.004'
628    self.checkId = 'unset'
629    self.step = 'Initialised'
630    self.checks = (self.do_check_rp,self.do_check_intd)
631
632  def check(self,varName, domain, da, va):
633    self.errorCount = 0
634    assert type(varName) in [type('x'),type(u'x')], '1st argument to "check" method of checkGrids shound be a string variable name (not %s)' % type(varName)
635    self.var = varName
636    self.domain = domain
637    self.da = da
638    self.va = va
639
640    self.runChecks()
641    ##for c in self.checks:
642      ##c()
643    ##self.do_check_rp()
644    ##self.do_check_intd()
645
646  def do_check_rp(self):
647    varName = self.var
648    domain = self.domain
649    da = self.da
650    va = self.va
651    if va[varName].get( 'grid_mapping', None ) == "rotated_pole":
652      self.checkId = ('001','grid_mapping')
653      atDict = { 'grid_mapping_name':'rotated_latitude_longitude' }
654      atDict['grid_north_pole_latitude'] = self.pcfg.rotatedPoleGrids[domain]['grid_np_lat']
655      if self.pcfg.rotatedPoleGrids[domain]['grid_np_lon'] != 'N/A':
656        atDict['grid_north_pole_longitude'] = self.pcfg.rotatedPoleGrids[domain]['grid_np_lon']
657
658      self.checkId = ('002','rotated_latlon_attributes')
659      self.test( 'rlat' in da.keys() and 'rlon' in da.keys(), 'rlat and rlon not found (required for grid_mapping = rotated_pole )', abort=True, part=True )
660
661      atDict = {'rlat':{'long_name':"rotated latitude", 'standard_name':"grid_latitude", 'units':"degrees", 'axis':"Y", '_type':'float64'},
662                'rlon':{'long_name':"rotated longitude", 'standard_name':"grid_longitude", 'units':"degrees", 'axis':"X", '_type':'float64'} }
663      mm = []
664      for k in ['rlat','rlon']:
665        for k2 in atDict[k].keys():
666          if atDict[k][k2] != da[k].get(k2, None ):
667            mm.append( (k,k2) )
668            record = '#@ax=%s;%s=%s|%s=%s <uncomment if correct>' % (k,k2,da[k].get(k2, '__missing__'),k2,atDict[k][k2]   )
669            self.parent.amapListDraft.append( record )
670      self.test( len(mm) == 0, 'Required attributes of grid coordinate arrays not correct: %s' % str(mm) )
671
672      self.checkId = ('003','rotated_latlon_domain')
673      ok = True
674      for k in ['rlat','rlon']:
675        res = len(da[k]['_data']) == self.pcfg.rotatedPoleGrids[domain][ {'rlat':'nlat','rlon':'nlon' }[k] ]
676        if not res:
677          self.test( res, 'Size of %s dimension does not match specification (%s,%s)' % (k,a,b), part=True  )
678          ok = False
679
680      a = ( da['rlat']['_data'][0], da['rlat']['_data'][-1], da['rlon']['_data'][0], da['rlon']['_data'][-1] )
681      b = map( lambda x: self.pcfg.rotatedPoleGrids[domain][x], ['s','n','w','e'] )
682      mm = []
683      for i in range(4):
684        if abs(a[i] - b[i]) > self.pcfg.gridSpecTol:
685          mm.append( (a[i],b[i]) )
686
687      ok &= self.test( len(mm) == 0, 'Domain boundaries for rotated pole grid do not match %s within tolerance (%s)' % (str(mm),self.pcfg.gridSpecTol), part=True )
688
689      for k in ['rlat','rlon']:
690        ok &= self.test( cs.check( da[k]['_data'] ), '%s values not evenly spaced -- min/max delta = %s, %s' % (k,cs.dmn,cs.dmx), part=True )
691
692      if ok:
693        self.log_pass()
694
695  def do_check_intd(self):
696    varName = self.var
697    domain = self.domain
698    da = self.da
699    va = self.va
700    if domain[-1] == 'i':
701      self.checkId = ('004','regular_grid_attributes')
702      self.test( 'lat' in da.keys() and 'lon' in da.keys(), 'lat and lon not found (required for interpolated data)', abort=True, part=True )
703
704      atDict = {'lat':{'long_name':"latitude", 'standard_name':"latitude", 'units':"degrees_north", '_type':'float64'},
705                'lon':{'long_name':"longitude", 'standard_name':"longitude", 'units':"degrees_east", '_type':'float64'} }
706      mm = []
707      for k in ['lat','lon']:
708        for k2 in atDict[k].keys():
709          if atDict[k][k2] != da[k].get(k2, None ):
710            mm.append( (k,k2) )
711            record = '#@ax=%s;%s=%s|%s=%s <uncomment if correct>' % (k,k2,da[k].get(k2, '__missing__'),k2,atDict[k][k2]   )
712            self.parent.amapListDraft.append( record )
713
714      self.test( len(mm) == 0,  'Required attributes of grid coordinate arrays not correct: %s' % str(mm), part=True )
715
716      ok = True
717      self.checkId = ('005','regular_grid_domain')
718      for k in ['lat','lon']:
719        res = len(da[k]['_data']) >= self.pcfg.interpolatedGrids[domain][ {'lat':'nlat','lon':'nlon' }[k] ]
720        if not res:
721          a,b =  len(da[k]['_data']), self.pcfg.interpolatedGrids[domain][ {'lat':'nlat','lon':'nlon' }[k] ]
722          self.test( res, 'Size of %s dimension does not match specification (%s,%s)' % (k,a,b), part=True )
723          ok = False
724
725      a = ( da['lat']['_data'][0], da['lat']['_data'][-1], da['lon']['_data'][0], da['lon']['_data'][-1] )
726      b = map( lambda x: self.pcfg.interpolatedGrids[domain][x], ['s','n','w','e'] )
727      rs = self.pcfg.interpolatedGrids[domain]['res']
728      c = [-rs,rs,-rs,rs]
729      mm = []
730      for i in range(4):
731        if a[i] != b[i]:
732          x = (a[i]-b[i])/c[i]
733          if x < 0 or abs( x - int(x) ) > 0.001:
734             skipThis = False
735             if self.project  == 'CORDEX':
736               if domain[:3] == 'ANT':
737                 if i == 2 and abs( a[i] - 0.25 ) < 0.001:
738                    skipThis = True
739                 elif i == 3 and abs( a[i] - 359.75 ) < 0.001:
740                    skipThis = True
741             if not skipThis:
742               mm.append( (a[i],b[i]) )
743
744      ok &= self.test( len(mm) == 0, 'Interpolated grid boundary error: File %s; Req. %s' % (str(a),str(b)), part=True )
745
746      for k in ['lat','lon']:
747        ok &= self.test( cs.check( da[k]['_data'] ), '%s values not evenly spaced -- min/max delta = %s, %s' % (k,cs.dmn,cs.dmx), part=True )
748      if ok:
749        self.log_pass()
750
751class mipVocab(object):
752
753  def __init__(self,pcfg,dummy=False):
754     project = pcfg.project
755     if dummy:
756       self.pcfg = pcfg
757       return self.dummyMipTable()
758     ##assert project in ['CORDEX','SPECS'],'Project %s not recognised' % project
759     ##if project == 'CORDEX':
760       ##dir = 'cordex_vocabs/mip/'
761       ##tl = ['fx','sem','mon','day','6h','3h']
762       ##vgmap = {'6h':'6hr','3h':'3hr'}
763       ##fnpat = 'CORDEX_%s'
764     ##elif project == 'SPECS':
765       ##dir = 'specs_vocabs/mip/'
766       ##tl = ['fx','Omon','Amon','Lmon','OImon','day','6hrLev']
767       ##vgmap = {}
768       ##fnpat = 'SPECS_%s'
769     dir, tl, vgmap, fnpat = pcfg.mipVocabPars
770     ms = mipTableScan()
771     self.varInfo = {}
772     self.varcons = {}
773     for f in tl:
774        vg = vgmap.get( f, f )
775        self.varcons[vg] = {}
776        fn = fnpat % f
777        ll = open( '%s%s' % (dir,fn) ).readlines()
778        ee = ms.scan_table(ll,None,asDict=True)
779        for v in ee.keys():
780## set global default: type float
781          eeee = { 'type':pcfg.defaults.get( 'variableDataType', 'float' ) }
782          ar = []
783          ac = []
784          for a in ee[v][1].keys():
785            eeee[a] = ee[v][1][a]
786          ##if 'positive' in eeee.keys():
787            ##ar.append( 'positive' )
788            ##ac.append( 'positive' )
789          self.varInfo[v] = {'ar':ar, 'ac':ac }
790          self.varcons[vg][v] = eeee
791           
792  def dummyMipTable(self):
793     self.varInfo = {}
794     self.varcons = {}
795     ee = { 'standard_name':'sn%s', 'long_name':'n%s', 'units':'1' }
796     dir, tl, vgmap, fnpat = self.pcfg.mipVocabPars
797     for f in tl:
798        vg = vgmap.get( f, f )
799        self.varcons[vg] = {}
800        for i in range(12):
801          v = 'v%s' % i
802          eeee = {}
803          eeee['standard_name'] = ee['standard_name'] % i
804          eeee['long_name'] = ee['long_name'] % i
805          eeee['cell_methods'] = 'time: point'
806          eeee['units'] = ee['units']
807          eeee['type'] = 'float'
808          ar = []
809          ac = []
810          self.varInfo[v] = {'ar':ar, 'ac':ac }
811          self.varcons[vg][v] = eeee
812
813  def lists( self, k, k2 ):
814     if k2 == 'addRequiredAttributes':
815       return self.varInfo[k]['ar']
816     elif k2 == 'addControlledAttributes':
817       return self.varInfo[k]['ac']
818     else:
819       raise baseException( 'mipVocab.lists called with bad list specifier %s' % k2 )
820
821  def isInTable( self, v, vg ):
822    assert vg in self.varcons.keys(), '%s not found in  self.varcons.keys() [%s]' % (vg,str(self.varcons.keys()) )
823    return (v in self.varcons[vg].keys())
824     
825  def getAttr( self, v, vg, a ):
826    assert vg in self.varcons.keys(), '%s not found in  self.varcons.keys()'
827    assert v in self.varcons[vg].keys(), '%s not found in self.varcons[%s].keys()' % (v,vg)
828     
829    return self.varcons[vg][v][a]
830     
831class patternControl(object):
832
833  def __init__(self,tag,pattern,list=None):
834    try:
835      self.re_pat = re.compile( pattern )
836    except:
837      print "Failed to compile pattern >>%s<< (%s)" % (pattern, tag)
838    self.pattern = pattern
839    self.list = list
840
841  def check(self,val):
842    self.note = '-'
843    m = self.re_pat.match( val )
844    if self.list == None:
845      self.note = "simple test"
846      return m != None
847    else:
848      if m == None:
849        self.note = "no match %s::%s" % (val,self.pattern)
850        return False
851      if not m.groupdict().has_key("val"):
852        self.note = "no 'val' in match"
853        return False
854      self.note = "val=%s" % m.groupdict()["val"]
855      return m.groupdict()["val"] in self.list
856   
857class listControl(object):
858  def __init__(self,tag,list,split=False,splitVal=None):
859    self.list = list
860    self.tag = tag
861    self.split = split
862    self.splitVal = splitVal
863
864  def check(self,val):
865    self.note = '-'
866    if len(self.list) < 4:
867      self.note = str( self.list )
868    else:
869      self.note = str( self.list[:4] )
870    if self.split:
871      if self.splitVal == None:
872        vs = string.split( val )
873      else:
874        vs = string.split( val, self.spliVal )
875      return all( map( lambda x: x in self.list, vs ) )
876    else:
877      return val in self.list
878
879
880class checkByVar(checkBase):
881
882  def init(self):
883    self.id = 'C5.001'
884    self.checkId = 'unset'
885    self.step = 'Initialised'
886    self.checks = (self.checkTrange,)
887
888  def setLogDict( self,fLogDict ):
889    self.fLogDict = fLogDict
890
891  def impt(self,flist):
892    ee = {}
893    elist = []
894    for f in flist:
895      fn = string.split(f, '/' )[-1]
896      fnParts = string.split( fn[:-3], '_' )
897     
898      try:
899        if self.pcfg.freqIndex != None:
900          freq = fnParts[self.pcfg.freqIndex]
901        else:
902          freq = None
903
904        isFixed = freq == 'fx'
905        group = fnParts[ self.pcfg.groupIndex ]
906
907        if isFixed:
908          trange = None
909        else:
910          trange = string.split( fnParts[-1], '-' )
911        var = fnParts[0]
912        thisKey = string.join( fnParts[:-1], '.' )
913        if group not in ee.keys():
914          ee[group] = {}
915        if thisKey not in ee[group].keys():
916          ee[group][thisKey] = []
917        ee[group][thisKey].append( (f,fn,group,trange) )
918      except:
919        print 'Cannot parse file name: %s' % (f) 
920        elist.append(f)
921## this ee entry is not used, except in bookkeeping check below.
922## parsing of file name is repeated later, and a error log entry is created at that stage -- this could be improved.
923## in order to improve, need to clarify flow of program: the list here is used to provide preliminary info before log files etc are set up.
924        group = '__error__'
925        thisKey = fn
926        if group not in ee.keys():
927          ee[group] = {}
928        if thisKey not in ee[group].keys():
929          ee[group][thisKey] = []
930        ee[group][thisKey].append( (f,fn,group) )
931
932    nn = len(flist)
933    n2 = 0
934    for k in ee.keys():
935      for k2 in ee[k].keys():
936        n2 += len( ee[k][k2] )
937
938    assert nn==n2, 'some file lost!!!!!!'
939    if len(elist) == 0:
940      self.info =  '%s files, %s' % (nn,str(ee.keys()) )
941    else:
942      self.info =  '%s files, %s frequencies, severe errors in file names: %s' % (nn,len(ee.keys()),len(elist) )
943      for e in elist:
944        self.info += '\n%s' % e
945    self.ee = ee
946
947  def check(self, recorder=None,calendar='None',norun=False):
948    self.errorCount = 0
949    self.recorder=recorder
950    self.calendar=calendar
951    if calendar == '360-day':
952      self.enddec = 30
953    else:
954      self.enddec = 31
955    mm = { 'enddec':self.enddec }
956    self.pats = {'mon':('(?P<d>[0-9]{3})101','(?P<e>[0-9]{3})012'), \
957            'sem':('(?P<d>[0-9]{3})(012|101)','(?P<e>[0-9]{3})(011|010)'), \
958            'day':('(?P<d>[0-9]{3}[16])0101','(?P<e>[0-9]{3}[50])12%(enddec)s' % mm), \
959            'subd':('(?P<d>[0-9]{4})0101(?P<h1>[0-9]{2})(?P<mm>[30]0){0,1}$', '(?P<e>[0-9]{4})12%(enddec)s(?P<h2>[0-9]{2})([30]0){0,1}$' % mm ), \
960            'subd2':('(?P<d>[0-9]{4})0101(?P<h1>[0-9]{2})', '(?P<e>[0-9]{4})010100' ) }
961
962    if not norun:
963      self.runChecks()
964
965  def checkTrange(self):
966    keys = self.ee.keys()
967    keys.sort()
968    for k in keys:
969      if k != 'fx':
970        keys2 = self.ee[k].keys()
971        keys2.sort()
972        for k2 in keys2:
973          self.checkThisTrange( self.ee[k][k2], k )
974
975  def checkThisTrange( self, tt, group):
976
977    if group in ['3hr','6hr']:
978       kg = 'subd'
979    else:
980       kg = group
981    ps = self.pats[kg]
982    rere = (re.compile( ps[0] ), re.compile( ps[1] ) )
983
984    n = len(tt)
985    self.checkId = ('001','filename_timerange_value')
986    for j in range(n):
987      if self.monitor != None:
988         nofh0 = self.monitor.get_open_fds()
989      t = tt[j]
990      fn = t[1]
991      isFirst = j == 0
992      isLast = j == n-1
993      lok = True
994      for i in [0,1]:
995        if not (i==0 and isFirst or i==1 and isLast):
996          x = rere[i].match( t[3][i] )
997          lok &= self.test( x != None, 'Cannot match time range %s: %s [%s/%s]' % (i,fn,j,n), part=True, appendLogfile=(self.fLogDict.get(fn,None),fn) )
998        if not lok:
999          ### print 'Cannot match time range %s:' % t[1]
1000          if self.recorder != None:
1001            self.recorder.modify( t[1], 'ERROR: time range' )
1002      if self.monitor != None:
1003         nofh9 = self.monitor.get_open_fds()
1004         if nofh9 > nofh0:
1005           print 'Open file handles: %s --- %s [%s]' % (nofh0, nofh9, j )
1006
1007### http://stackoverflow.com/questions/2023608/check-what-files-are-open-in-python
1008class sysMonitor(object):
1009
1010  def __init__(self):
1011    self.fhCountMax = 0
1012
1013  def get_open_fds(self):
1014    '''
1015    return the number of open file descriptors for current process
1016    .. warning: will only work on UNIX-like os-es.
1017    '''
1018    import subprocess
1019    import os
1020
1021    pid = os.getpid()
1022    self.procs = subprocess.check_output( 
1023        [ "lsof", '-w', '-Ff', "-p", str( pid ) ] )
1024
1025    self.ps = filter( 
1026            lambda s: s and s[ 0 ] == 'f' and s[1: ].isdigit(),
1027            self.procs.split( '\n' ) )
1028    self.fhCountMax = max( self.fhCountMax, len(self.ps) )
1029    return len( self.ps )
Note: See TracBrowser for help on using the repository browser.