source: CMIP6dreqbuild/trunk/src/framework/audit.py @ 912

Subversion URL: http://proj.badc.rl.ac.uk/svn/exarch/CMIP6dreqbuild/trunk/src/framework/audit.py@912
Revision 912, 18.0 KB checked in by mjuckes, 4 years ago (diff)

release cand

Line 
1
2from dreqPy import dreq
3from dreqPy import misc_utils
4import collections, sys, os
5
6
7python2 = True
8if sys.version_info[0] == 3:
9  python2 = False
10
11if len(sys.argv) > 1:
12  lname = sys.argv[1]
13else:
14  lname = 'audit'
15logFarm = misc_utils.dreqLog(dir='logs')
16log = logFarm.getLog(lname)
17
18class c1(object):
19  def __init__(self):
20    self.a = collections.defaultdict( list )
21
22class checkUnits(object):
23
24  def __init__(self, cc, extra=None):
25    assert python2, 'The checkUnits module requires cf, which is not available in python 3'
26    import cf
27    if extra != None:
28      for k in sorted( extra.keys() ):
29        try:
30          a = cf.units.Units( k )
31        except:
32          log.warn( 'WARN.001.0004: bad units %s (%s)' % (k,str(extra[k])) )
33
34    for k in sorted( cc.keys() ):
35      try:
36        a = cf.units.Units( k )
37      except:
38        log.warn( 'Bad CF units: %s' % k )
39        a = None
40
41
42      if a != None:
43        for k2 in cc[k].a:
44          try:
45            b = cf.units.Units( k2 )
46          except:
47            b = None
48            log.warn( 'WARN.001.0003: unit invalid : %s .... %s: %s' % (k,k2,str( cc[k].a[k2]) ) )
49          if b != None and not a.equivalent(b):
50            log.warn( 'WARN.001.0002: unit mismatch: %s .... %s: %s' % (k,k2,str( cc[k].a[k2]) ) )
51
52def splitStr( s ):
53  if s == '':
54    return ['']
55  if s.find( ' ') == -1:
56    return [s,]
57  return s.split()
58
59class checkDims(object):
60
61  def __init__(self, dq):
62    """Generate list of used dimensions in ss;
63       Check against defined dimenions [todo]"""
64    ss = set()
65    self.cellm = set()
66    cc = collections.defaultdict(list)
67    duds = ('', '****', '?',)
68    for i in dq.coll['spatialShape'].items:
69      if i.dimensions != '':
70        for x in i.dimensions.split( '|' ):
71          if x in duds:
72            cc[x].append( i.uid )
73          else:
74            ss.add(x)
75    for i in dq.coll['temporalShape'].items:
76      if i.dimensions != '':
77        for x in i.dimensions.split( '|' ):
78          if x in duds:
79            cc[x].append( i.uid )
80          else:
81            ss.add(x)
82    for i in dq.coll['structure'].items:
83      self.cellm.add( i.cell_methods )
84      if i.odims != '':
85        for x in i.odims.split( '|' ):
86          if x in duds:
87            cc[x].append( i.uid )
88          else:
89            ss.add(x)
90      if i.coords != '':
91        for x in i.coords.split( '|' ):
92          if x in duds:
93            cc[x].append( i.uid )
94          else:
95            ss.add(x)
96
97    cellm = sorted( list( self.cellm ) )
98    for c in cellm:
99      log.info( 'cell_methods\t %s' % c )
100    log.info( str( sorted( list(ss) ) ) )
101    ll = set( [i.label for i in dq.coll['grids'].items] )
102    for x in ss:
103      if x not in ll:
104        log.error( 'ERROR: dimension not found: %s' % x )
105
106class auditor(object):
107  def __init__(self,dq):
108    self.dq = dq
109    self.run()
110
111  def run(self):
112    self.loadDraftNewVar()
113    self.audit_var()
114    self.audit_sn()
115    self.audit_cmv()
116    self.audit_rqv()
117    self.audit_rql()
118    self.audit_rqg()
119    self.audit_str()
120    self.audit_cm()
121
122  def audit_cm(self):
123    log.info( 'Running Cell Methods Audit' )
124    l1 = [i for i in self.dq.coll['structure'].items if i.cell_methods == ""]
125    ss = set()
126    if len( l1 ) > 0:
127      log.error( 'ERROR.cm.00010: %s blank cell methods in structure records: ' % len(l1) )
128      for i in l1:
129        log.error( 'ERROR.cm.00011: %s: %s' % ( i.label, i.title )  )
130    for i in l1:
131      if 'CMORvar' in self.dq.inx.iref_by_sect[i.uid].a:
132        for u in dq.inx.iref_by_sect[i.uid].a['CMORvar']:
133           ss.add(u)
134    if len(ss) > 0:
135      log.error( 'ERROR.cm.00020: %s CMOR vars affected ' % len(ss) )
136
137  def audit_var(self):
138    cc = collections.defaultdict( list )
139    ss = collections.defaultdict( c1 )
140    ssx = collections.defaultdict( set )
141    umap = { 'Wm-2':'W m-2', 'string':''}
142    for i in self.dq.coll['var'].items:
143      cc[i.label].append(i)
144      isn = self.dq.inx.uid[i.sn]
145      if isn._h.label != 'remarks':
146        u = umap.get( isn.units, isn.units )
147        ss[u].a[i.units].append( i.label )
148      else:
149        ssx[i.units].add( i.label )
150
151    ii = [k for k in cc if len(cc[k]) > 1]
152    log.warn( 'var.0001: %48s [%s]: %s' % ('Duplicate variable names',len( self.dq.coll['var'].items ),len(ii)) )
153    showDupVar=False
154    showDupVar=True
155    showDupVarBrief=False
156    if showDupVar:
157      for i in ii:
158        log.info(  '----- %s -----' % i )
159        for x in cc[i]:
160          log.info( '%s, %s, %s, %s' % ( x.label,x.title,x.sn,x.prov ))
161    elif showDupVarBrief:
162      lg.info( str( ii ))
163    self.cc = cc
164
165    if not python2:
166      log.warn( 'Skipping the units check .. not available in python3' )
167    else:
168      checkUnits( ss, extra=ssx )
169   
170  def audit_str(self):
171    nms = 0
172    ss = set()
173    cc = collections.defaultdict( list )
174    for i in self.dq.coll['structure'].items:
175      cc[ (i.spid, i.tmid,i.odims,i.coords,i.cmid) ].append( i )
176      if i.cmid != '__unset__' and self.dq.inx.uid[i.cmid]._h.label == 'remarks' and i.cell_methods != '':
177        ss.add(i.cmid)
178        nms += 1
179    if nms > 0:
180      log.error( 'str.00010: missing cell methods records for %s records (%s)' % (nms, len(ss) ) )
181      log.error( 'str.00011: %s' % str( sorted(list(ss)) ) )
182    else:
183      log.info( 'str.00010: all structure methods have valid cmid' )
184
185    ks = [k for k in cc if len(cc[k]) > 1]
186    log.info( 'str.00020: count of repeated space/time structure: %s' % len(ks) )
187    if len(ks) > 0:
188      oo = open( 'structureRepeats.csv', 'w' )
189      for k in ks:
190        oo.write( '\t'.join( ['NEXT', k[0], k[1], k[2], k[3], self.dq.inx.uid[k[0]].label, self.dq.inx.uid[k[1]].label] ) + '\n' )
191        for i in cc[k]:
192          oo.write( '\t'.join( ['+',i.uid, i.label, i.title, i.odims, i.coords, i.cell_methods, i.cell_measures, i.flag_meanings, i.spid ] ) + '\n' )
193      oo.close()
194
195  def saveRevisedNewVar(self,ll):
196    oo = open( 'revised_newvars.csv', 'w' )
197    for v in sorted( list( ll ) ):
198      oo.write( self.draftNewVar[v] )
199    oo.close()
200
201  def loadDraftNewVar(self):
202    self.draftNewVar = {}
203    for f in ['draft_newvars.csv','draft_newvars02.csv']:
204      ii = open( f, 'r' ).readlines()
205      ss = set()
206      for l in ii:
207        r = l.split( '\t' )
208        vn = r[0].strip()
209        assert vn not in ss, 'Duplicate variable name in %s: %s' % (f,vn)
210        ss.add(vn)
211        if vn in self.draftNewVar:
212          log.info( 'INFO.newvar.0001:  overwriting new var: %s' % vn )
213        self.draftNewVar[vn] = l
214   
215  def audit_cmv(self):
216    ccmv = collections.defaultdict( list )
217    ccmv2 = collections.defaultdict( list )
218    ccmv4 = collections.defaultdict( list )
219    nms = 0
220    ss = set()
221    badRealm = set()
222    for i in self.dq.coll['CMORvar'].items:
223      ccmv[i.label].append(i)
224      ccmv4[ (i.frequency,i.label,i.stid)].append(i)
225      ccmv2[ (i.mipTable,i.label)].append(i)
226      if self.dq.inx.uid[i.stid]._h.label == 'remarks':
227        ss.add( i.stid )
228        nms += 1
229      if i.modeling_realm in ['','__unset__']:
230        badRealm.add( (i.mipTable, i.label ) )
231    if len( badRealm ) > 0:
232      log.error( 'cmv.00030: bad modeling realms set in %s cmv records' % len( badRealm ) )
233      cc1 = collections.defaultdict( list )
234      for tab, lab in badRealm:
235        cc1[tab].append(lab)
236      for tab in sorted( cc1.keys() ):
237        log.error( 'cmv.00031: table %s: %s' % (tab,str(sorted(cc1[tab]))) )
238    else:
239      log.info( 'cmv.00030: modeling realms set ok cmv records' )
240
241    if nms > 0:
242      log.error( 'cmv.00010: missing variable structures for %s CMORvar records, bad stids: %s' % (nms,len(ss)) )
243      log.error( 'cmv.00011: bad stids: %s' % str( sorted( list( ss ) ) ) )
244    else:
245      log.info( 'cmv.00010: variable structures for all CMORvar records present' )
246
247    ii0 = [i for i in self.dq.coll['CMORvar'].items if i.mipTable == '']
248    if len(ii0) > 0:
249      log.error( 'cmv.00020: %48s [%s]: %s' % ('Empty MIP table in CMORvar',len(self.dq.coll['CMORvar'].items),len(ii0)) )
250    else:
251      log.info( 'cmv.00020: all CMORvar records have mip table defined' )
252
253    ii = [i for i in self.dq.coll['CMORvar'].items if self.dq.inx.uid[i.vid]._h.label == 'remarks']
254    if len(ii) == 0:
255      log.info( 'cmv.00200: all CMORvar records have valid vid' )
256    else:
257      ii1 = [i for i in ii if 'requestVar' in self.dq.inx.iref_by_sect[i.uid].a]
258      log.error( 'cmv.00200: %48s [%s]: %s (requested: %s)' % ('CMORvar records with bad vid',len(self.dq.coll['CMORvar'].items),len(ii),len(ii1)) )
259
260      iix2 = []
261      iix3 = []
262      for i in ii1:
263        ok = False
264        ok3 = False
265        for u in self.dq.inx.iref_by_sect[i.uid].a['requestVar']:
266          vg = self.dq.inx.uid[ self.dq.inx.uid[u].vgid ]
267          if vg._h.label != 'remarks':
268           ok = True
269           iix2.append(i)
270           if 'requestLink' in self.dq.inx.iref_by_sect[vg.uid].a:
271             iix3.append(i)
272      log.error( 'cmv.0021: of these: valid requestVarGroup: %s; valid requestLink(s): %s' %  (len(iix2),len(iix3)) )
273      rnv = set()
274      for i in iix3:
275        if i.label in self.draftNewVar:
276          log.error( 'cmv.0125: %s, %s, %s' % (i.uid,i.label,i.title) )
277          rnv.add( i.label )
278        else:
279          log.error( 'cmv.0122: %s, %s, %s' % (i.uid,i.label,i.title) )
280
281      if len( rnv ) > 0:
282        self.saveRevisedNewVar( rnv )
283       
284         
285    ii2 = [k for k in ccmv2 if len(ccmv2[k]) > 1]
286    if len(ii2) == 0:
287      log.info( 'cmv.0030: unique CMOR variable names OK' )
288    else:
289      log.error( 'cmv.0030: non-unique CMOR variable naming for %s records' % len(ii2) )
290      log.error( 'cmv.0031: %s' % str(ii2) )
291
292    ii4 = [k for k in ccmv4 if len(ccmv4[k]) > 1]
293    ii4b = list()
294    for k in ii4:
295      if len(ccmv4[k]) == 2 and set( [i.mipTable[-3:] for i in ccmv4[k]] ) == set(['Ant','Gre']):
296        pass
297      else:
298        ii4b.append(k)
299
300    if len(ii4b) == 0:
301      log.info( 'cmv.0040: unique CMOR variable usage OK' )
302    else:
303      log.error( 'cmv.0040: non-unique CMOR variable usage possible for %s records' % len(ii4b) )
304      log.error( 'cmv.0041: %s' % str(ii4b) )
305      kk=0
306      oo = open( 'cmv_probDuplication.csv', 'w' )
307      for k in ii4b:
308        kk += 1
309        rec = ('NEXT\t%s\t' % kk ) + str( '\t'.join( k ) )
310        print 'INFO.cmvdup.00001: ',rec
311        oo.write( rec + '\n' )
312        vid = None
313        for i in ccmv4[k]:
314          assert vid == None or i.vid == vid, 'Unexpected vid variation ...: %s%s %s' % (i.label, i.vid, vid)
315          vid = i.vid
316          rec = '+\t%s\t%s\t%s\t%s\t%s' % (i.uid,i.mipTable,i.title,i.description,i.prov)
317          oo.write( rec + '\n' )
318          print 'INFO.cmvdup.00001: ',rec
319      oo.close()
320
321    ccmv3 = collections.defaultdict( list )
322    for t in ccmv2:
323      s = set()
324      for i in ccmv2[t]:
325        id = i.uid
326        if 'varRelLnk' in self.dq.inx.iref_by_sect[id].a:
327          for x in self.dq.inx.iref_by_sect[id].a['varRelLnk']:
328            s.add( x )
329      s = list(s)
330      if len(s) > 0:
331        ccmv3[t] = s
332
333    ii5 = [k for k in ii2 if k not in ccmv3 or len(ccmv2[k]) > len(ccmv3[k])]
334    cc4 = collections.defaultdict( list )
335    for t,v in ii2:
336      cc4[t].append( v )
337
338    log.warn( '%48s [%s]: %s [%s tables]' % ('Duplicate variables in CMORvar',len(self.dq.coll['CMORvar'].items),len(ii2), len( cc4.keys() ) ) )
339    showAllCmvErrors=False
340    showAllCmvErrors=True
341    if showAllCmvErrors:
342       rats = ['uid','label','title','description','frequency','mipTable','stid','prov','provNote']
343       oocm = open( 'cmvDup.csv', 'w' )
344       c1 = collections.defaultdict( list )
345       ##for i in ii2:
346         ##c1[i.prov].append( i.label )
347       ##log.warn( 'No MIP var: %s ... %s' % (str( sorted( [i.label for i in ii if i.label in self.cc] ) ), str(c1)))
348       for k in sorted( cc4.keys() ):
349         log.warn(  '%16s::  %s' % (k,str(sorted(cc4[k]))) )
350         for v in sorted(cc4[k]):
351             sv = set()
352             for i in ccmv2[ (k,v) ]:
353                sv.add(i.vid)
354
355             if len(list(sv)) == 1:
356               vun = True
357               vv = self.dq.inx.uid[ list(sv)[0] ]
358               oocm.write( '@VAR:\t\t\t%s\t%s\t%s\n' % (vv.label,vv.title,vv.description) )
359             else:
360               vun = False
361
362             for i in ccmv2[ (k,v) ]:
363                stt = self.dq.inx.uid[i.stid].title
364                if 'Temporal mean' in stt:
365                   if i.frequency == '3hr':
366                     i.title += ' [3 hour mean]'
367                xtra = ''
368                oocm.write( '\t\t' + '\t'.join( [str(i.__dict__[x]) for x in rats] ) + '\t%s%s\n' % (stt,xtra) )
369                if not vun:
370                  vv = self.dq.inx.uid[i.vid]
371                  xtra = '\t\t\t\t%s\t%s\t%s\n' % (vv.label,vv.title,vv.description)
372                  oocm.write(xtra)
373             oocm.write( '####\n' )
374       oocm.close()
375    t2_ii = ii[:]
376    self.ccmv = ccmv
377
378  def audit_sn(self):
379    cc = collections.defaultdict( list )
380    nrem = 0
381    snm = set()
382    snmm = collections.defaultdict( int )
383    for i in self.dq.coll['var'].items:
384      if 'CMORvar' in self.dq.inx.iref_by_sect[i.uid].a:
385        srq = set()
386        for u in self.dq.inx.iref_by_sect[i.uid].a['CMORvar']:
387          if 'requestVar' in self.dq.inx.iref_by_sect[u].a:
388            for uu in self.dq.inx.iref_by_sect[u].a['requestVar']:
389              rqv = self.dq.inx.uid[uu]
390              srq.add( rqv.priority )
391        if len(srq) > 0:
392          pm = min( srq )
393           
394          kk = i.sn
395          if self.dq.inx.uid[kk]._h.label == 'remarks':
396            nrem += 1
397            snm.add(kk)
398            if pm == 1:
399              print 'MISSING STANDARD NAME: ',i.label, i.title, i.sn
400            snmm[pm] += 1
401          if i.procnote != []:
402            ll = sorted( i.procnote )
403            kk += ':' + '|'.join(ll )
404          cc[kk].append( i.uid )
405
406    log.warn( 'sn.001: Number of missing standard names: %s [for %s variables] {%s}' % (len(snm),nrem,str(snmm)) )
407    ll = []
408    for k in cc:
409      if len( cc[k] ) > 1:
410        ll.append( k )
411
412    log.warn( 'sn.002: Duplicate use of standard names: %s' % len(ll) )
413    oo = open( 'audit_sn_repeats.csv', 'w' )
414    for k in sorted( ll ):
415      orc = [k,]
416      l1 = cc[k][:]
417      l2 = []
418      l1b = []
419      for u in cc[k]:
420        i = self.dq.inx.uid[u]
421        if i.prov == "CMIP6 endorsement [SIMIP]":
422          l2.append(u)
423        else:
424          l1b.append(u)
425      if len( l2) > 1:
426        log.error( 'WARN.simip.00001: repeat use of standard name in SIMIP: %s:: %s' % (k,str(l2)) )
427      if len(l2) == 1:
428        orc.append( '*' )
429      else:
430        orc.append( '' )
431
432      nnn = 0
433      for u in l2 +l1b:
434        i = self.dq.inx.uid[u]
435        if "CMORvar" not in self.dq.inx.iref_by_sect[u].a:
436           orc += [i.label +'**', i.title]
437        else:
438          nn = 0
439          for uu in self.dq.inx.iref_by_sect[u].a['CMORvar']:
440            cmv = self.dq.inx.uid[uu]
441            if 'requestVar' in self.dq.inx.iref_by_sect[uu].a:
442              nn += 1
443          if nn == 0:
444             orc += [i.label + '*', i.title]
445          else:
446             nnn += 1
447             orc += [i.label, i.title]
448         
449      if nnn > 1:
450        oo.write( '\t'.join( orc ) + '\n' )
451    oo.close()
452     
453  def audit_rqv(self):
454    ixx = [i for i in self.dq.coll['requestVar'].items if i.vid in self.dq.inx.uid]
455    if len(ixx) < len( self.dq.inx.uid ):
456       log.error( 'SEVERE.var.00301: request vars with bad links ....' )
457   
458    ii = [i for i in ixx if self.dq.inx.uid[i.vid]._h.label == 'remarks']
459    ii2 = [i for i in ii if i.label not in self.cc]
460    ii3 = [i.vgid for i in ii if self.dq.inx.uid[i.vgid]._h.label != 'remarks']
461##ii4: set of invalid requestVarGroup records
462    ii4 = [i for i in ii3 if 'requestLink' not in self.dq.inx.iref_by_sect[i].]
463######
464    ii5Info = 'Set of bad requestVar records linking to a valid requestVarGroup records.'
465    ii5 = [i for i in ii if i.vgid not in ii4]
466##ii6: set of bad requestVar records linking to a valid requestVarGroup records and no variable name match.
467    ii6 = [i for i in ii5 if i.label not in self.cc]
468    log.error( '%48s [%s]: %s [%s, %s, %s; %s]' % ('Bad variable links in requestVar',len(self.dq.coll['requestVar'].items),len(ii),len(ii2), len(ii5), len(ii6), len(ii4)) )
469    log.info ( str( ii5Info ))
470    svg = set()
471    for i in ii5:
472      log.info( 'ii5: %s' % str([i.label, i.title, i.uid, i.mip, self.dq.inx.uid[i.vgid].title] ) )
473      svg.add( i.vgid )
474    for i in ii2:
475      if i.vgid in self.dq.inx.uid and self.dq.inx.uid[i.vgid]._h.label != 'remarks':
476        xx = '%s [%s]' % (self.dq.inx.uid[i.vgid].title, i.vgid)
477      else:
478        xx = i.vgid
479      log.info( 'ii2: %s' % str([i.label, i.title, i.uid, i.mip, xx] ) )
480
481    log.warn( 'rvg.0010: requestVarGroups with bad request vars:' )
482    for u in sorted( list(svg) ):
483      log.warn( 'rvg.0011: %s: %s' % (u, self.dq.inx.uid[u].title ))
484
485    log.info( '    [# records]: # broken [var name not known, link to valid group, valid group and no var name; valid request groups' )
486    showAllRqvErrors=False
487    if showAllRqvErrors:
488      log.info( '%s\n%s' % (str( [i.label for i in ii if i.label in self.cc]), str( [i.label for i in ii2] ) ) )
489
490    ii1 = [i for i in ii if i.label in self.ccmv]
491    listBadRequestVar=False
492    if listBadRequestVar:
493      for i in ii1:
494        log.info( str( i.label,i.mip,i.table,[x.frequency for x in self.ccmv[i.label]] ) )
495
496  def audit_rql(self):
497    ii = [i for i in self.dq.coll['requestLink'].items if self.dq.inx.uid[i.refid]._h.label == 'remarks']
498    log.info( '%48s: %s (from %s)' % ('Bad request group links in requestLink',len(ii), len(self.dq.coll['requestLink'].items)) )
499
500  def audit_rqg(self):
501    ii = [i for i in self.dq.coll['requestVarGroup'].items if len( dq.inx.iref_by_sect[i.uid].a['requestVar'])  == 0]
502    ii1 = [i for i in ii if len( dq.inx.iref_by_sect[i.uid].a['requestLink'])  != 0]
503    log.info( '%48s: %s/%s (from %s)' % ('Empty request groups',len(ii) - len(ii1),len(ii1), len(self.dq.coll['requestVarGroup'].items)) )
504    listEmptyRequestVarGroups=False
505    if listEmptyRequestVarGroups:
506      for i in ii1:
507        log.info ( '%s: %s, %s' % (i.label, i.title, i.mip) )
508
509dq = dreq.loadDreq(manifest=None)
510a = auditor( dq )
511cd = checkDims( dq )
Note: See TracBrowser for help on using the repository browser.