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

Subversion URL: http://proj.badc.rl.ac.uk/svn/exarch/CMIP6dreqbuild/trunk/src/framework/audit.py@760
Revision 760, 14.5 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):
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.audit_var()
106    self.audit_sn()
107    self.audit_cmv()
108    self.audit_rqv()
109    self.audit_rql()
110    self.audit_rqg()
111    self.audit_str()
112
113  def audit_var(self):
114    cc = collections.defaultdict( list )
115    ss = collections.defaultdict( c1 )
116    umap = { 'Wm-2':'W m-2', 'string':''}
117    for i in self.dq.coll['var'].items:
118      cc[i.label].append(i)
119      isn = self.dq.inx.uid[i.sn]
120      if isn._h.label != 'remarks':
121        u = umap.get( isn.units, isn.units )
122        ss[u].a[i.units].append( i.label )
123
124    ii = [k for k in cc if len(cc[k]) > 1]
125    log.warn( 'var.0001: %48s [%s]: %s' % ('Duplicate variable names',len( self.dq.coll['var'].items ),len(ii)) )
126    showDupVar=False
127    showDupVar=True
128    showDupVarBrief=False
129    if showDupVar:
130      for i in ii:
131        log.info(  '----- %s -----' % i )
132        for x in cc[i]:
133          log.info( '%s, %s, %s, %s' % ( x.label,x.title,x.sn,x.prov ))
134    elif showDupVarBrief:
135      lg.info( str( ii ))
136    self.cc = cc
137
138    if not python2:
139      log.warn( 'Skipping the units check .. not available in python3' )
140    else:
141      checkUnits( ss )
142   
143  def audit_str(self):
144    nms = 0
145    ss = set()
146    cc = collections.defaultdict( list )
147    for i in self.dq.coll['structure'].items:
148      cc[ (i.spid, i.tmid,i.odims,i.coords,i.cmid) ].append( i )
149      if i.cmid != '__unset__' and self.dq.inx.uid[i.cmid]._h.label == 'remarks' and i.cell_methods != '':
150        ss.add(i.cmid)
151        nms += 1
152    if nms > 0:
153      log.error( 'str.00010: missing cell methods records for %s records (%s)' % (nms, len(ss) ) )
154      log.error( 'str.00011: %s' % str( sorted(list(ss)) ) )
155    else:
156      log.info( 'str.00010: all structure methods have valid cmid' )
157
158    ks = [k for k in cc if len(cc[k]) > 1]
159    log.info( 'str.00020: count of repeated space/time structure: %s' % len(ks) )
160    if len(ks) > 0:
161      oo = open( 'structureRepeats.csv', 'w' )
162      for k in ks:
163        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' )
164        for i in cc[k]:
165          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' )
166      oo.close()
167
168  def audit_cmv(self):
169    ccmv = collections.defaultdict( list )
170    ccmv2 = collections.defaultdict( list )
171    ccmv4 = collections.defaultdict( list )
172    nms = 0
173    ss = set()
174    badRealm = set()
175    for i in self.dq.coll['CMORvar'].items:
176      ccmv[i.label].append(i)
177      ccmv4[ (i.frequency,i.label,i.stid)].append(i)
178      ccmv2[ (i.mipTable,i.label)].append(i)
179      if self.dq.inx.uid[i.stid]._h.label == 'remarks':
180        ss.add( i.stid )
181        nms += 1
182      if i.modeling_realm in ['','__unset__']:
183        badRealm.add( (i.mipTable, i.label ) )
184    if len( badRealm ) > 0:
185      log.error( 'cmv.00030: bad modeling realms set in %s cmv records' % len( badRealm ) )
186      cc1 = collections.defaultdict( list )
187      for tab, lab in badRealm:
188        cc1[tab].append(lab)
189      for tab in sorted( cc1.keys() ):
190        log.error( 'cmv.00031: table %s: %s' % (tab,str(sorted(cc1[tab]))) )
191    else:
192      log.info( 'cmv.00030: modeling realms set ok cmv records' )
193
194    if nms > 0:
195      log.error( 'cmv.00010: missing variable structures for %s CMORvar records, bad stids: %s' % (nms,len(ss)) )
196      log.error( 'cmv.00011: bad stids: %s' % str( sorted( list( ss ) ) ) )
197    else:
198      log.info( 'cmv.00010: variable structures for all CMORvar records present' )
199
200    ii0 = [i for i in self.dq.coll['CMORvar'].items if i.mipTable == '']
201    if len(ii0) > 0:
202      log.error( 'cmv.00020: %48s [%s]: %s' % ('Empty MIP table in CMORvar',len(self.dq.coll['CMORvar'].items),len(ii0)) )
203    else:
204      log.info( 'cmv.00020: all CMORvar records have mip table defined' )
205
206    ii = [i for i in self.dq.coll['CMORvar'].items if self.dq.inx.uid[i.vid]._h.label == 'remarks']
207    if len(ii) == 0:
208      log.info( 'cmv.00200: all CMORvar records have valid vid' )
209    else:
210      ii1 = [i for i in ii if 'requestVar' in self.dq.inx.iref_by_sect[i.uid].a]
211      log.error( 'cmv.00200: %48s [%s]: %s (requested: %s)' % ('CMORvar records with bad vid',len(self.dq.coll['CMORvar'].items),len(ii),len(ii1)) )
212
213      iix2 = []
214      iix3 = []
215      for i in ii1:
216        ok = False
217        ok3 = False
218        for u in self.dq.inx.iref_by_sect[i.uid].a['requestVar']:
219          vg = self.dq.inx.uid[ self.dq.inx.uid[u].vgid ]
220          if vg._h.label != 'remarks':
221           ok = True
222           iix2.append(i)
223           if 'requestLink' in self.dq.inx.iref_by_sect[vg.uid].a:
224             iix3.append(i)
225      log.error( 'cmv.0021: of these: valid requestVarGroup: %s; valid requestLink(s): %s' %  (len(iix2),len(iix3)) )
226      for i in iix3:
227        log.error( 'cmv.0022: %s, %s, %s' % (i.uid,i.label,i.title) )
228         
229    ii2 = [k for k in ccmv2 if len(ccmv2[k]) > 1]
230    if len(ii2) == 0:
231      log.info( 'cmv.0030: unique CMOR variable names OK' )
232    else:
233      log.error( 'cmv.0030: non-unique CMOR variable naming for %s records' % len(ii2) )
234      log.error( 'cmv.0031: %s' % str(ii2) )
235
236    ii4 = [k for k in ccmv4 if len(ccmv4[k]) > 1]
237    if len(ii4) == 0:
238      log.info( 'cmv.0040: unique CMOR variable usage OK' )
239    else:
240      log.error( 'cmv.0040: non-unique CMOR variable usage possible for %s records' % len(ii4) )
241      log.error( 'cmv.0041: %s' % str(ii4) )
242      kk=0
243      oo = open( 'cmv_probDuplication.csv', 'w' )
244      for k in ii4:
245        kk += 1
246        rec = ('NEXT\t%s\t' % kk ) + str( '\t'.join( k ) )
247        print 'INFO.cmvdup.00001: ',rec
248        oo.write( rec + '\n' )
249        vid = None
250        for i in ccmv4[k]:
251          assert vid == None or i.vid == vid, 'Unexpected vid variation ...: %s%s %s' % (i.label, i.vid, vid)
252          vid = i.vid
253          rec = '+\t%s\t%s\t%s\t%s\t%s' % (i.uid,i.mipTable,i.title,i.description,i.prov)
254          oo.write( rec + '\n' )
255          print 'INFO.cmvdup.00001: ',rec
256      oo.close()
257
258    ccmv3 = collections.defaultdict( list )
259    for t in ccmv2:
260      s = set()
261      for i in ccmv2[t]:
262        id = i.uid
263        if 'varRelLnk' in self.dq.inx.iref_by_sect[id].a:
264          for x in self.dq.inx.iref_by_sect[id].a['varRelLnk']:
265            s.add( x )
266      s = list(s)
267      if len(s) > 0:
268        ccmv3[t] = s
269
270    ii5 = [k for k in ii2 if k not in ccmv3 or len(ccmv2[k]) > len(ccmv3[k])]
271    cc4 = collections.defaultdict( list )
272    for t,v in ii2:
273      cc4[t].append( v )
274
275    log.warn( '%48s [%s]: %s [%s tables]' % ('Duplicate variables in CMORvar',len(self.dq.coll['CMORvar'].items),len(ii2), len( cc4.keys() ) ) )
276    showAllCmvErrors=False
277    showAllCmvErrors=True
278    if showAllCmvErrors:
279       rats = ['uid','label','title','description','frequency','mipTable','stid','prov','provNote']
280       oocm = open( 'cmvDup.csv', 'w' )
281       c1 = collections.defaultdict( list )
282       ##for i in ii2:
283         ##c1[i.prov].append( i.label )
284       ##log.warn( 'No MIP var: %s ... %s' % (str( sorted( [i.label for i in ii if i.label in self.cc] ) ), str(c1)))
285       for k in sorted( cc4.keys() ):
286         log.warn(  '%16s::  %s' % (k,str(sorted(cc4[k]))) )
287         for v in sorted(cc4[k]):
288             sv = set()
289             for i in ccmv2[ (k,v) ]:
290                sv.add(i.vid)
291
292             if len(list(sv)) == 1:
293               vun = True
294               vv = self.dq.inx.uid[ list(sv)[0] ]
295               oocm.write( '@VAR:\t\t\t%s\t%s\t%s\n' % (vv.label,vv.title,vv.description) )
296             else:
297               vun = False
298
299             for i in ccmv2[ (k,v) ]:
300                stt = self.dq.inx.uid[i.stid].title
301                if 'Temporal mean' in stt:
302                   if i.frequency == '3hr':
303                     i.title += ' [3 hour mean]'
304                xtra = ''
305                oocm.write( '\t\t' + '\t'.join( [i.__dict__[x] for x in rats] ) + '\t%s%s\n' % (stt,xtra) )
306                if not vun:
307                  vv = self.dq.inx.uid[i.vid]
308                  xtra = '\t\t\t\t%s\t%s\t%s\n' % (vv.label,vv.title,vv.description)
309                  oocm.write(xtra)
310             oocm.write( '####\n' )
311       oocm.close()
312    t2_ii = ii[:]
313    self.ccmv = ccmv
314
315  def audit_sn(self):
316    cc = collections.defaultdict( list )
317    nrem = 0
318    snm = set()
319    for i in self.dq.coll['var'].items:
320      kk = i.sn
321      if self.dq.inx.uid[kk]._h.label == 'remarks':
322        nrem += 1
323        snm.add(kk)
324      if i.procnote != []:
325        ll = sorted( i.procnote )
326        kk += ':' + '|'.join(ll )
327      cc[kk].append( i.uid )
328
329    log.warn( 'sn.001: Number of missing standard names: %s [for %s variables]' % (len(snm),nrem) )
330    ll = []
331    for k in cc:
332      if len( cc[k] ) > 1:
333        ll.append( k )
334
335    log.warn( 'sn.002: Duplicate use of standard names: %s' % len(ll) )
336    oo = open( 'audit_sn_repeats.csv', 'w' )
337    for k in sorted( ll ):
338      orc = [k,]
339      l1 = cc[k][:]
340      l2 = []
341      l1b = []
342      for u in cc[k]:
343        i = self.dq.inx.uid[u]
344        if i.prov == "CMIP6 endorsement [SIMIP]":
345          l2.append(u)
346        else:
347          l1b.append(u)
348      if len( l2) > 1:
349        log.error( 'ERROR: identified multiple priority choices: %s:: %s' % (k,str(l2)) )
350      if len(l2) == 1:
351        orc.append( '*' )
352      else:
353        orc.append( '' )
354
355      for u in l2 +l1b:
356        i = self.dq.inx.uid[u]
357        orc += [i.label, i.title]
358         
359      oo.write( '\t'.join( orc ) + '\n' )
360    oo.close()
361     
362  def audit_rqv(self):
363    ii = [i for i in self.dq.coll['requestVar'].items if self.dq.inx.uid[i.vid]._h.label == 'remarks']
364    ii2 = [i for i in ii if i.label not in self.cc]
365    ii3 = [i.vgid for i in ii if self.dq.inx.uid[i.vgid]._h.label != 'remarks']
366##ii4: set of invalid requestVarGroup records
367    ii4 = [i for i in ii3 if 'requestLink' not in self.dq.inx.iref_by_sect[i].]
368######
369    ii5Info = 'Set of bad requestVar records linking to a valid requestVarGroup records.'
370    ii5 = [i for i in ii if i.vgid not in ii4]
371##ii6: set of bad requestVar records linking to a valid requestVarGroup records and no variable name match.
372    ii6 = [i for i in ii5 if i.label not in self.cc]
373    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)) )
374    log.info ( str( ii5Info ))
375    svg = set()
376    for i in ii5:
377      log.info( 'ii5: %s' % str([i.label, i.title, i.uid, i.mip, self.dq.inx.uid[i.vgid].title] ) )
378      svg.add( i.vgid )
379    for i in ii2:
380      log.info( 'ii2: %s' % str([i.label, i.title, i.uid] ) )
381
382    log.warn( 'rvg.0010: requestVarGroups with bad request vars:' )
383    for u in sorted( list(svg) ):
384      log.warn( 'rvg.0011: %s: %s' % (u, self.dq.inx.uid[u].title ))
385
386    log.info( '    [# records]: # broken [var name not known, link to valid group, valid group and no var name; valid request groups' )
387    showAllRqvErrors=False
388    if showAllRqvErrors:
389      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] ) ) )
390
391    ii1 = [i for i in ii if i.label in self.ccmv]
392    listBadRequestVar=False
393    if listBadRequestVar:
394      for i in ii1:
395        log.info( str( i.label,i.mip,i.table,[x.frequency for x in self.ccmv[i.label]] ) )
396
397  def audit_rql(self):
398    ii = [i for i in self.dq.coll['requestLink'].items if self.dq.inx.uid[i.refid]._h.label == 'remarks']
399    log.info( '%48s: %s (from %s)' % ('Bad request group links in requestLink',len(ii), len(self.dq.coll['requestLink'].items)) )
400
401  def audit_rqg(self):
402    ii = [i for i in self.dq.coll['requestVarGroup'].items if len( dq.inx.iref_by_sect[i.uid].a['requestVar'])  == 0]
403    ii1 = [i for i in ii if len( dq.inx.iref_by_sect[i.uid].a['requestLink'])  != 0]
404    log.info( '%48s: %s/%s (from %s)' % ('Empty request groups',len(ii) - len(ii1),len(ii1), len(self.dq.coll['requestVarGroup'].items)) )
405    listEmptyRequestVarGroups=False
406    if listEmptyRequestVarGroups:
407      for i in ii1:
408        log.info ( '%s: %s, %s' % (i.label, i.title, i.mip) )
409
410dq = dreq.loadDreq()
411a = auditor( dq )
412cd = checkDims( dq )
Note: See TracBrowser for help on using the repository browser.