source: CMIP6dreqbuild/trunk/src/framework/dreqPy/scope.py @ 655

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

bugs in volume estimates in tables

Line 
1"""Date Request Scoping module
2---------------------------
3The scope.py module contains the dreqQuery class and a set of ancilliary functions. The dreqQuery class contains methods for analysing the data request.
4"""
5try:
6  import dreq
7  from utilities import cmvFilter
8except:
9  import dreqPy.dreq
10  from dreqPy.utilities import cmvFilter
11
12import collections, string, operator
13import makeTables
14import sys, os
15
16python2 = True
17if sys.version_info[0] == 3:
18  python2 = False
19  from functools import reduce
20  try: 
21    from utilP3 import mlog3
22  except:
23    from dreqPy.utilP3 import mlog3
24  mlg = mlog3()
25else:
26  from utilP2 import mlog
27  mlg = mlog()
28
29class c1(object):
30  def __init__(self):
31    self.a = collections.defaultdict( int )
32class c1s(object):
33  def __init__(self):
34    self.a = collections.defaultdict( set )
35
36class baseException(Exception):
37  """Basic exception for general use in code."""
38
39  def __init__(self,msg):
40    self.msg = 'scope:: %s' % msg
41
42  def __str__(self):
43    return repr( self.msg )
44
45  def __repr__(self):
46    return self.msg
47
48nt_mcfg = collections.namedtuple( 'mcfg', ['nho','nlo','nha','nla','nlas','nls','nh1'] )
49class cmpd(object):
50  def __init__(self,dct):
51    self.d = dct
52  def cmp(self,x,y,):
53    return cmp( self.d[x], self.d[y] )
54
55    self.default_mcfg = nt_mcfg._make( [259200,60,64800,40,20,5,100] )
56
57def filter1( a, b ):
58  if b < 0:
59    return a
60  else:
61    return min( [a,b] )
62
63def filter2( a, b, tt, tm ):
64## largest tier less than or equal to tm
65  t1 = [t for t in tt if t <= tm][-1]
66  it1 = tt.index(t1)
67  aa = a[it1]
68  if b < 0:
69    return aa
70  else:
71    return min( [aa,b] )
72
73npy = {'1hrClimMon':24*12, 'daily':365, u'Annual':1, u'fx':0.01, u'1hr':24*365, u'3hr':8*365, u'monClim':12, u'Timestep':100, u'6hr':4*365, u'day':365, u'1day':365, u'mon':12, u'yr':1, u'1mon':12, 'month':12, 'year':1, 'monthly':12, 'hr':24*365, 'other':24*365, 'subhr':24*365, 'Day':365, '6h':4*365,
74'3 hourly':8*365, '':1 }
75## There are 4 cmor variables with blank frequency ....
76
77def vol01( sz, v, npy, freq, inx ):
78  n1 = npy[freq]
79  s = sz[inx.uid[v].stid]
80  assert type(s) == type(1), 'Non-integer size found for %s' % v
81  assert type(n1) in (type(1),type(0.)), 'Non-number "npy" found for %s, [%s]' % (v,freq)
82  return s*n1
83
84class col_list(object):
85  def __init__(self):
86    self.a = collections.defaultdict(list)
87
88class col_count(object):
89  def __init__(self):
90    self.a = collections.defaultdict(int)
91
92class dreqQuery(object):
93  __doc__ = """Methods to analyse the data request, including data volume estimates"""
94  def __init__(self,dq=None,tierMax=1):
95    if dq == None:
96      self.dq = dreq.loadDreq()
97    else:
98      self.dq=dq
99    self.rlu = {}
100    for i in self.dq.coll['objective'].items:
101      k = '%s.%s' % (i.mip,i.label)
102      assert not k in self.rlu, 'Duplicate label in objectives: %s' % k
103      self.rlu[k] = i.uid
104
105    self.cmvFilter = cmvFilter( self )
106    self.tierMax = tierMax
107
108    self.mips = set( [x.label for x in self.dq.coll['mip'].items ] )
109    self.experiments = set( [x.uid for x in self.dq.coll['experiment'].items ] )
110    self.exptByLabel = {}
111    for x in self.dq.coll['experiment'].items:
112      if x.label in self.exptByLabel:
113        print ( 'ERROR: experiment label duplicated: %s' % x.label )
114      self.exptByLabel[x.label] = x.uid
115    self.mipls = sorted( list( self.mips ) )
116
117    self.default_mcfg = nt_mcfg._make( [259200,60,64800,40,20,5,100] )
118    self.mcfg = self.default_mcfg._asdict()
119    ##for k in self.default_mcfg.__dict__.keys():
120      ##self.mcfg[k] = self.default_mcfg.__dict__[k]
121    self.szcfg()
122    self.requestItemExpAll(  )
123
124  def szcfg(self):
125    szr = {'100km':64800, '1deg':64800, '2deg':16200 }
126    self.szss = {}
127    self.sz = {}
128    self.szg = collections.defaultdict( dict )
129    self.szgss = collections.defaultdict( dict )
130    for i in self.dq.coll['spatialShape'].items:
131      type = 'a'
132      if i.levelFlag == False:
133        ds =  i.dimensions.split( '|' )
134        if ds[-1] in ['site', 'basin']:
135          vd = ds[-2]
136        else:
137          vd = ds[-1]
138 
139        if vd[:4] == 'olev' or vd == 'rho':
140          type = 'o'
141          nz = self.mcfg['nlo']
142        elif vd[:4] == 'alev':
143          nz = self.mcfg['nla']
144        elif vd in ['slevel','sdepth']:
145          nz = self.mcfg['nls']
146        elif vd == 'aslevel':
147          nz = self.mcfg['nlas']
148        else:
149          mlg.prnt( 'Failed to parse dimensions %s' % i.dimensions )
150          raise
151      else:
152        nz = i.levels
153
154      dims = set( i.dimensions.split( '|' ) )
155      if 'latitude' in dims and 'longitude' in dims:
156        if type == 'o':
157          nh = self.mcfg['nho']
158        else:
159          nh = self.mcfg['nha']
160      else:
161        nh = 10
162
163      self.szss[i.uid] = nh*nz
164      for k in szr:
165        self.szgss[k][i.uid] = szr[k]*nz
166    for i in self.dq.coll['structure'].items:
167      s = 1
168      if i.odims != '':
169        s = s*5
170      self.sz[i.uid] = self.szss[i.spid]*s
171      for k in szr:
172        self.szg[k][i.uid] = self.szgss[k][i.spid]*s
173
174  def getRequestLinkByMip( self, mipSel ):
175    """Return the set of request links which are associated with specified MIP"""
176
177    if type(mipSel) == type( {} ):
178      return self.getRequestLinkByMipObjective(self,mipSel)
179
180    if type(mipSel) == type(''):
181      t1 = lambda x: x == mipSel
182    elif type(mipSel) == type(set()):
183      t1 = lambda x: x in mipSel
184
185    s = set()
186    for i in self.dq.coll['objectiveLink'].items:
187      if t1(i.label):
188        s.add( self.dq.inx.uid[i.rid] )
189
190    ##self.rqs = list({self.dq.inx.uid[i.rid] for i in self.dq.coll['objectiveLink'].items if t1(i.label) })
191    self.rqs = list( s )
192    return self.rqs
193
194  def getRequestLinkByMipObjective( self, mipSel ):
195    """Return the set of request links which are associated with specified MIP and its objectives"""
196
197    assert type(mipSel) == type( {} ),'Argument must be a dictionary, listing objectives for each MIP'
198
199    s = set()
200    for i in self.dq.coll['objectiveLink'].items:
201      if i.label in mipSel:
202        if len(mipSel[i]) == 0 or self.dq.inx.uid[i.oid].label in mipSel[i]:
203          s.add( self.dq.inx.uid[i.rid] )
204    ##self.rqs = list({self.dq.inx.uid[i.rid] for i in self.dq.coll['objectiveLink'].items if t1(i.label) })
205    self.rqs = list( s )
206    return self.rqs
207
208
209  def getRequestLinkByObjective( self, objSel ):
210    """Return the set of request links which are associated with specified objectives"""
211    if type(objSel) == type(''):
212      t1 = lambda x: x == self.rlu[objSel]
213    elif type(objSel) == type(set()):
214      t1 = lambda x: x in [self.rlu[i] for i in objSel]
215
216    s = set()
217    for i in self.dq.coll['objectiveLink'].items:
218      if t1(i.label):
219        s.add( self.dq.inx.uid[i.oid] )
220##
221    self.rqs = list( s )
222    ##self.rqs = list({self.dq.inx.uid[i.rid] for i in self.dq.coll['objectiveLink'].items if t1(i.oid) })
223    return self.rqs
224
225  def varGroupXexpt(self, rqList ):
226    """For a list of request links, return a list of variable group IDs for each experiment"""
227    self.cc = collections.defaultdict( list )
228    ## dummy = {self.cc[i.expt].append(i.rlid) for i in self.dq.coll['requestItem'].items if i.rlid in {j.uid for j in rqList} }
229    return self.cc
230
231  def yearsInRequest(self, rql ):
232    self.ntot = sum( [i.ny for i in self.dq.coll['requestItem'].items if i.rlid == rql.uid] )
233    return self.ntot
234
235  def rqlByExpt( self, l1, ex, pmax=2, expFullEx=False ):
236    """rqlByExpt: return a set of request links for an experiment"""
237##
238    inx = self.dq.inx
239
240    if ex != None:
241   
242      exi = self.dq.inx.uid[ex]
243      if exi._h.label == 'experiment':
244        exset = set( [ex,exi.egid,exi.mip] )
245      else:
246        exset = set( self.esid_to_exptList(ex,deref=False,full=expFullEx) )
247##
248## rql is the set of all request links which are associated with a request item for this experiment set
249##
250   
251      l1p = set()
252      for i in l1:
253        if i.preset < 0 or i.preset <= pmax:
254          if i.esid in exset:
255            l1p.add(i)
256    else:
257      exset = None
258      l1p = l1
259
260    rql0 = set()
261    for i in l1p:
262       rql0.add(i.rlid)
263
264    rqlInv = set()
265    for u in rql0:
266      if inx.uid[u]._h.label == 'remarks':
267        rqlInv.add( u )
268    if len(rqlInv) != 0:
269      mlg.prnt ( 'WARNING.001.00002: %s invalid request links from request items ...' % len(rqlInv) )
270    rql = set()
271    for u in rql0:
272       if inx.uid[u]._h.label != 'remarks':
273         rql.add( u ) 
274
275    return rql, l1p, exset
276
277  def varsByRql( self, rql, pmax=2, intersection=False): 
278      """The complete set of variables associated with a set of rquest links."""
279      inx = self.dq.inx
280      cc1 = collections.defaultdict( set )
281      for i in rql:
282        o = inx.uid[i]
283        if o.opt == 'priority':
284          p = int( float( o.opar ) )
285          assert p in [1,2,3], 'Priority incorrectly set .. %s, %s, %s' % (o.label,o.title, o.uid)
286          cc1[inx.uid[i].mip].add( (inx.uid[i].refid,p) )
287        else:
288          cc1[inx.uid[i].mip].add( inx.uid[i].refid )
289
290      if intersection:
291        ccv = {}
292#
293# set of request variables for each MIP
294#
295        for k in cc1:
296          thisc = reduce( operator.or_, [set( inx.iref_by_sect[vg].a['requestVar'] ) for vg in cc1[k] ] )
297          rqvgs = collections.defaultdict( set )
298          for x in cc1[k]:
299            if type(x) == type( () ):
300              rqvgs[x[0]].add( x[1] )
301            else:
302              rqvgs[x].add( 3 )
303         
304          s = set()
305          for vg in rqvgs:
306            for l in inx.iref_by_sect[vg].a['requestVar']:
307              if inx.uid[l].priority <= min(pmax,max(rqvgs[vg])):
308                s.add( inx.uid[l].vid )
309          ccv[k] = s
310
311        if len( ccv.keys() ) < len( list(imips) ):
312          vars = set()
313        else:
314          vars =  reduce( operator.and_, [ccv[k] for k in ccv] )
315      else:
316        rqvgs = collections.defaultdict( set )
317        for k in cc1:
318          for x in cc1[k]:
319            if type(x) == type( () ):
320              rqvgs[x[0]].add( x[1] )
321            else:
322              rqvgs[x].add( 3 )
323         
324###To obtain a set of variables associated with this collection of variable groups:
325
326        vars = set()
327        for vg in rqvgs:
328          for l in inx.iref_by_sect[vg].a['requestVar']:
329            if inx.uid[l].priority <= min(pmax,max(rqvgs[vg])):
330               vars.add(inx.uid[l].vid)
331        ##col1 = reduce( operator.or_, [set( inx.iref_by_sect[vg].a['requestVar'] ) for vg in rqvg ] )
332
333### filter out cases where the request does not point to a CMOR variable.
334    ##vars = {vid for vid in vars if inx.uid[vid][0] == u'CMORvar'}
335      thisvars = set()
336      for vid in vars:
337         if inx.uid[vid]._h.label == u'CMORvar':
338             thisvars.add(vid)
339
340      return thisvars
341
342  def volByExpt( self, l1, ex, pmax=1, cc=None, retainRedundantRank=False, intersection=False,expFullEx=False, adsCount=False ):
343    """volByExpt: calculates the total data volume associated with an experiment/experiment group and a list of request items.
344          The calculation has some approximations concerning the number of years in each experiment group.
345          cc: an optional collector, to accumulate indexed volumes. """
346##
347    inx = self.dq.inx
348    imips = set()
349    for i in l1:
350      imips.add(i.mip)
351   
352    rql, l1p, exset = self.rqlByExpt( l1, ex, pmax=pmax, expFullEx=expFullEx )
353    verbose = False
354    if verbose:
355      for i in rql:
356        r = inx.uid[i]
357        print ( '%s, %s, %s' % (r.label, r.title, r.uid) )
358
359    dn = False
360    if dn:
361## obsolete code deleted here
362      pass
363    elif ex != None:
364     
365      exi = self.dq.inx.uid[ex]
366      if exi._h.label == 'experiment':
367        exset = set( [ex,exi.egid,exi.mip] )
368#####
369    if len( rql ) == 0:
370      self.vars = set()
371      return (0,{},{} )
372
373## The complete set of variables associated with these requests:
374    vars = self.varsByRql( rql, pmax=pmax, intersection=intersection) 
375    tm = 3
376    if tm == 0:
377      pass
378    elif tm == 1:
379      pass
380##
381## filter by configuration option and rank
382##
383    if not retainRedundantRank:
384      len1 = len(vars)
385      cmv = self.cmvFilter.filterByChoiceRank(cmv=vars)
386
387      vars = cmv
388   
389    self.vars = vars
390
391    e = {}
392    for u in rql:
393### for request variables which reference the variable group attached to the link, add the associate CMOR variables, subject to priority
394      i = inx.uid[u]
395      e[i.uid] = set()
396      si = collections.defaultdict( list )
397      for x in inx.iref_by_sect[i.refid].a['requestVar']:
398           if inx.uid[x].priority <= pmax:
399              e[i.uid].add( inx.uid[x].vid )
400
401              if verbose:
402                cmv = inx.uid[inx.uid[x].vid]
403                if cmv._h.label == 'CMORvar':
404                  si[ cmv.mipTable ].append( inx.uid[x].label )
405#
406# for each variable, calculate the maximum number of years across all the request links which reference that variable.
407##
408## for each request item we have nymax, nenmax, nexmax.
409##
410    nymg = collections.defaultdict( dict )
411##
412## if dataset count rather than volume is wanted, use item 3 from rqiExp tuple.
413    if adsCount:
414      irqi = 3
415    else:
416      irqi = 2
417
418    sgg = set()
419    for v in vars:
420      s = set()
421      sg = collections.defaultdict( set )
422      cc2 = collections.defaultdict( set )
423      cc2s = collections.defaultdict( c1s )
424      for i in l1p:
425##################
426        if (exset == None or i.esid in exset) and v in e[i.rlid]:
427          ix = inx.uid[i.esid]
428          rl = inx.uid[i.rlid]
429          sgg.add( rl.grid )
430          if rl.grid in ['100km','1deg','2deg']:
431            grd = rl.grid
432          else:
433            grd = 'native'
434
435          this = None
436          if exset == None:
437            thisz = 100
438##
439## for a single experiment, look up n years, and n ensemble.
440## should have nstart????
441##
442          elif exi._h.label == 'experiment' or ix._h.label == 'experiment':
443            this = None
444            if ex in self.rqiExp[i.uid][1]:
445              this = self.rqiExp[i.uid][1][ex]
446            elif ix.uid in self.rqiExp[i.uid][1]:
447              this = self.rqiExp[i.uid][1][ix.uid]
448            if this != None:
449              thisns = this[-3]
450              thisny = this[-2]
451              thisne = this[-1]
452              cc2s[grd].a[u].add( filter1( thisns*thisny*thisne, i.nymax) )
453          else:
454            thisz = None
455            if 'experiment' in inx.iref_by_sect[i.esid].a:
456              for u in inx.iref_by_sect[i.esid].a['experiment']:
457                if u in self.rqiExp[i.uid][1]:
458                  this = self.rqiExp[i.uid][1][u]
459                  thisns = this[-3]
460                  thisny = this[-2]
461                  thisne = this[-1]
462                  cc2s[grd].a[u].add( filter1( thisns*thisny*thisne, i.nymax) )
463
464          ##if thisny != None and thisne != None:
465              ##cc2s[grd].a[i.esid].add( thisny*thisne )
466         
467          if exset != None:
468            sg[grd].add( self.rqiExp[i.uid][irqi] )
469     
470      ##if len(s) == 0:
471        ##nym[v] = 0
472      ##else:
473###
474### sum over experiments of maximum within each experiment
475###
476        ##nym[v] = sum( [max( cc2[k] ) for k in cc2] )
477      for g in sg:
478        nymg[v][g] = sum( [max( cc2s[g].a[k] ) for k in cc2s[g].a] )
479
480    szv = {}
481    ov = []
482    for v in vars:
483      szv[v] = self.sz[inx.uid[v].stid]*npy[inx.uid[v].frequency]
484      ov.append( self.dq.inx.uid[v] )
485    ee = self.listIndexDual( ov, 'mipTable', 'label', acount=None, alist=None, cdict=szv, cc=cc )
486
487    ff = {}
488    for v in vars:
489      if adsCount:
490        ff[v] = 1
491      else:
492        if 'native' in nymg[v]:
493          ff[v] = self.sz[ inx.uid[v].stid ] * npy[inx.uid[v].frequency]
494          ny = nymg[v]['native']
495        else:
496          if len( nymg[v] ) > 1:
497            print ( '########### Selecting first in list .............' )
498          ks0 = nymg[v].keys()
499          if len(ks0) == 0:
500            ##print 'WARN: no nymg entry for %s [%s]' % (v,ex)
501            ff[v] = 0.
502            ny = 0.
503          else:
504            ks = list( nymg[v].keys() )[0]
505            ny = nymg[v][ks]
506            ff[v] = self.szg[ks][ inx.uid[v].stid ] * npy[inx.uid[v].frequency]
507
508        if inx.uid[v].frequency != 'monClim':
509          ff[v] = ff[v]*ny
510    self.ngptot = sum( [  ff[v]  for v in vars] )
511    return (self.ngptot, ee, ff )
512
513  def esid_to_exptList(self,esid,deref=False,full=False):
514    if not esid in self.dq.inx.uid:
515      mlg.prnt ( 'Attempt to dereferece invalid uid: %s' % esid )
516      raise
517
518    if self.dq.inx.uid[esid]._h.label == 'experiment':
519      expts = [esid,]
520    elif self.dq.inx.uid[esid]._h.label != 'remarks':
521      if esid in self.dq.inx.iref_by_sect and 'experiment' in self.dq.inx.iref_by_sect[esid].a:
522        expts = list( self.dq.inx.iref_by_sect[esid].a['experiment'][:] )
523      else:
524        expts = []
525
526## add in groups and mips for completeness
527##
528      if full:
529        if self.dq.inx.uid[esid]._h.label == 'mip':
530          s = set()
531          for e in expts:
532            if self.dq.inx.uid[e]._h.label != 'experiment':
533              mlg.prnt ( 'ERROR: %s, %s, %s ' % (esid,e, self.dq.inx.uid[e].title ) )
534            s.add( self.dq.inx.uid[e].egid )
535          for i in s:
536            expts.append( i )
537        expts.append( esid )
538    else:
539      ##print ( 'WARNING: request link not associated with valid experiment group' )
540      ##raise
541      return None
542
543    if self.tierMax > 0:
544      expts1 = []
545      for i in expts:
546        if self.dq.inx.uid[i]._h.label == 'experiment':
547          if self.dq.inx.uid[i].tier[0] <= self.tierMax:
548            expts1.append( i )
549        elif self.dq.inx.uid[i]._h.label == 'exptgroup':
550          if self.dq.inx.uid[i].tierMin <= self.tierMax:
551            expts1.append( i )
552        else:
553            expts1.append( i )
554    else:
555      expts1 = expts
556
557    if deref:
558      return [self.dq.inx.uid[e] for e in expts1]
559    else:
560      return expts1
561 
562##
563## need to call this on load
564## then use instead of i.ny etc below
565##
566  def requestItemExpAll( self ):
567    self.rqiExp = {}
568    for rqi in self.dq.coll['requestItem'].items:
569      a,b,c,d = self.requestItemExp( rqi )
570      if a != None:
571        self.rqiExp[rqi.uid] = (a,b,c,d)
572
573  def requestItemExp( self, rqi ):
574    assert rqi._h.label == "requestItem", 'Argument to requestItemExp must be a requestItem'
575    u = rqi.esid
576    if self.dq.inx.uid[u]._h.label == 'experiment':
577      expts = [u,]
578    elif self.dq.inx.uid[u]._h.label != 'remarks':
579      if u in self.dq.inx.iref_by_sect and 'experiment' in self.dq.inx.iref_by_sect[u].a:
580        expts = self.dq.inx.iref_by_sect[u].a['experiment']
581      else:
582        expts = []
583    else:
584      # print ( 'WARNING: request link not associated with valid experiment group'  )
585      ##rqi.__info__()
586      ##raise
587      return (None, None, None, None)
588
589    if self.tierMax > 0:
590      expts = [i for i in expts if self.dq.inx.uid[i].tier[0] <= self.tierMax]
591
592    self.multiTierOnly = False
593    if self.multiTierOnly:
594      expts = [i for i in expts if len(self.dq.inx.uid[i].tier) > 1]
595      print ('Len expts: %s' % len(expts) )
596
597    if len(expts) > 0:
598      e = [self.dq.inx.uid[i] for i in expts]
599      for i in e:
600        if i._h.label != 'experiment':
601          mlg.prnt ( 'ERROR: %s, %s, %s ' % ( u,i._h.label, i.label, i.title ) )
602      ##dat = [ (i.ntot, i.yps, i.ensz, i.tier, i.nstart, filter1(i.yps,rqi.nymax), filter2(i.ensz,rqi.nenmax,i.tier,self.tierMax) ) for i in e]
603      dat2 = {}
604      for i in e:
605        dat2[i.uid] = (i.ntot, i.yps, i.ensz, i.tier, i.nstart, filter1(i.yps,rqi.nymax), filter2(i.ensz,rqi.nenmax,i.tier,self.tierMax) )
606        ##print i.label, rqi.title, dat2[i.uid]
607      ### number of
608      nytot = sum( [dat2[x][-2]*dat2[x][-3] for x in dat2 ] )
609      netot = sum( [dat2[x][-1] for x in dat2 ] )
610      ##print 'debug1:: ',dat, nytot, netot
611    else:
612      dat2 = {}
613      nytot = 0
614      netot = 0
615   
616    return (expts, dat2, nytot, netot )
617
618  def setTierMax( self, tierMax ):
619    """Set the maxium tier and recompute request sizes"""
620    if tierMax != self.tierMax:
621      self.tierMax = tierMax
622      self.requestItemExpAll(  )
623
624  def summaryByMip( self, pmax=1 ):
625    bytesPerFloat = 2.
626    for m in self.mipls:
627      v = self.volByMip( m, pmax=pmax )
628      mlg.prnt ( '%12.12s: %6.2fTb' % (m,v*bytesPerFloat*1.e-12) )
629
630  def rqiByMip( self, mip):
631
632    if mip == 'TOTAL':
633        mip = self.mips
634    if type(mip) in [type( '' ),type( u'') ]:
635      if mip not in self.mips:
636        mlg.prnt ( self.mips )
637        raise baseException( 'rqiByMip: Name of mip not recognised: %s' % mip )
638      l1 = [i for i in  self.dq.coll['requestItem'].items if i.mip == mip]
639    elif type(mip) == type( set()):
640      nf = [ m for m in mip if m not in self.mips]
641      if len(nf) > 0:
642          raise baseException( 'rqiByMip: Name of mip(s) not recognised: %s' % str(nf) )
643      l1 = [i for i in  self.dq.coll['requestItem'].items if i.mip in mip]
644    elif type(mip) == type( dict()):
645      nf = [ m for m in mip if m not in self.mips]
646      if len(nf) > 0:
647        raise baseException( 'rqiByMip: Name of mip(s) not recognised: %s' % str(nf) )
648      l1 = []
649      for i in  self.dq.coll['requestLink'].items:
650        if i.mip in mip:
651          ok = False
652          if len( mip[i.mip] ) == 0:
653            ok = True
654          else:
655            for ol in self.dq.inx.iref_by_sect[i.uid].a['objectiveLink']:
656              o = self.dq.inx.uid[ol]
657              if self.dq.inx.uid[o.oid].label in mip[i.mip]:
658                ok = True
659          if ok:
660              if 'requestItem' in self.dq.inx.iref_by_sect[i.uid].a:
661                for u in self.dq.inx.iref_by_sect[i.uid].a['requestItem']:
662                  l1.append( self.dq.inx.uid[u] )
663    else:
664      raise baseException( 'rqiByMip: "mip" (1st explicit argument) should be type string or set: %s -- %s' % (mip, type(mip))   )
665
666    return l1
667
668  def checkDir(self,odir,msg):
669      if not os.path.isdir( odir ):
670         try:
671            os.mkdir( odir )
672         except:
673            print ('\n\nFailed to make directory "%s" for: %s: make necessary subdirectories or run where you have write access' % (odir,msg) )
674            print ( '\n\n' )
675            raise
676         print ('Created directory %s for: %s' % (odir,msg) )
677
678
679  def xlsByMipExpt(self,m,ex,pmax,odir='xls'):
680
681    mips = ['AerChemMIP', 'C4MIP', 'CFMIP', 'DAMIP', 'DCPP', 'FAFMIP', 'GeoMIP', 'GMMIP', 'HighResMIP', 'ISMIP6', 'LS3MIP', 'LUMIP', 'OMIP', 'PMIP', 'RFMIP', 'ScenarioMIP', 'VolMIP', 'CORDEX', 'DynVar', 'SIMIP', 'VIACSAB']
682    tabs = makeTables.tables( self, mips, odir=odir )
683    cc = collections.defaultdict( c1 )
684    mlab = tabs.setMlab( m )
685    cc[mlab].dd = {}
686    cc[mlab].ee = {}
687    if m == 'TOTAL':
688        l1 = self.rqiByMip( set( mips ) )
689    else:
690        l1 = self.rqiByMip( m )
691
692    ###print 'len l1:',len(l1)
693    self.checkDir( odir, 'xls files' )
694    if ex == None:
695      for m2 in mips:
696        l12 = self.rqiByMip( m2 )
697        tabs.doTable(m,l12,m2,pmax,cc, mlab=mlab, acc=True)
698         
699    tabs.doTable(m,l1,ex,pmax,cc, mlab=mlab)
700     
701  def volByMip( self, mip, pmax=2, retainRedundantRank=False, intersection=False, adsCount=False, exptid=None):
702
703    l1 = self.rqiByMip( mip )
704     
705    #### The set of experiments/experiment groups:
706    if exptid == None:
707      ##exps = self.mips
708      exps = self.experiments
709    else:
710      exps = set( [exptid,] )
711      ##print exptid, exps
712   
713    self.volByE = {}
714    vtot = 0
715    cc = collections.defaultdict( col_count )
716    self.allVars = set()
717    for e in exps:
718      expts = self.esid_to_exptList(e,deref=True,full=False)
719      print 'EXPTS: ',e,len(expts)
720      if expts not in  [None,[]]:
721        for ei in expts:
722          self.volByE[ei.label] = self.volByExpt( l1, ei.uid, pmax=pmax, cc=cc, retainRedundantRank=retainRedundantRank, intersection=intersection, adsCount=adsCount )
723          vtot += self.volByE[ei.label][0]
724        self.allVars = self.allVars.union( self.vars )
725      ##else:
726        ##print 'No expts found: ',e
727    self.indexedVol = cc
728
729    return vtot
730
731  def listIndexDual(self, ll, a1, a2, acount=None, alist=None, cdict=None, cc=None ):
732    do_count = acount != None
733    do_list = alist != None
734    assert not (do_count and do_list), 'It is an error to request both list and count'
735    if not (do_count or do_list):
736      acount = '__number__'
737      do_count = True
738
739    if cc == None:
740      if do_count:
741        cc = collections.defaultdict( col_count )
742      elif do_list:
743        cc = collections.defaultdict( col_list )
744
745    if do_count:
746      for l in ll:
747        if cdict != None:
748          v = cdict[l.uid]
749        elif acount == '__number__':
750          v = 1
751        else:
752          v = l.__dict__[acount]
753
754        cc[ l.__dict__[a1] ].a[ l.__dict__[a2] ] += v
755    elif do_list:
756      for l in ll:
757        if cdict != None:
758          v = cdict[l.uid]
759        elif alist == '__item__':
760          v = l
761        else:
762          v = l.__dict__[alist]
763        cc[ l.__dict__[a1] ].a[ l.__dict__[a2] ].append( v )
764
765    od = {}
766    for k in cc.keys():
767      d2 = {}
768      for k2 in cc[k].a.keys():
769        d2[k2] = cc[k].a[k2]
770      od[k] = d2
771    return od
772
773class dreqUI(object):
774  """Data Request Command line.
775-------------------------
776      -v : print version and exit;
777      --unitTest : run some simple tests;
778      -m <mip>:  MIP of list of MIPs (comma separated; for objective selection see note [1] below);
779      -h :       help: print help text;
780      -e <expt>: experiment;
781      -t <tier> maxmum tier;
782      -p <priority>  maximum priority;
783      --xls : Create Excel file with requested variables;
784      --xlsDir <directory> : Directory in which to place variable listing [xls];
785      --printLinesMax <n>: Maximum number of lines to be printed
786      --printVars  : If present, a summary of the variables fitting the selection options will be printed
787      --intersection : Analyse the intersection of requests rather than union.
788
789NOTES
790-----
791[1] A set of objectives within a MIP can be specified in the command line. The extended syntax of the "-m" argument is:
792-m <mip>[:objective[.obj2[.obj3 ...]]][,<mip2]...]
793
794e.g.
795drq -m HighResMIP:Ocean.DiurnalCycle
796"""
797  def __init__(self,args):
798    self.adict = {}
799    self.knownargs = {'-m':('m',True), '-p':('p',True), '-e':('e',True), '-t':('t',True), \
800                      '-h':('h',False), '--printLinesMax':('plm',True), \
801                      '--printVars':('vars',False), '--intersection':('intersection',False), \
802                      '--count':('count',False), \
803                      '--xlsDir':('xlsdir',True), '--xls':('xls',False) \
804                       } 
805    aa = args[:]
806    notKnownArgs = []
807    while len(aa) > 0:
808      a = aa.pop(0)
809      if a in self.knownargs:
810        b = self.knownargs[a][0]
811        if self.knownargs[a][1]:
812          v = aa.pop(0)
813          self.adict[b] = v
814        else:
815          self.adict[b] = True
816      else:
817        notKnownArgs.append(a)
818
819    assert self.checkArgs( notKnownArgs ), 'FATAL ERROR 001: Arguments not recognised: %s' % (str(notKnownArgs) )
820
821    if 'm' in self.adict:
822      if self.adict['m'].find( ':' ) != -1:
823        ee = {}
824        for i in self.adict['m'].split(','):
825          bits =  i.split( ':' )
826          if len( bits ) == 1:
827             ee[bits[0]] = []
828          else:
829             assert len(bits) == 2, 'Cannot parse %s' % self.adict['m']
830             ee[bits[0]] = bits[1].split( '.' )
831        self.adict['m'] = ee
832      else:
833        self.adict['m'] = set(self.adict['m'].split(',') )
834
835    integerArgs = set( ['p','t','plm'] )
836    for i in integerArgs.intersection( self.adict ):
837      self.adict[i] = int( self.adict[i] )
838
839    self.intersection = self.adict.get( 'intersection', False )
840
841 
842  def checkArgs( self, notKnownArgs ):
843    if len( notKnownArgs ) == 0:
844      return True
845    print ('--------------------------------------')
846    print ('------------  %s Arguments Not Recognised ------------' % len(notKnownArgs) )
847    k = 0
848    for x in notKnownArgs:
849      k += 1
850      if x[1:] in self.knownargs:
851        print ( '%s PERHAPS %s instead of %s' % (k, x[1:],x) )
852      elif '-%s' % x in self.knownargs:
853        print ( '%s PERHAPS -%s instead of %s' % (k, x,x) )
854      elif x[0] == '\xe2':
855        print ( '%s POSSIBLY -- (double hyphen) instead of long dash in %s' % (k, x) )
856    print ('--------------------------------------')
857
858    return len( notKnownArgs ) == 0
859     
860  def run(self, dq=None):
861    if 'h' in self.adict:
862      mlg.prnt ( self.__doc__ )
863      return
864
865    if not 'm' in self.adict:
866      mlg.prnt ( 'Current version requires -m argument'  )
867      mlg.prnt ( self.__doc__ )
868      sys.exit(0)
869
870    if dq == None:
871      self.dq = dreq.loadDreq()
872    else:
873      self.dq = None
874
875    self.sc = dreqQuery( dq=self.dq )
876
877    ok = True
878    for i in self.adict['m']:
879        if i not in self.sc.mips:
880          ok = False
881          mlg.prnt ( 'NOT FOUND: %s' % i )
882
883    eid = None
884    ex = None
885    if 'e' in self.adict:
886      ex = self.adict['e']
887      for i in self.dq.coll['experiment'].items:
888        if i.label == self.adict['e']:
889          eid = i.uid
890      assert eid != None, 'Experiment %s not found' % self.adict['e']
891    ##print ( 'eid=%s' % eid )
892    assert ok,'Available MIPs: %s' % str(self.sc.mips)
893    adsCount = self.adict.get( 'count', False )
894
895    tierMax = self.adict.get( 't', 1 )
896    self.sc.setTierMax(  tierMax )
897    pmax = self.adict.get( 'p', 1 )
898    self.getVolByMip(pmax,eid,adsCount)
899    makeXls = self.adict.get( 'xls', False )
900    if makeXls:
901      mips = self.adict['m']
902      odir = self.adict.get( 'xlsdir', 'xls' )
903      self.sc.checkDir( odir, 'xls files' )
904
905      self.sc.xlsByMipExpt(mips,eid,pmax,odir=odir)
906 
907
908  def getVolByMip(self,pmax,eid,adsCount):
909
910    v0 = self.sc.volByMip( self.adict['m'], pmax=pmax, intersection=self.intersection, adsCount=adsCount, exptid=eid )
911    #mlg.prnt ( '%7.2fTb' % (v0*2.*1.e-12) )
912    mlg.prnt ( '%s [%s]' % (v0,makeTables.vfmt(v0*2.)) )
913    cc = collections.defaultdict( int )
914    for e in self.sc.volByE:
915      for v in self.sc.volByE[e][2]:
916          cc[v] += self.sc.volByE[e][2][v]
917    x = 0
918    for v in cc:
919      x += cc[v]
920   
921    if python2:
922      vl = sorted( cc.keys(), cmp=cmpd(cc).cmp, reverse=True )
923    else:
924      vl = sorted( cc.keys(), key=lambda x: cc[x], reverse=True )
925    if self.adict.get( 'vars', False ):
926      printLinesMax = self.adict.get( 'plm', 20 )
927      if printLinesMax > 0:
928        mx = min( [printLinesMax,len(vl)] )
929      else:
930        mx = len(vl)
931
932      for v in vl[:mx]:
933        mlg.prnt ( '%s: %7.2fTb' % (self.dq.inx.uid[v].label, cc[v]*2.*1.e-12) )
934
Note: See TracBrowser for help on using the repository browser.