source: CMIP6dreq/trunk/dreqPy/scope.py @ 752

Subversion URL: http://proj.badc.rl.ac.uk/svn/exarch/CMIP6dreq/trunk/dreqPy/scope.py@752
Revision 752, 34.8 KB checked in by mjuckes, 3 years ago (diff)

checked distrib cand

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