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

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

debugging commandline options -- removing hidden settings

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