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

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

candidate 01.00.12

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"""
5
6class exYr(object):
7  def __init__(self):
8    pass
9
10try:
11  import dreq
12  imm=1
13except:
14  import dreqPy.dreq  as dreq
15  imm=2
16
17if imm == 1:
18  from utilities import cmvFilter, gridOptionSort
19  import misc_utils
20  import fgrid
21  import volsum
22else:
23  import dreqPy.volsum as volsum
24  import dreqPy.fgrid as fgrid
25  from dreqPy.utilities import cmvFilter, gridOptionSort
26  import dreqPy.misc_utils as misc_utils
27
28import collections, string, operator
29import sys, os
30
31def intdict():
32    return collections.defaultdict( int )
33
34if sys.version_info >= (2,7):
35  oldpython = False
36else:
37  oldpython = True
38
39gridSorter = gridOptionSort( oldpython )
40
41class timeSlice( object ):
42  def __init__(self,tsl):
43    self.tsl = tsl
44
45  def sort(self):
46    tsl = self.tsl
47    s = set()
48    ee = dict()
49    for ts in tsl:
50      if ts[0] == None:
51        return (1,ts,'Taking unsliced option')
52      s.add( ts[0][1] )
53      ee[ts[0][0]] = ts
54    tst = s.pop()
55    p = min( [ee[k][1] for k in ee.keys()] )
56    if len(s) > 0 or tst == 'dayList':
57      if sorted(ee.keys()) in [['piControl030a','piControl200'],['piControl030', 'piControl030a', 'piControl200']]:
58        return (1,(ee['piControl200'][0],p), 'Taking larger slice (possible alignment issues)')
59      elif sorted(ee.keys()) in [['piControl030', 'piControl030a']]:
60        return (1,(ee['piControl030'][0],p), 'Taking preferred slice (possible alignment issues)')
61      elif sorted(ee.keys()) == ['RFMIP','RFMIP2']:
62        return (1,(('RFMIP-union', 'dayList', None, None),p), 'Taking ad-hoc union')
63      elif sorted(ee.keys()) == ['RFMIP', 'RFMIP2', 'hist55']:
64        return (1,(('hist55plus', 'rangeplus', 1960, 2014),p), 'Taking ad-hoc union with extra ...')
65      elif sorted(ee.keys()) == ['RFMIP', 'hist55']:
66        return (1,(ee['hist55'][0],p), 'Taking larger containing slice')
67      elif sorted(ee.keys()) == ['DAMIP20','DAMIP40']:
68        return (1,(ee['DAMIP40'][0],p), 'Taking larger containing slice')
69      return (-1,None,'Multiple slice types: %s' % sorted(ee.keys()))
70
71    if not ( tst == 'simpleRange' or (len(tst) > 13 and tst[:13] == 'branchedYears') ):
72      return (-2,None,'slice type aggregation not supported')
73    if len(tsl) == 2:
74      tsll = list( tsl )
75      sa,ea = tsll[0][0][2:]
76      sb,eb = tsll[1][0][2:]
77      if sa <= sb and ea >= eb:
78        return (1,tsll[0], 'Taking largest slice')
79      if sb <= sa and eb >= ea:
80        return (1,tsll[1], 'Taking largest slice')
81      if ea < sb or eb < sa:
82        return (2,tsll, 'Slices are disjoint')
83      return (-3,None, 'Overlapping slices')
84    else:
85##
86## sort by end year and length .. if longest of last ending is also the first starting, we can sort ...
87##
88      tsll = sorted( list(tsl), key=lambda x: (x[0][3],x[0][3]-x[0][2]) )
89      if min( [x[0][2] for x in tsll] ) == tsll[-1][0][2]:
90        return (1,tsll[-1], 'Taking largest slice')
91      return (-4,None, 'Cannot sort slices')
92
93def sortTimeSlice( tsl ):
94 
95  s = set()
96  for ts in tsl:
97    if ts[0] == None:
98      return (1,ts,'Taking unsliced option')
99    s.add( ts[0][1] )
100  if len(s) > 1:
101    return (-1,None,'Multiple slice types')
102  tst = s.pop()
103  if not ( tst == 'simpleRange' or (len(tst) > 13 and tst[:13] == 'branchedYears') ):
104    return (-2,None,'slice type aggregation not supported')
105  if len(tsl) == 2:
106    tsll = list( tsl )
107    sa,ea = tsll[0][0][2:]
108    sb,eb = tsll[1][0][2:]
109    if sa <= sb and ea >= eb:
110      return (1,tsll[0], 'Taking largest slice')
111    if sb <= sa and eb >= ea:
112      return (1,tsll[1], 'Taking largest slice')
113    if ea < sb or eb < sa:
114      return (2,tsll, 'Slices are disjoint')
115    return (-3,None, 'Overlapping slices')
116  else:
117##
118## sort by end year and length .. if longest of last ending is also the first starting, we can sort ...
119##
120    tsll = sorted( list(tsl), key=lambda x: (x[0][3],x[0][3]-x[0][2]) )
121    if min( [x[0][2] for x in tsll] ) == tsll[-1][0][2]:
122        return (1,tsll[-1], 'Taking largest slice')
123    return (-4,None, 'Cannot sort slices')
124
125odsz = {'landUse':(5,'free'), 'tau':7, 'scatratio':15, 'effectRadLi|tau':(28,'query pending'), 'vegtype':(8,'free'), 'sza5':5, 'site':(119,'73 for aquaplanet .. '), 'iceband':(5,'free'), 'dbze':15, 'spectband':(10,'free'), 'misrBands':(7,'query pending'), 'effectRadIc|tau':(28,'query pending')}
126
127python2 = True
128if sys.version_info[0] == 3:
129  python2 = False
130  from functools import reduce
131  try: 
132    from utilP3 import mlog3
133  except:
134    from dreqPy.utilP3 import mlog3
135  mlg = mlog3()
136else:
137  from utilP2 import util
138  mlg = util.mlog()
139
140class c1(object):
141  def __init__(self):
142    self.a = collections.defaultdict( int )
143class c1s(object):
144  def __init__(self):
145    self.a = collections.defaultdict( set )
146
147NT_txtopts = collections.namedtuple( 'txtopts', ['mode'] )
148
149def vfmt(ss):
150  stb = ss*1.e-12
151  if stb < .099:
152    return '%7.2fGb' % (stb*100)
153  else:
154    return '%7.2fTb' % stb
155
156class baseException(Exception):
157  """Basic exception for general use in code."""
158
159  def __init__(self,msg):
160    self.msg = 'scope:: %s' % msg
161
162  def __str__(self):
163    return repr( self.msg )
164
165  def __repr__(self):
166    return self.msg
167
168nt_mcfg = collections.namedtuple( 'mcfg', ['nho','nlo','nha','nla','nlas','nls','nh1'] )
169class cmpd(object):
170  def __init__(self,dct):
171    self.d = dct
172  def cmp(self,x,y,):
173    return cmp( self.d[x], self.d[y] )
174
175
176def filter1( a, b ):
177  if b < 0:
178    return a
179  else:
180    return min( [a,b] )
181
182def filter2( a, b, tt, tm ):
183## largest tier less than or equal to tm
184  ll = [t for t in tt if t <= tm]
185  if len( ll ) > 0:
186    t1 = [t for t in tt if t <= tm][-1]
187    it1 = tt.index(t1)
188    aa = a[it1]
189    if b < 0:
190      return aa
191    else:
192      return min( [aa,b] )
193  else:
194    return 0
195
196npy = {'1hrClimMon':24*12, 'daily':365, u'Annual':1, u'fx':0.01, u'1hr':24*365, u'3hr':8*365,
197       u'monClim':12, u'Timestep':100, u'6hr':4*365, u'day':365, u'1day':365, u'mon':12, u'yr':1,
198       u'1mon':12, 'month':12, 'year':1, 'monthly':12, 'hr':24*365, 'other':24*365,
199        'subhr':24*365, 'Day':365, '6h':4*365, '3 hourly':8*365, '':1, 'dec':0.1 }
200
201## There are 4 cmor variables with blank frequency ....
202
203def vol01( sz, v, npy, freq, inx ):
204  n1 = npy[freq]
205  s = sz[inx.uid[v].stid]
206  assert type(s) == type(1), 'Non-integer size found for %s' % v
207  assert type(n1) in (type(1),type(0.)), 'Non-number "npy" found for %s, [%s]' % (v,freq)
208  return s*n1
209
210class col_list(object):
211  def __init__(self):
212    self.a = collections.defaultdict(list)
213
214class col_count(object):
215  def __init__(self):
216    self.a = collections.defaultdict(int)
217
218class dreqQuery(object):
219  __doc__ = """Methods to analyse the data request, including data volume estimates"""
220  errorLog = collections.defaultdict( set )
221  def __init__(self,dq=None,tierMax=1):
222    if dq == None:
223      self.dq = dreq.loadDreq()
224    else:
225      self.dq=dq
226    self.rlu = {}
227    for i in self.dq.coll['objective'].items:
228      k = '%s.%s' % (i.mip,i.label)
229      ##assert not k in self.rlu, 'Duplicate label in objectives: %s' % k
230      if k in self.rlu:
231        print ( 'SEVERE: Duplicate label in objectives: %s' % k )
232      self.rlu[k] = i.uid
233
234    self.odsz = odsz
235    self.npy = npy
236    self.strSz = dict()
237    self.cmvFilter = cmvFilter( self )
238    self.tierMax = tierMax
239    self.gridPolicyDefaultNative = False
240    self.gridOceanStructured = True
241    self.gridPolicyForce = None
242    self.retainRedundantRank = False
243    self.intersection = False
244    self.gridPolicyTopOnly = True
245    self.exptFilter = None
246    self.exptFilterBlack = None
247    self.uniqueRequest = False
248
249    self.mips = set( [x.label for x in self.dq.coll['mip'].items ] )
250    self.mips = ['CMIP','AerChemMIP', 'C4MIP', 'CFMIP', 'DAMIP', 'DCPP', 'FAFMIP', 'GeoMIP', 'GMMIP', 'HighResMIP', 'ISMIP6', 'LS3MIP', 'LUMIP', 'OMIP', 'PMIP', 'RFMIP', 'ScenarioMIP', 'VolMIP', 'CORDEX', 'DynVar', 'SIMIP', 'VIACSAB']
251    self.mipsp = self.mips[:-4]
252    self.cmvGridId, i4 = fgrid.fgrid( self.dq )
253    assert len(i4) == 0
254
255    self.experiments = set( [x.uid for x in self.dq.coll['experiment'].items ] )
256    self.exptByLabel = {}
257    for x in self.dq.coll['experiment'].items:
258      if x.label in self.exptByLabel:
259        print ( 'ERROR: experiment label duplicated: %s' % x.label )
260      self.exptByLabel[x.label] = x.uid
261    self.mipls = sorted( list( self.mips ) )
262
263    self.default_mcfg = nt_mcfg._make( [259200,60,64800,40,20,5,100] )
264    self.mcfg = self.default_mcfg._asdict()
265    self.mcfgNote = None
266    self.szcfg()
267    self.requestItemExpAll(  )
268
269  def showOpts(self):
270    print ( ( self.tierMax, self.gridPolicyDefaultNative, self.gridOceanStructured, self.gridPolicyForce,
271    self.retainRedundantRank, self.gridPolicyTopOnly, self.exptFilter, self.exptFilterBlack,
272    self.uniqueRequest ))
273
274  def setMcfg(self, ll, msg=None ):
275    assert len(ll) == 7, 'Model config must be of length 7: %s' % str(ll)
276    assert all( [type(x) == type(1) for x in ll] )
277    self.mcfg = nt_mcfg._make( ll )._asdict()
278    if msg == None:
279      self.mcfgNote = 'User supplied model configuration: %s' % str(ll)
280    else:
281      self.mcfgNote = msg
282    self.szcfg()
283
284  def szcfg(self):
285    szr = {'100km':64800, '1deg':64800, '2deg':16200 }
286    self.szss = {}
287    self.sz = {}
288    self.szg = collections.defaultdict( dict )
289    self.szgss = collections.defaultdict( dict )
290    self.isLatLon = {}
291    self.szSrf = collections.defaultdict( dict )
292    self.szssSrf = collections.defaultdict( dict )
293    for i in self.dq.coll['spatialShape'].items:
294      gtype = 'a'
295      if i.levelFlag == False:
296        ds =  i.dimensions.split( '|' )
297        if ds[-1] in ['site', 'basin']:
298          vd = ds[-2]
299        else:
300          vd = ds[-1]
301 
302        if vd[:4] == 'olev' or vd == 'rho':
303          gtype = 'o'
304          nz = self.mcfg['nlo']
305        elif vd[:4] == 'alev':
306          nz = self.mcfg['nla']
307        elif vd in ['slevel']:
308          nz = self.mcfg['nls']
309        elif vd in ['snowdepth','sdepth']:
310          nz = 5
311        elif vd == 'aslevel':
312          nz = self.mcfg['nlas']
313        else:
314          mlg.prnt( 'Failed to parse dimensions %s: %s' % (i.label,i.dimensions) )
315          raise
316      else:
317        nz = i.levels
318
319      dims = set( i.dimensions.split( '|' ) )
320      if 'latitude' in dims and 'longitude' in dims:
321        if gtype == 'o':
322          nh = self.mcfg['nho']
323          self.isLatLon[i.uid] = 'o'
324        else:
325          nh = self.mcfg['nha']
326          self.isLatLon[i.uid] = 'a'
327      else:
328        nh = 10
329        self.isLatLon[i.uid] = False
330
331      self.szss[i.uid] = nh*nz
332      if self.isLatLon[i.uid] != False and len(dims) == 2:
333        self.szssSrf[i.uid] = { 'a':self.mcfg['nha']*nz, 'o':self.mcfg['nho']*nz }
334
335      for k in szr:
336        if self.isLatLon[i.uid] != False:
337          self.szgss[k][i.uid] = szr[k]*nz
338        else:
339          self.szgss[k][i.uid] = nh*nz
340
341    for i in self.dq.coll['structure'].items:
342      s = 1
343      knownAtmos = False
344      if i.__dict__.get('odims','')  != '':
345        if i.odims in odsz:
346           sf = odsz[i.odims]
347        else:
348           ## print 'SEVERE.odims.00001: no information on dimension size: %s' % i.odims
349           sf = 5
350        if type( sf ) == type( () ):
351          sf = sf[0]
352        s = s*sf
353        if i.odims not in ['iceband']:
354          knownAtmos = True
355      if i.spid in self.szss:
356        self.sz[i.uid] = self.szss[i.spid]*s
357
358        if i.uid in self.szssSrf:
359          if knownAtmos:
360            self.sz[i.uid] = self.szssSrf[i.spid]['a']*s
361          else:
362            for k in ['a','o']:
363               self.szSrf[i.uid][k] = self.szssSrf[i.spid][k]*s
364
365        for k in szr:
366          self.szg[k][i.uid] = self.szgss[k][i.spid]*s
367      else:
368        print ('WARNING: spid has no size info: %s [%s]' % (i.spid,i.uid) )
369        self.sz[i.uid] = 0.
370        for k in szr:
371          self.szg[k][i.uid] = 0.
372
373  def getRequestLinkByMip( self, mipSel ):
374    """Return the set of request links which are associated with specified MIP"""
375
376    if type(mipSel) == type( {} ):
377      return self.getRequestLinkByMipObjective(self,mipSel)
378
379    if type(mipSel) == type(''):
380      t1 = lambda x: x == mipSel
381    elif type(mipSel) == type(set()):
382      t1 = lambda x: x in mipSel
383
384    s = set()
385    for i in self.dq.coll['requestLink'].items:
386      if t1(i.mip):
387        if 'requestItem' in self.dq.inx.iref_by_sect[i.uid].a:
388          if any( [ self.rqiExp[x][3] > 0 for  x in self.dq.inx.iref_by_sect[i.uid].a['requestItem'] if x in self.rqiExp ] ):
389            s.add( i )
390
391    self.rqs = list( s )
392    return self.rqs
393
394  def getRequestLinkByMipObjective( self, mipSel ):
395    """Return the set of request links which are associated with specified MIP and its objectives"""
396
397    assert type(mipSel) == type( {} ),'Argument must be a dictionary, listing objectives for each MIP'
398
399    s = set()
400    for i in self.dq.coll['requestLink'].items:
401      if i.mip in mipSel:
402        if len(mipSel[i.mip]) == 0:
403          s.add( i )
404        elif 'objectiveLink' in self.dq.inx.iref_by_sect[i.uid].a:
405          ss = set( [self.dq.inx.uid[k].label for k in self.dq.inx.iref_by_sect[i.uid].a['objectiveLink'] ] )
406          if any( [x in mipSel[i.mip] for x in ss] ):
407            s.add( i )
408##
409## filter requestLinks by tierMax: check to see whether they link to experiments with tier below or equal to tiermax.
410##
411    s1 = set()
412    for i in s:
413      if 'requestItem' in self.dq.inx.iref_by_sect[i.uid].a:
414        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 ] ):
415            s1.add( i )
416
417    self.rqs = list( s1 )
418    return self.rqs
419
420  def varGroupXexpt(self, rqList ):
421    """For a list of request links, return a list of variable group IDs for each experiment"""
422    self.cc = collections.defaultdict( list )
423    ## 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} }
424    return self.cc
425
426  def yearsInRequest(self, rql ):
427    self.ntot = sum( [i.ny for i in self.dq.coll['requestItem'].items if i.rlid == rql.uid] )
428    return self.ntot
429
430  def rqlByExpt( self, l1, ex, pmax=2, expFullEx=False ):
431    """rqlByExpt: return a set of request links for an experiment"""
432##
433    inx = self.dq.inx
434
435    if ex != None:
436   
437      exi = self.dq.inx.uid[ex]
438      if exi._h.label == 'experiment':
439        exset = set( [ex,exi.egid,exi.mip] )
440      else:
441        exset = set( self.esid_to_exptList(ex,deref=False,full=expFullEx) )
442##
443## rql is the set of all request links which are associated with a request item for this experiment set
444##
445   
446      l1p = set()
447      for i in l1:
448        if i.preset < 0 or i.preset <= pmax:
449          if i.esid in exset:
450            l1p.add(i)
451    else:
452      exset = None
453      l1p = l1
454
455    rql0 = set()
456    for i in l1p:
457       rql0.add(i.rlid)
458
459    rqlInv = set()
460    for u in rql0:
461      if inx.uid[u]._h.label == 'remarks':
462        rqlInv.add( u )
463    if len(rqlInv) != 0:
464      mlg.prnt ( 'WARNING.001.00002: %s invalid request links from request items ...' % len(rqlInv) )
465    rql = set()
466    for u in rql0:
467       if inx.uid[u]._h.label != 'remarks':
468         rql.add( u ) 
469
470    return rql, l1p, exset
471
472  def varsByRql( self, rql, pmax=2, intersection=False, asDict=False): 
473      """The complete set of variables associated with a set of request links."""
474      inx = self.dq.inx
475      cc1 = collections.defaultdict( set )
476      for i in rql:
477        o = inx.uid[i]
478        if o.opt == 'priority':
479          p = int( float( o.opar ) )
480          assert p in [1,2,3], 'Priority incorrectly set .. %s, %s, %s' % (o.label,o.title, o.uid)
481          cc1[inx.uid[i].mip].add( (inx.uid[i].refid,p) )
482        else:
483          cc1[inx.uid[i].mip].add( inx.uid[i].refid )
484
485      if intersection:
486        ccv = {}
487#
488# set of request variables for each MIP
489#
490        for k in cc1:
491          thisc = reduce( operator.or_, [set( inx.iref_by_sect[vg].a['requestVar'] ) for vg in cc1[k] ] )
492          rqvgs = collections.defaultdict( set )
493          for x in cc1[k]:
494            if type(x) == type( () ):
495              rqvgs[x[0]].add( x[1] )
496            else:
497              rqvgs[x].add( 3 )
498         
499          s = set()
500          for vg in rqvgs:
501            for l in inx.iref_by_sect[vg].a['requestVar']:
502              if inx.uid[l].priority <= min(pmax,max(rqvgs[vg])):
503                s.add( inx.uid[l].vid )
504          ccv[k] = s
505
506        if len( ccv.keys() ) < len( list(imips) ):
507          vars = set()
508        else:
509          vars =  reduce( operator.and_, [ccv[k] for k in ccv] )
510      else:
511        rqvgs = collections.defaultdict( set )
512        for k in cc1:
513          for x in cc1[k]:
514            if type(x) == type( () ):
515              rqvgs[x[0]].add( x[1] )
516            else:
517              rqvgs[x].add( 3 )
518         
519###To obtain a set of variables associated with this collection of variable groups:
520
521        if asDict:
522          vars = collections.defaultdict( list )
523        else:
524          vars = set()
525        for vg in rqvgs:
526          for l in inx.iref_by_sect[vg].a['requestVar']:
527            if inx.uid[l].priority <= min(pmax,max(rqvgs[vg])):
528               if asDict:
529                 vars[inx.uid[l].vid].append( vg )
530               else:
531                 vars.add(inx.uid[l].vid)
532
533        ##col1 = reduce( operator.or_, [set( inx.iref_by_sect[vg].a['requestVar'] ) for vg in rqvg ] )
534### filter out cases where the request does not point to a CMOR variable.
535    ##vars = {vid for vid in vars if inx.uid[vid][0] == u'CMORvar'}
536
537      if asDict:
538        thisvars = {}
539        for vid in vars:
540           if inx.uid[vid]._h.label == u'CMORvar':
541             thisvars[vid] = vars[vid]
542      else:
543        thisvars = set()
544        for vid in vars:
545           if inx.uid[vid]._h.label == u'CMORvar':
546             thisvars.add(vid)
547
548      return thisvars
549
550  def exptYears( self, rqll, ex=None, exBlack=None):
551    """Parse a set of request links, and get years requested for each (varGroup, expt, grid) tuple """
552     
553    self.tsliceDict = collections.defaultdict( dict )
554    ccts = collections.defaultdict( dict )
555    ccts2 = collections.defaultdict( set )
556    cc = collections.defaultdict( set )
557    for rl in rqll:
558      if 'requestItem' not in self.dq.inx.iref_by_sect[rl.uid].a:
559        self.errorLog['WARN.001.00001'].add( 'no request items for: %s, %s' % (rl.uid, rl.title) )
560        ##print ( 'WARN.001.00001: no request items for: %s, %s' % (rl.uid, rl.title) )
561      else:
562
563        ##print rl.uid, rl.title, rl.grid, rl.gridreq
564        if self.gridPolicyForce != None:
565          grd = self.gridPolicyForce
566        elif rl.grid in ['1deg','2deg','100km']:
567          if rl.grid == '100km':
568            grd = '1deg'
569          else:
570            grd = rl.grid
571        else:
572          ## note that naming of "gridreq" is unfortunate ... "No" means that native grid is required
573          if rl.gridreq in ['No', 'no']:
574             #or self.gridPolicyDefaultNative:
575            grd = 'native'
576          elif rl.gridreq in ['no*1']:
577             #or self.gridPolicyDefaultNative:
578            grd = 'native:01'
579          else:
580            ##print ( 'INFO.grd.00001: defaulting to grid ..%s, %s, %s' % (rl.label,rl.title, rl.uid) )
581            grd = 'DEF'
582
583        for iu in self.dq.inx.iref_by_sect[rl.uid].a['requestItem']:
584          i = self.dq.inx.uid[iu]
585
586##
587## apply "treset" filter to request items linked to this group.
588##
589          if self.tierMax < 0 or 'treset' not in i.__dict__ or i.treset <= self.tierMax:
590            if iu in self.rqiExp:
591              for e in self.rqiExp[iu][1]:
592                if (ex == None or e in ex) and (exBlack == None or e not in exBlack):
593                  this = self.rqiExp[iu][1][e]
594                  if this != None:
595                    thisns = this[-3]
596                    thisny = this[-2]
597                    thisne = this[-1]
598                    ##cc[ (rl.refid,e,grd) ].add( filter1( thisns*thisny*thisne, i.nymax) )
599                    cc[ (rl.refid,e,grd) ].add( thisns*thisny*thisne )
600                    if self.rqiExp[iu][4] != None:
601                      ccts[(rl.refid,e)][thisns*thisny*thisne] = self.rqiExp[iu][4]
602                      ccts2[(rl.refid,e)].add( self.rqiExp[iu][4] )
603
604    ee = collections.defaultdict( dict )
605
606    revertToLast = True
607    ey = exYr()
608    if revertToLast:
609      for g,e,grd in cc:
610        ee[g][(e,grd)] = max( cc[( g,e,grd) ] )
611        ##if (g,e) in ccts and ee[g][(e,grd)] in ccts[(g,e)]:
612#
613# possible corner cut here ... as max length may not include all years where there is a non-overlap ...
614#
615           ##self.tsliceDict[g][e] = ccts[(g,e)][ ee[g][(e,grd)] ]
616## change to a set of slices
617        self.tsliceDict[g][e] = ccts2[(g,e)]
618      ey.exptYears = ee
619      return ey
620    ff = collections.defaultdict( dict )
621##
622## this needs to be done separately for ocean and atmosphere, because of the default logic workflow ...
623    for g,e,grd in cc:
624      ee[(g,e)][grd] = max( cc[( g,e,grd) ] )
625
626    xx = collections.defaultdict( dict )
627    for g,e in ee:
628      ddef = ee[(g,e)].get( 'DEF', 0 )
629      for grd in ee[(g,e)]:
630        if grd != 'DEF':
631          xx[(g,'a')][(e, grd)] = ee[(g,e)][grd]
632          xx[(g,'o')][(e, grd)] = ee[(g,e)][grd]
633          xx[(g,'')][(e, grd)] = ee[(g,e)][grd]
634        if grd == 'native' and ddef != 0:
635          xx[(g,'a')][(e, 'native')] = max( [xx[(g,'a')][(e, 'native')],ddef] )
636          xx[(g,'')][(e, 'native')] = max( [xx[(g,'')][(e, 'native')],ddef] )
637        if grd == '1deg' and ddef != 0:
638          xx[(g,'o')][(e, '1deg')] = max( [xx[(g,'o')][(e, '1deg')],ddef] )
639
640    for grp,flg in xx:
641      ff[grp][flg] = xx[(grp,flg)]
642         
643    ## return dict[<variable group>]{dict[<experiment><grid>]{<years>}}
644    ## return dict[<variable group>][grid flag]{dict[<experiment>,<grid>]{<years>}}
645    return ff
646
647  def volByExpt( self, l1, ex, pmax=1, cc=None, intersection=False,expFullEx=False, adsCount=False ):
648    """volByExpt: calculates the total data volume associated with an experiment/experiment group and a list of request items.
649          The calculation has some approximations concerning the number of years in each experiment group.
650          cc: an optional collector, to accumulate indexed volumes. """
651##
652    inx = self.dq.inx
653    imips = set()
654    for i in l1:
655      imips.add(i.mip)
656   
657    rql, l1p, exset = self.rqlByExpt( l1, ex, pmax=pmax, expFullEx=expFullEx )
658    verbose = False
659    if verbose:
660      for i in rql:
661        r = inx.uid[i]
662        print ( '%s, %s, %s' % (r.label, r.title, r.uid) )
663
664    if ex != None:
665     
666      exi = self.dq.inx.uid[ex]
667      if exi._h.label == 'experiment':
668        exset = set( [ex,exi.egid,exi.mip] )
669#####
670    if len( rql ) == 0:
671      self.vars = set()
672      return (0,{},{} )
673
674## The complete set of variables associated with these requests:
675    vars = self.varsByRql( rql, pmax=pmax, intersection=intersection, asDict=True) 
676##
677## filter by configuration option and rank
678##
679    if not self.retainRedundantRank:
680      len1 = len(vars.keys())
681      cmv = self.cmvFilter.filterByChoiceRank(cmv=vars.keys())
682      vars = cmv
683   
684    self.vars = vars
685
686    e = {}
687    for u in rql:
688### for request variables which reference the variable group attached to the link, add the associate CMOR variables, subject to priority
689      i = inx.uid[u]
690      e[i.uid] = set()
691      si = collections.defaultdict( list )
692      for x in inx.iref_by_sect[i.refid].a['requestVar']:
693           if inx.uid[x].priority <= pmax:
694              e[i.uid].add( inx.uid[x].vid )
695
696              if verbose:
697                cmv = inx.uid[inx.uid[x].vid]
698                if cmv._h.label == 'CMORvar':
699                  si[ cmv.mipTable ].append( inx.uid[x].label )
700#
701# for each variable, calculate the maximum number of years across all the request links which reference that variable.
702##
703## for each request item we have nymax, nenmax, nexmax.
704##
705    nymg = collections.defaultdict( dict )
706##
707## if dataset count rather than volume is wanted, use item 3 from rqiExp tuple.
708    if adsCount:
709      irqi = 3
710    else:
711      irqi = 2
712
713    sgg = set()
714    for v in vars:
715      s = set()
716      sg = collections.defaultdict( set )
717      cc2 = collections.defaultdict( set )
718      cc2s = collections.defaultdict( c1s )
719      for i in l1p:
720##################
721        if (exset == None or i.esid in exset) and v in e[i.rlid]:
722          ix = inx.uid[i.esid]
723          rl = inx.uid[i.rlid]
724          sgg.add( rl.grid )
725          if rl.grid in ['100km','1deg','2deg']:
726            grd = rl.grid
727          else:
728            grd = 'native'
729
730          this = None
731          if exset == None:
732            thisz = 100
733##
734## for a single experiment, look up n years, and n ensemble.
735## should have nstart????
736##
737          elif exi._h.label == 'experiment' or ix._h.label == 'experiment':
738            this = None
739            if ex in self.rqiExp[i.uid][1]:
740              this = self.rqiExp[i.uid][1][ex]
741            elif ix.uid in self.rqiExp[i.uid][1]:
742              this = self.rqiExp[i.uid][1][ix.uid]
743            if this != None:
744              thisns = this[-3]
745              thisny = this[-2]
746              thisne = this[-1]
747              cc2s[grd].a[u].add( filter1( thisns*thisny*thisne, i.nymax) )
748          else:
749            thisz = None
750            if 'experiment' in inx.iref_by_sect[i.esid].a:
751              for u in inx.iref_by_sect[i.esid].a['experiment']:
752                if u in self.rqiExp[i.uid][1]:
753                  this = self.rqiExp[i.uid][1][u]
754                  thisns = this[-3]
755                  thisny = this[-2]
756                  thisne = this[-1]
757##
758###   aggregate year count for each experiment and output grid
759## clarify definition and usage of nymax -- should be redundant ... could be replaced by inward references from "timeSlice"
760                  cc2s[grd].a[u].add( filter1( thisns*thisny*thisne, i.nymax) )
761
762          if exset != None:
763            sg[grd].add( self.rqiExp[i.uid][irqi] )
764     
765###
766### sum over experiments of maximum within each experiment
767###
768      for g in sg:
769        nymg[v][g] = sum( [max( cc2s[g].a[k] ) for k in cc2s[g].a] )
770
771    szv = {}
772    ov = []
773    for v in vars:
774      if 'requestVar' not in inx.iref_by_sect[v].a:
775         print ( 'Variable with no request ....: %s, %s' % (inx.uid[v].label, inx.uid[v].mipTable) )
776      try:
777        szv[v] = self.sz[inx.uid[v].stid]*npy[inx.uid[v].frequency]
778      except:
779        if inx.uid[v].stid not in self.sz:
780          print ('ERROR: size not found for stid %s (v=%s, %s)' % (inx.uid[v].stid,v,inx.uid[v].label) )
781        if inx.uid[v].frequency not in npy:
782          print ('ERROR: npy not found for frequency %s (v=%s, %s)' % (inx.uid[v].frequency,v,inx.uid[v].label) )
783        szv[v] = 0
784      ov.append( self.dq.inx.uid[v] )
785
786    ff = {}
787    for v in vars:
788      if adsCount:
789        ff[v] = 1
790      else:
791        if 'native' in nymg[v]:
792          ff[v] = szv[v]
793          ny = nymg[v]['native']
794        else:
795          ks0 = nymg[v].keys()
796          if len(ks0) == 0:
797            ff[v] = 0.
798            ny = 0.
799          else:
800            ks = gridSorter.sort( nymg[v].keys() )[0]
801            ##ks = list( nymg[v].keys() )[0]
802            ny = nymg[v][ks]
803            if inx.uid[v].stid in self.szg[ks]:
804              ff[v] = self.szg[ks][ inx.uid[v].stid ] * npy[inx.uid[v].frequency]
805            else:
806              ff[v] = 0.
807
808        if inx.uid[v].frequency != 'monClim':
809          ff[v] = ff[v]*ny
810
811    ee = self.listIndexDual( ov, 'mipTable', 'label', acount=None, alist=None, cdict=ff, cc=cc )
812    self.ngptot = sum( [  ff[v]  for v in vars] )
813    return (self.ngptot, ee, ff )
814
815  def esid_to_exptList(self,esid,deref=False,full=False):
816    if not esid in self.dq.inx.uid:
817      mlg.prnt ( 'Attempt to dereferece invalid uid: %s' % esid )
818      raise
819
820    if self.dq.inx.uid[esid]._h.label == 'experiment':
821      expts = [esid,]
822    elif self.dq.inx.uid[esid]._h.label != 'remarks':
823      if esid in self.dq.inx.iref_by_sect and 'experiment' in self.dq.inx.iref_by_sect[esid].a:
824        expts = list( self.dq.inx.iref_by_sect[esid].a['experiment'][:] )
825      else:
826        expts = []
827
828## add in groups and mips for completeness
829##
830      if full:
831        if self.dq.inx.uid[esid]._h.label == 'mip':
832          s = set()
833          for e in expts:
834            if self.dq.inx.uid[e]._h.label != 'experiment':
835              mlg.prnt ( 'ERROR: %s, %s, %s ' % (esid,e, self.dq.inx.uid[e].title ) )
836            s.add( self.dq.inx.uid[e].egid )
837          for i in s:
838            expts.append( i )
839        expts.append( esid )
840    else:
841      return None
842
843    if self.tierMax > 0:
844      expts1 = []
845      for i in expts:
846        if self.dq.inx.uid[i]._h.label == 'experiment':
847          if self.dq.inx.uid[i].tier[0] <= self.tierMax:
848            expts1.append( i )
849        elif self.dq.inx.uid[i]._h.label == 'exptgroup':
850          if self.dq.inx.uid[i].tierMin <= self.tierMax:
851            expts1.append( i )
852        else:
853            expts1.append( i )
854    else:
855      expts1 = expts
856
857    if deref:
858      return [self.dq.inx.uid[e] for e in expts1]
859    else:
860      return expts1
861##
862## need to call this on load
863## then use instead of i.ny etc below
864##
865  def requestItemExpAll( self ):
866    self.rqiExp = {}
867    for rqi in self.dq.coll['requestItem'].items:
868      a,b,c,d,e = self.requestItemExp( rqi )
869      if a != None:
870        self.rqiExp[rqi.uid] = (a,b,c,d,e)
871
872  def requestItemExp( self, rqi ):
873    assert rqi._h.label == "requestItem", 'Argument to requestItemExp must be a requestItem'
874    tsl = None
875    if 'tslice' in rqi.__dict__:
876      ts = self.dq.inx.uid[ rqi.tslice ]
877      if ts._h.label == 'timeSlice':
878        if ts.type == 'simpleRange':
879          tsl = (ts.label,'simpleRange', ts.start,ts.end)
880        elif ts.type == 'branchedYears':
881          tsl = (ts.label,'%s:%s' % (ts.type,ts.child), ts.start,ts.end)
882        else:
883          tsl = (ts.label, ts.type, None, None )
884
885     
886    u = rqi.esid
887    if self.dq.inx.uid[u]._h.label == 'experiment':
888      expts = [u,]
889    elif self.dq.inx.uid[u]._h.label != 'remarks':
890      if u in self.dq.inx.iref_by_sect and 'experiment' in self.dq.inx.iref_by_sect[u].a:
891        expts = self.dq.inx.iref_by_sect[u].a['experiment']
892      else:
893        expts = []
894    else:
895      return (None, None, None, None,None)
896
897    if self.tierMax > 0:
898      expts = [i for i in expts if self.dq.inx.uid[i].tier[0] <= self.tierMax]
899
900    self.multiTierOnly = False
901    if self.multiTierOnly:
902      expts = [i for i in expts if len(self.dq.inx.uid[i].tier) > 1]
903      print ('Len expts: %s' % len(expts) )
904
905    if len(expts) > 0:
906      e = [self.dq.inx.uid[i] for i in expts]
907      for i in e:
908        if i._h.label != 'experiment':
909          mlg.prnt ( 'ERROR: %s, %s, %s ' % ( u,i._h.label, i.label, i.title ) )
910      dat2 = {}
911      for i in e:
912        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) )
913
914      nytot = sum( [dat2[x][-2]*dat2[x][-3] for x in dat2 ] )
915      netot = sum( [dat2[x][-1] for x in dat2 ] )
916    else:
917      dat2 = {}
918      nytot = 0
919      netot = 0
920   
921##
922## to get list of years per expt for each requestLink ... expts is union of all dat2 keys,
923## and want max of dat2[x][0] for each experiment x.
924##
925    return (expts, dat2, nytot, netot, tsl )
926
927  def setTierMax( self, tierMax ):
928    """Set the maxium tier and recompute request sizes"""
929    if tierMax != self.tierMax:
930      self.tierMax = tierMax
931      self.requestItemExpAll(  )
932
933  def summaryByMip( self, pmax=1 ):
934    bytesPerFloat = 2.
935    for m in self.mipls:
936      v = self.volByMip( m, pmax=pmax )
937      mlg.prnt ( '%12.12s: %6.2fTb' % (m,v*bytesPerFloat*1.e-12) )
938
939  def rqlByMip( self, mip):
940    if mip == 'TOTAL':
941        mip = self.mips
942
943    if type(mip) in [type( '' ),type( u'') ]:
944      if mip not in self.mips:
945        mlg.prnt ( self.mips )
946        raise baseException( 'rqiByMip: Name of mip not recognised: %s' % mip )
947      l1 = [i for i in  self.dq.coll['requestLink'].items if i.mip == mip]
948    elif type(mip) in [ type( set()), type( [] ) ]:
949      nf = [ m for m in mip if m not in self.mips]
950      if len(nf) > 0:
951          raise baseException( 'rqlByMip: Name of mip(s) not recognised: %s' % str(nf) )
952      l1 = [i for i in  self.dq.coll['requestLink'].items if i.mip in mip]
953    elif type(mip) == type( dict()):
954      nf = [ m for m in mip if m not in self.mips]
955      if len(nf) > 0:
956        raise baseException( 'rqlByMip: Name of mip(s) not recognised: %s' % str(nf) )
957      l1 = []
958      for i in  self.dq.coll['requestLink'].items:
959        if i.mip in mip:
960          ok = False
961          if len( mip[i.mip] ) == 0:
962            ok = True
963          else:
964            for ol in self.dq.inx.iref_by_sect[i.uid].a['objectiveLink']:
965              o = self.dq.inx.uid[ol]
966              if self.dq.inx.uid[o.oid].label in mip[i.mip]:
967                ok = True
968          if ok:
969              l1.append( i )
970    else:
971      raise baseException( 'rqiByMip: "mip" (1st explicit argument) should be type string or set: %s -- %s' % (mip, type(mip))   )
972
973    return l1
974
975  def rqiByMip( self, mip):
976    l1 = self.rqlByMip( mip )
977    if len(l1) == 0:
978       return []
979    l2 = [] 
980    for i in l1:
981       if 'requestItem' in self.dq.inx.iref_by_sect[i.uid].a:
982          for u in self.dq.inx.iref_by_sect[i.uid].a['requestItem']:
983               l2.append( self.dq.inx.uid[u] )
984
985    l20 = self.rqiByMip0( mip )
986    for i in l20:
987      assert i in l2
988    return l2
989   
990   
991  def rqiByMip0( self, mip):
992
993    if mip == 'TOTAL':
994        mip = self.mips
995    if type(mip) in [type( '' ),type( u'') ]:
996      if mip not in self.mips:
997        mlg.prnt ( self.mips )
998        raise baseException( 'rqiByMip: Name of mip not recognised: %s' % mip )
999      l1 = [i for i in  self.dq.coll['requestItem'].items if i.mip == mip]
1000    elif type(mip) in [ type( set()), type( [] ) ]:
1001      nf = [ m for m in mip if m not in self.mips]
1002      if len(nf) > 0:
1003          raise baseException( 'rqiByMip: Name of mip(s) not recognised: %s' % str(nf) )
1004      l1 = [i for i in  self.dq.coll['requestItem'].items if i.mip in mip]
1005    elif type(mip) == type( dict()):
1006      nf = [ m for m in mip if m not in self.mips]
1007      if len(nf) > 0:
1008        raise baseException( 'rqiByMip: Name of mip(s) not recognised: %s' % str(nf) )
1009      l1 = []
1010      for i in  self.dq.coll['requestLink'].items:
1011        if i.mip in mip:
1012          ok = False
1013          if len( mip[i.mip] ) == 0:
1014            ok = True
1015          else:
1016            for ol in self.dq.inx.iref_by_sect[i.uid].a['objectiveLink']:
1017              o = self.dq.inx.uid[ol]
1018              if self.dq.inx.uid[o.oid].label in mip[i.mip]:
1019                ok = True
1020          if ok:
1021              if 'requestItem' in self.dq.inx.iref_by_sect[i.uid].a:
1022                for u in self.dq.inx.iref_by_sect[i.uid].a['requestItem']:
1023                  l1.append( self.dq.inx.uid[u] )
1024    else:
1025      raise baseException( 'rqiByMip: "mip" (1st explicit argument) should be type string or set: %s -- %s' % (mip, type(mip))   )
1026
1027    return l1
1028
1029  def checkDir(self,odir,msg):
1030      if not os.path.isdir( odir ):
1031         try:
1032            os.mkdir( odir )
1033         except:
1034            print ('\n\nFailed to make directory "%s" for: %s: make necessary subdirectories or run where you have write access' % (odir,msg) )
1035            print ( '\n\n' )
1036            raise
1037         print ('Created directory %s for: %s' % (odir,msg) )
1038
1039  def xlsByMipExpt(self,m,ex,pmax,odir='xls',xls=True,txt=False,txtOpts=None):
1040    import scope_utils
1041    mxls = scope_utils.xlsTabs(self,tiermax=self.tierMax,pmax=pmax,xls=xls, txt=txt, txtOpts=txtOpts,odir=odir)
1042    mlab = misc_utils.setMlab( m )
1043    mxls.run( m, mlab=mlab )
1044
1045  def cmvByInvMip( self, mip,pmax=1,includeYears=False, exptFilter=None,exptFilterBlack=None ):
1046    mips = set( self.mips[:] )
1047    if type(mip) == type( '' ):
1048        mips.discard( mip )
1049    else:
1050      for m in mip:
1051        mips.discard( m )
1052
1053    return self.cmvByMip( mips,pmax=pmax,includeYears=includeYears, exptFilter=exptFilter, exptFilterBlack=exptFilterBlack )
1054
1055  def cmvByMip( self, mip,pmax=1,includeYears=False, exptFilter=None, exptFilterBlack=None ):
1056    if exptFilter != None:
1057      assert type(exptFilter) == type( set() ), 'Argument exptFilter must be None or a set: %s' % str(exptFilter)
1058    if exptFilterBlack != None:
1059      assert type(exptFilterBlack) == type( set() ), 'Argument exptFilterBlack must be None or a set: %s' % str(exptFilterBlack)
1060      if exptFilter != None:
1061        assert len( exptFilter.difference( exptFilterBlack ) ) > 0, 'If exptFilter and exptFilterBlack are both set, exptFilter must have non-black listed elements' 
1062
1063    l1,ee = self.rvgByMip( mip, includePreset=True, returnLinks=True )
1064    if includeYears:
1065      expys = self.exptYears( l1, ex=exptFilter, exBlack=exptFilterBlack )
1066      cc = collections.defaultdict( set )
1067      ccts = collections.defaultdict( set )
1068
1069    mipsByVar = collections.defaultdict( set )
1070    ss = set()
1071    for pr in ee:
1072### loop over request  var groups.
1073      for i in ee[pr]:
1074        if 'requestVar' in self.dq.inx.iref_by_sect[i.uid].a:
1075#
1076# loop over request vars in group
1077#
1078          for x in self.dq.inx.iref_by_sect[i.uid].a['requestVar']:
1079            i1 = self.dq.inx.uid[x]
1080
1081            thisp = i1.priority
1082            if pr != -1:
1083              thisp = pr
1084             
1085            if thisp <= pmax:
1086              if includeYears and i1.vid in self.cmvGridId:
1087                ##assert i.uid in expys, 'No experiment info found for requestVarGroup: %s' % i.uid
1088                ## may have no entry as a consequence of tierMin being set in the requestLink(s).
1089                assert i1.vid in self.cmvGridId, 'No grid identification lookup found for %s: %s' % (i1.label,i1.vid)
1090                assert self.cmvGridId[i1.vid] in ['a','o','si','li'], 'Unexpected grid id: %s: %s:: %s' % (i1.label,i1.vid, self.cmvGridId[i1.vid])
1091                gflg = {'si':'','li':''}.get( self.cmvGridId[i1.vid], self.cmvGridId[i1.vid] )
1092                rtl = True
1093
1094                if i.uid in expys.exptYears:
1095                  mipsByVar[i1.vid].add( i.mip )
1096                  if rtl:
1097                    for e,grd in expys.exptYears[i.uid]:
1098                        if exptFilter == None or e in exptFilter:
1099                          if grd == 'DEF':
1100                            if gflg == 'o' and not self.gridPolicyDefaultNative:
1101                            ##if gflg == 'o':
1102                              grd1 = '1deg'
1103                            else:
1104                              grd1 = 'native'
1105                          else:
1106                            grd1 = grd
1107                          cc[(i1.vid,e,grd1)].add( expys.exptYears[i.uid][e,grd] )
1108                          if i.uid in self.tsliceDict and e in self.tsliceDict[i.uid]:
1109                            for thisSlice in self.tsliceDict[i.uid][e]:
1110                              ccts[(i1.vid,e)].add( (thisSlice,thisp) )
1111                          else:
1112                            ccts[(i1.vid,e)].add( (None,thisp) )
1113
1114                  else:
1115
1116                   for gf in expys.exptYears[i.uid]:
1117                    for e,grd in expys.exptYears[i.uid][gf]:
1118                      if grd in ["1deg",'2deg'] or gf == gflg:
1119                        if exptFilter == None or e in exptFilter:
1120                          cc[(i1.vid,e,grd)].add( expys.exptYears[i.uid][gf][e,grd] )
1121              else:
1122                print ( 'SKIPPING %s: %s' % (i1.label,i1.vid) )
1123                ss.add( i1.vid )
1124
1125    if self.intersection and type(mip) == type( set() ) and len(mip) > 1:
1126      sint = set( [k for k in mipsByVar if len( mipsByVar[k] ) == len(mip)] )
1127      print ( 'INTERSECTION: %s out of %s variables [%s]' % (len(sint),len(mipsByVar.keys()),str(mip)) )
1128      xxx = [t for t in cc if t[0] not in sint]
1129      for t in xxx:
1130          del cc[t]
1131    if includeYears:
1132      l2 = collections.defaultdict( dict )
1133      l2x = collections.defaultdict( dict )
1134##
1135## this removes lower ranked grids .... but for some groups want different grids for different variable categories
1136##
1137      if self.gridPolicyTopOnly:
1138        for v,e,g in cc:
1139          l2x[(v,e)][g] = max( list( cc[(v,e,g)] ) )
1140        for v,e in l2x:
1141          if len( l2x[(v,e)].keys() ) == 1:
1142             g,val = list( l2x[(v,e)].items() )[0]
1143          else:
1144            kk = gridSorter.sort( l2x[(v,e)].keys() )
1145            gflg = {'si':'','li':''}.get( self.cmvGridId[v], self.cmvGridId[v] )
1146            g = kk[0]
1147            if g not in l2x[(v,e)]:
1148              print ( '%s not found in %s (%s):' % (g,str(l2x[(v,e)].keys()),str(kk)) )
1149            val = l2x[(v,e)][g]
1150               
1151          l2[v][(e,g)] = val
1152      else:
1153        for v,e,g in cc:
1154          l2[v][(e,g)] = max( list( cc[(v,e,g)] ) )
1155
1156      l2ts = collections.defaultdict( dict )
1157      for v in l2:
1158        for e,g in l2[v]:
1159          if (v,e) in ccts:
1160            ccx = collections.defaultdict( set )
1161            for x in ccts[(v,e)]:
1162              ccx[x[0]].add( x[1] )
1163            if len( ccx.keys() ) > 1:
1164              tslp = [ (k,min(ccx[k])) for k in ccx ]
1165              thisTimeSlice = timeSlice( tslp )
1166              rc, ts, msg = thisTimeSlice.sort()
1167              ##rc, ts, msg = sortTimeSlice( tslp )
1168              if rc == 1:
1169                l2ts[v][e] = tuple( list(ts) + [g,] )
1170              elif rc == 2:
1171                try:
1172##(('abrupt5', 'simpleRange', 0, 5), 1), (('abrupt30', 'simpleRange', 121, 150), 1)]
1173                  yl = list( range( ts[0][0][2], ts[0][0][3] + 1) ) + list( range( ts[1][0][2], ts[1][0][3] + 1) )
1174                except:
1175                  print ( 'FAILED TO GENERATE YEARLIST' )
1176                  print ( str((v,e) ) )
1177                  print ( 'range( ts[0][0][2], ts[0][0][3] + 1) + range( ts[1][0][2], ts[1][0][3] + 1)' )
1178                  print ( str(ts) )
1179                  raise
1180### tslab,tsmode,a,b,priority,grid
1181                l2ts[v][e] = ('_union', 'YEARLIST', len(yl), str(yl), ts[1], g )
1182              else:
1183                print ('TIME SLICE MULTIPLE OPTIONS FOR : %s, %s, %s, %s' % (v,e,str(ccts[(v,e)]), msg ) )
1184            else:
1185              a = ccx.keys()[0]
1186              b = min( [x[1] for x in ccts[(v,e)] ] )
1187              if type(a) == type( [] ):
1188                l2ts[v][e] = a + [b,g,]
1189              elif type(a) == type( () ):
1190                l2ts[v][e] = list(a) + [b,g,]
1191              elif a == None:
1192                l2ts[v][e] = [None,b,g]
1193              else:
1194                assert False, 'Bad type for ccts record: %s' % type( a)
1195      return l2, l2ts
1196    else:
1197      l2 = sorted( [i for i in [self.dq.inx.uid[i] for i in ss] if i._h.label != 'remarks'], key=lambda x: x.label )
1198      return l2
1199
1200  def exptFilterList(self,val,option,ret='uid'):
1201    if type( val ) not in [[],()]:
1202      val = [val,]
1203
1204    if option == 'lab':
1205      v0 = val[:]
1206      val = []
1207      mm = []
1208      for v in v0:
1209        if v not in self.exptByLabel:
1210          mm.append( v )
1211        else:
1212          val.append( self.exptByLabel[v] )
1213
1214      assert len(mm) == 0, 'Experiment names not all recognised: %s' % str(mm)
1215
1216    oo = set()
1217    for v in val:
1218      i = self.dq.inx.uid[v]
1219      if i._h.label in ['exptgroup','mip']:
1220        if 'experiment' in self.dq.inx.iref_by_sect[i.uid].a:
1221          for u in self.dq.inx.iref_by_sect[i.uid].a['experiment']:
1222            oo.add( u )
1223      elif i._h.label == 'experiment':
1224            oo.add( i.uid )
1225      else:
1226        print ('WARNING .. skipping request for experiment which links to record of type %s' % i._h.label )
1227    return oo
1228   
1229  def getFreqStrSummary(self,mip,pmax=1):
1230##
1231## get a dictionary keyed on CMORvar uid, containing dictionary keyed on (experiment, grid) with value as number of years.
1232##
1233    if not self.uniqueRequest:
1234      cmv, self.cmvts = self.cmvByMip(mip,pmax=pmax,includeYears=True,exptFilter=self.exptFilter,exptFilterBlack=self.exptFilterBlack)
1235    else:
1236      cmv1, cmvts1 = self.cmvByInvMip(mip,pmax=pmax,includeYears=True,exptFilter=self.exptFilter,exptFilterBlack=self.exptFilterBlack)
1237      cmv2, cmvts2 = self.cmvByMip('TOTAL',pmax=pmax,includeYears=True,exptFilter=self.exptFilter,exptFilterBlack=self.exptFilterBlack)
1238      cmv = self.differenceSelectedCmvDict(  cmv1, cmv2 )
1239
1240    if not self.retainRedundantRank:
1241      len1 = len(cmv)
1242      self.cmvFilter.filterByChoiceRank(cmv=cmv,asDict=True)
1243      len2 = len(cmv)
1244      ##print 'INFO.redundant.0001: length %s --> %s' % (len1,len2)
1245 
1246    self.selectedCmv = cmv
1247    return self.cmvByFreqStr( cmv )
1248
1249  def differenceSelectedCmvDict( self, cmv1, cmv2 ):
1250      """Return the diffence between two dictionaries of cmor variables returned by self.cmvByMip.
1251         The dictionaries contain dictionaries of values. Differences may be subdictionaries not present,
1252         elements of sub-dictionaries not present, or elements of sub-dictionaries present with different values.
1253         A one sided difference is returned."""
1254
1255      cmv = {}
1256      for i in cmv2:
1257        if i not in cmv1:
1258          cmv[i] = cmv2[i]
1259        else:
1260          eei = {}
1261          for t in cmv2[i]:
1262            if t not in cmv1[i]:
1263              eei[t] = cmv2[i][t]
1264            else:
1265              if cmv2[i][t] > cmv1[i][t]:
1266                 eei[t] = cmv2[i][t] - cmv1[i][t]
1267          if len( eei.keys() ) != 0:
1268            cmv[i] = eei
1269      return cmv
1270
1271  def cmvByFreqStr(self,cmv,asDict=True,exptFilter=None,exptFilterBlack=None):
1272    if exptFilter != None:
1273      assert type(exptFilter) == type( set() ), 'Argument exptFilter must be None or a set: %s' % str(exptFilter)
1274    if exptFilterBlack != None:
1275      assert type(exptFilterBlack) == type( set() ), 'Argument exptFilterBlack must be None or a set: %s' % str(exptFilterBlack)
1276      if exptFilter != None:
1277        assert len( exptFilter.difference( exptFilterBlack ) ) > 0, 'If exptFilter and exptFilterBlack are both set, exptFilter must have non-black listed elements' 
1278
1279    cc = collections.defaultdict( list )
1280    for i in cmv:
1281      if asDict:
1282        ii = self.dq.inx.uid[i]
1283        if ii._h.label != 'remarks':
1284         st = self.dq.inx.uid[ ii.stid ]
1285         if st._h.label != 'remarks':
1286          cc0 = collections.defaultdict( float )
1287          cc1 = collections.defaultdict( int )
1288          se = collections.defaultdict( set )
1289          for e,g in cmv[i]:
1290            cc0[g] += cmv[i][(e,g)]
1291            cc1[g] += 1
1292            se[g].add(e)
1293          for g in cc0:
1294            g1 = g
1295            if self.isLatLon[st.spid] != False:
1296              g1 = g
1297              if g1 == 'DEF' and self.isLatLon[st.spid] == 'o':
1298                  if self.gridPolicyDefaultNative:
1299                     g1 = 'native'
1300                  else:
1301                     g1 = '1deg'
1302              elif g == 'native:01':
1303                gflg = {'si':'','li':''}.get( self.cmvGridId[i], self.cmvGridId[i] )
1304                if gflg == 'o' and not self.gridOceanStructured:
1305                  g1 = '1deg'
1306                else:
1307                  g1 = 'native'
1308              elif g1 in ['1deg','2deg','native']:
1309                pass
1310              else:
1311                print ( 'WARNING --- blind default to native: %s' % g )
1312                g1 = 'native'
1313            elif g == 'native:01':
1314                g1 = 'native'
1315
1316            cc[ (st.spid,st.__dict__.get('odims',''),ii.frequency,g1) ].append( (i,cc0[g],cc1[g],se[g]) )
1317
1318      else:
1319        st = self.dq.inx.uid[ i.stid ]
1320        cc[ (st.spid,st.__dict__.get('odims',''),i.frequency) ].append( i.label )
1321
1322    self.thiscmvset = set()
1323    c2 = collections.defaultdict( dict )
1324    sf = set()
1325    if asDict:
1326      for s,o,f,g in cc.keys():
1327        c2[(s,o,g)][f] = cc[ (s,o,f,g) ]
1328        sf.add( f )
1329    else:
1330      for s,o,f in cc.keys():
1331        c2[(s,o)][f] = cc[ (s,o,f) ]
1332        sf.add( f )
1333    lf = sorted( list(sf) )
1334    c3 = collections.defaultdict( dict )
1335
1336    for tt in sorted( c2.keys() ):
1337      if asDict:
1338        s,o,g = tt
1339      else:
1340        s,o = tt
1341        g = 'native'
1342      i = self.dq.inx.uid[ s ]
1343
1344      if asDict:
1345        for f in c2[tt]:
1346            isClim = f.lower().find( 'clim' ) != -1
1347            ny = 0
1348            expts = set()
1349            labs = []
1350            labs = collections.defaultdict( int )
1351            ccx = collections.defaultdict( list )
1352            for cmvi, ny1, ne, eset in c2[tt][f]:
1353              ccx[cmvi].append( (ny1, ne, eset) )
1354            net = 0
1355            for cmvi in ccx:
1356              if len( ccx[cmvi] ) == 1:
1357                 ny1, ne, eset = ccx[cmvi][0]
1358              else:
1359                 ny1, ne, eset = ( 0,0,set() )
1360                 for a,b,s in ccx[cmvi]:
1361                   ny1 += a
1362                   ne += b
1363                   eset = eset.union(  s )
1364             
1365              net += ne
1366              if len(eset) != ne:
1367                print ( 'WARNING: inconsistency in volume estimate ... possible duplication for %s,%s' % (cmvi,f) )
1368              for e in eset:
1369                elab = self.dq.inx.uid[e].label
1370                expts.add(elab)
1371
1372              if exptFilter != None:
1373                expts = exptFilter.intersection( expts )
1374              if exptFilterBlack != None:
1375                expts = expts.difference( exptFilterBlack )
1376
1377              if len(expts) > 0:
1378                lab = self.dq.inx.uid[cmvi].label
1379                self.thiscmvset.add( cmvi )
1380                ny += ny1
1381                labs[cmvi] += ny1
1382            ne = len( expts )
1383            nn = len( labs.keys() )
1384             
1385            if isClim:
1386              ny = net/float(nn)
1387            else:
1388              ny = ny/float(nn)
1389            assert tt[2] in ['native','1deg','2deg','native:01'], 'BAD grid identifier: %s' % str(tt)
1390            c3[tt][f] = (nn,ny,ne, labs,expts)
1391    return (sf,c3)
1392
1393  def getStrSz( self, g, stid=None, s=None, o=None, tt=False, cmv=None ):
1394    assert stid == None or (s==None and o==None), 'Specify either stid or s and o'
1395    assert stid != None or (s!=None and o!=None), 'Specify either stid or s and o'
1396
1397    if stid != None:
1398      st = self.dq.inx.uid[stid]
1399      if st._h.label != 'remarks':
1400        s = st.spid
1401        o = st.__dict__.get( 'odims', '' )
1402      else:
1403        self.strSz[ (stid,g) ] = (False,0)
1404        if tt:
1405          return (self.strSz[ (stid,g) ], None)
1406        else:
1407          return self.strSz[ (stid,g) ]
1408
1409    g1 = g
1410    if g1 == 'DEF':
1411          if self.isLatLon[s] == 'o':
1412             g1 = '1deg'
1413          else:
1414             g1 = 'native'
1415    elif g1 == 'native:01':
1416      assert cmv != None, 'Need a valid cmor variable id  .... '
1417      gflg = {'si':'','li':''}.get( self.cmvGridId[cmv], self.cmvGridId[cmv] )
1418      if gflg == 'o' and not self.gridOceanStructured:
1419                  g1 = '1deg'
1420      else:
1421                  g1 = 'native'
1422    if (s,o,g) not in self.strSz:
1423
1424        if o == '':
1425           sf = 1
1426        elif o in self.odsz:
1427           sf = self.odsz[o]
1428        else:
1429           sf = 5
1430
1431        if type( sf ) == type( () ):
1432           sf = sf[0]
1433
1434        try:
1435          if g1 != 'native' and self.isLatLon[s] != False:
1436            szg = self.szgss[g1][s]
1437          else:
1438            szg = self.szss[s]
1439        except:
1440          print ( 'Failed to get size for: %s, %s, %s' % (g,g1,s ) )
1441          raise
1442
1443        szg = szg * sf
1444        self.strSz[ (s,o,g) ] = (True,szg)
1445
1446    if tt:
1447      return (self.strSz[ (s,o,g) ], (s,o,g1) )
1448    else:
1449      return self.strSz[ (s,o,g) ]
1450
1451  def rvgByMip( self, mip, years=False, includePreset=False, returnLinks=False ):
1452    l1 = self.rqlByMip( mip )
1453    if includePreset:
1454      cc = collections.defaultdict( set )
1455      ss = set()
1456      for i in l1:
1457        if 'requestItem' in self.dq.inx.iref_by_sect[i.uid].a:
1458          prs = set()
1459          for x in self.dq.inx.iref_by_sect[i.uid].a['requestItem']:
1460             prs.add(self.dq.inx.uid[x].preset)
1461
1462          for p in prs:
1463            assert p in [-1,1,2,3], 'Bad preset value'
1464            cc[p].add( i.refid )
1465      ee = {}
1466      for p in cc:
1467        l2 = sorted( [self.dq.inx.uid[i] for i in cc[p]], key=lambda x: x.label )
1468        ee[p] = l2
1469      if returnLinks:
1470        return (l1,ee)
1471      else:
1472        return ee
1473    else:
1474      ss = set( [i.refid for i in l1] )
1475      l2 = sorted( [self.dq.inx.uid[i] for i in ss], key=lambda x: x.label )
1476      if returnLinks:
1477        return (l1,l2)
1478      else:
1479        return l2
1480
1481  def volByMip2( self, mip, pmax=2, intersection=False, adsCount=False, exptid=None,makeTabs=False, odir='xls'):
1482      vs = volsum.vsum( self, odsz, npy )
1483      rqf = 'dummy'
1484      vsmode='short'
1485      if makeTabs:
1486        mlab = misc_utils.setMlab( mip )
1487        rqf = '%s/requestVol_%s_%s_%s' % (odir,mlab,self.tierMax,pmax)
1488        vsmode='full'
1489      vs.run( mip, rqf, pmax=pmax, doxlsx=makeTabs ) 
1490      vs.anal(olab='dummy', doUnique=False, mode=vsmode, makeTabs=makeTabs)
1491      self.vf = vs.res['vf'].copy()
1492      for f in sorted( vs.res['vf'].keys() ):
1493           mlg.prnt ( 'Frequency: %s: %s' % (f, vs.res['vf'][f]*2.*1.e-12 ) )
1494      ttl = sum( [x for k,x in vs.res['vu'].items()] )
1495      self.res = vs.res
1496      self.indexedVol = collections.defaultdict( dict )
1497      for u in vs.res['vu']:
1498        cmv = self.dq.inx.uid[u]
1499        self.indexedVol[cmv.frequency]['%s.%s' % (cmv.mipTable,cmv.label)] = vs.res['vu'][u]
1500      return ttl
1501
1502  def volByMip( self, mip, pmax=2, intersection=False, adsCount=False, exptid=None):
1503
1504    l1 = self.rqiByMip( mip )
1505     
1506    #### The set of experiments/experiment groups:
1507    if exptid == None:
1508      exps = self.experiments
1509    elif type( exptid ) == type(''):
1510      exps = set( [exptid,] )
1511    else:
1512      assert type( exptid ) == type( set() ),'exptid arg to volByMip must be None, string or set: %s' % type( exptid )
1513      exps = exptid
1514   
1515    self.volByE = {}
1516    vtot = 0
1517    cc = collections.defaultdict( col_count )
1518    self.allVars = set()
1519    for e in exps:
1520      expts = self.esid_to_exptList(e,deref=True,full=False)
1521      if expts not in  [None,[]]:
1522        for ei in expts:
1523          self.volByE[ei.label] = self.volByExpt( l1, ei.uid, pmax=pmax, cc=cc, intersection=intersection, adsCount=adsCount )
1524          vtot += self.volByE[ei.label][0]
1525        self.allVars = self.allVars.union( self.vars )
1526    self.indexedVol = cc
1527
1528    return vtot
1529
1530  def listIndexDual(self, ll, a1, a2, acount=None, alist=None, cdict=None, cc=None ):
1531    do_count = acount != None
1532    do_list = alist != None
1533    assert not (do_count and do_list), 'It is an error to request both list and count'
1534    if not (do_count or do_list):
1535      acount = '__number__'
1536      do_count = True
1537
1538    if cc == None:
1539      if do_count:
1540        cc = collections.defaultdict( col_count )
1541      elif do_list:
1542        cc = collections.defaultdict( col_list )
1543
1544    if do_count:
1545      for l in ll:
1546        if cdict != None:
1547          v = cdict[l.uid]
1548        elif acount == '__number__':
1549          v = 1
1550        else:
1551          v = l.__dict__[acount]
1552
1553        cc[ l.__dict__[a1] ].a[ l.__dict__[a2] ] += v
1554    elif do_list:
1555      for l in ll:
1556        if cdict != None:
1557          v = cdict[l.uid]
1558        elif alist == '__item__':
1559          v = l
1560        else:
1561          v = l.__dict__[alist]
1562        cc[ l.__dict__[a1] ].a[ l.__dict__[a2] ].append( v )
1563
1564    od = {}
1565    for k in cc.keys():
1566      d2 = {}
1567      for k2 in cc[k].a.keys():
1568        d2[k2] = cc[k].a[k2]
1569      od[k] = d2
1570    return od
1571
1572class dreqUI(object):
1573  """Data Request Command line.
1574-------------------------
1575      -v : print version and exit;
1576      --unitTest : run some simple tests;
1577      -m <mip>:  MIP of list of MIPs (comma separated; for objective selection see note [1] below);
1578      -l <options>: List for options:
1579              o: objectives
1580              e: experiments
1581      -q <options>: List information about the schema:
1582              s: sections
1583              <section>: attributes for a section
1584              <section:attribute>: definition of an attribute.
1585      -h :       help: print help text;
1586      -e <expt>: experiment;
1587      -t <tier> maxmum tier;
1588      -p <priority>  maximum priority;
1589      --xls : Create Excel file with requested variables;
1590      --sf : Print summary of variable count by structure and frequency [default];
1591      --legacy : Use legacy approach to volume estimation (deprecated);
1592      --xfr : Output variable lists in sheets organised by frequency and realm instead of by MIP table;
1593      --SF : Print summary of variable count by structure and frequency for all MIPs;
1594      --grdpol <native|1deg> :  policy for default grid, if MIPs have not expressed a preference;
1595      --grdforce <native|1deg> :  force a specific grid option, independent of individual preferences;
1596      --ogrdunstr : provide volume estimates for unstructured ocean grid (interpolation requirements of OMIP data are different in this case);
1597      --omitCmip : omit the CMIP core data request (included by default);
1598      --allgrd :  When a variable is requested on multiple grids, archive all grids requested (default: only the finest resolution);
1599      --unique :  List only variables which are requested uniquely by this MIP, for at least one experiment;
1600      --esm :  include ESM experiments (default is to omit esm-hist etc from volume estimates);
1601      --txt : Create text file with requested variables;
1602      --mcfg : Model configuration: 7 integers, comma separated, 'nho','nlo','nha','nla','nlas','nls','nh1'
1603                 default: 259200,60,64800,40,20,5,100
1604      --txtOpts : options for content of text file: (v|c)[(+|-)att1[,att2[...]]]
1605      --xlsDir <directory> : Directory in which to place variable listing [xls];
1606      --printLinesMax <n>  : Maximum number of lines to be printed (default 20)
1607      --printVars    : If present, a summary of the variables (see --printLinesMax) fitting the selection options will be printed
1608      --intersection : Analyse the intersection of requests rather than union.
1609
1610NOTES
1611-----
1612[1] A set of objectives within a MIP can be specified in the command line. The extended syntax of the "-m" argument is:
1613-m <mip>[:objective[.obj2[.obj3 ...]]][,<mip2]...]
1614
1615e.g.
1616drq -m HighResMIP:Ocean.DiurnalCycle
1617"""
1618  def __init__(self,args):
1619    self.adict = {}
1620    self.knownargs = {'-m':('m',True), '-p':('p',True), '-e':('e',True), '-t':('t',True), \
1621                      '-h':('h',False), '--printLinesMax':('plm',True), \
1622                      '-l':('l',True),
1623                      '-q':('q',True),
1624                      '--printVars':('vars',False), '--intersection':('intersection',False), \
1625                      '--count':('count',False), \
1626                      '--txt':('txt',False), \
1627                      '--sf':('sf',False), \
1628                      '--legacy':('legacy',False), \
1629                      '--xfr':('xfr',False), \
1630                      '--SF':('SF',False), \
1631                      '--esm':('esm',False), \
1632                      '--grdpol':('grdpol',True), \
1633                      '--ogrdunstr':('ogrdunstr',False), \
1634                      '--grdforce':('grdforce',True), \
1635                      '--omitCmip':('omitcmip',False), \
1636                      '--allgrd':('allgrd',False), \
1637                      '--unique':('unique',False), \
1638                      '--mcfg':('mcfg',True), \
1639                      '--txtOpts':('txtOpts',True), \
1640                      '--xlsDir':('xlsdir',True), '--xls':('xls',False) \
1641                       } 
1642    aa = args[:]
1643    notKnownArgs = []
1644    while len(aa) > 0:
1645      a = aa.pop(0)
1646      if a in self.knownargs:
1647        b = self.knownargs[a][0]
1648        if self.knownargs[a][1]:
1649          v = aa.pop(0)
1650          self.adict[b] = v
1651        else:
1652          self.adict[b] = True
1653      else:
1654        notKnownArgs.append(a)
1655
1656    assert self.checkArgs( notKnownArgs ), 'FATAL ERROR 001: Arguments not recognised: %s' % (str(notKnownArgs) )
1657
1658    if 'm' in self.adict:
1659      if self.adict['m'] == '_all_':
1660        pass
1661      elif self.adict['m'].find( ':' ) != -1:
1662        ee = {}
1663        for i in self.adict['m'].split(','):
1664          bits =  i.split( ':' )
1665          if len( bits ) == 1:
1666             ee[bits[0]] = []
1667          else:
1668             assert len(bits) == 2, 'Cannot parse %s' % self.adict['m']
1669             ee[bits[0]] = bits[1].split( '.' )
1670        self.adict['m'] = ee
1671      else:
1672        self.adict['m'] = set(self.adict['m'].split(',') )
1673        if 'omitcmip' not in self.adict and 'CMIP' not in self.adict['m']:
1674          self.adict['m'].add( 'CMIP' )
1675
1676    if 'grdpol' in self.adict:
1677      assert self.adict['grdpol'] in ['native','1deg'], 'Grid policy argument --grdpol must be native or 1deg : %s' % self.adict['grdpol']
1678
1679    if 'grdforce' in self.adict:
1680      assert self.adict['grdforce'] in ['native','1deg'], 'Grid policy argument --grdforce must be native or 1deg : %s' % self.adict['grdforce']
1681
1682    integerArgs = set( ['p','t','plm'] )
1683    for i in integerArgs.intersection( self.adict ):
1684      self.adict[i] = int( self.adict[i] )
1685
1686    self.intersection = self.adict.get( 'intersection', False )
1687
1688 
1689  def checkArgs( self, notKnownArgs ):
1690    if len( notKnownArgs ) == 0:
1691      return True
1692    print ('--------------------------------------')
1693    print ('------------  %s Arguments Not Recognised ------------' % len(notKnownArgs) )
1694    k = 0
1695    for x in notKnownArgs:
1696      k += 1
1697      if x[1:] in self.knownargs:
1698        print ( '%s PERHAPS %s instead of %s' % (k, x[1:],x) )
1699      elif '-%s' % x in self.knownargs:
1700        print ( '%s PERHAPS -%s instead of %s' % (k, x,x) )
1701      elif x[0] == '\xe2':
1702        print ( '%s POSSIBLY -- (double hyphen) instead of long dash in %s' % (k, x) )
1703    print ('--------------------------------------')
1704
1705    return len( notKnownArgs ) == 0
1706     
1707  def run(self, dq=None):
1708    if 'h' in self.adict:
1709      mlg.prnt ( self.__doc__ )
1710      return
1711
1712    if 'q' in self.adict:
1713      if dq == None:
1714        dq = dreq.loadDreq(configOnly=True)
1715      s = self.adict['q']
1716      if self.adict['q'] == 's':
1717        ss = sorted( [(i.title,i.label) for i in dq.coll['__sect__'].items] )
1718        for s in ss:
1719          mlg.prnt( '%16s:: %s' % (s[1],s[0]) )
1720      else:
1721        ss = [i.label for i in dq.coll['__sect__'].items]
1722        if s.find( ':' ) != -1:
1723          s,a = s.split( ':' )
1724        else:
1725          a = None
1726        if s not in ss:
1727          mlg.prnt( 'ERROR: option must be a section; use "-q s" to list sections' )
1728        elif a == None:
1729          x = [i for i in dq.coll['__sect__'].items if i.label == s]
1730          s1 = [i for i in  dq.coll['__main__'].items if 'ATTRIBUTE::%s' % s in i.uid]
1731          mlg.prnt( x[0].title )
1732          mlg.prnt( ' '.join( sorted  ([i.label for i in s1] ) ))
1733        else:
1734          x = [i for i in dq.coll['__main__'].items if i.uid == 'ATTRIBUTE::%s.%s' % (s,a) ]
1735          if len(x) == 0:
1736            mlg.prnt( 'ERROR: attribute not found' )
1737            s1 = [i for i in  dq.coll['__main__'].items if 'ATTRIBUTE::%s' % s in i.uid]
1738            mlg.prnt( 'ATTRIBUTES: ' + ' '.join( sorted  ([i.label for i in s1] ) ))
1739          else:
1740            mlg.prnt( 'Section %s, attribute %s' % (s,a) )
1741            mlg.prnt( x[0].title )
1742            mlg.prnt( x[0].description )
1743      return
1744
1745    if not ('m' in self.adict or 'SF' in self.adict):
1746      mlg.prnt ( 'Current version requires -m or --SF argument'  )
1747      mlg.prnt ( self.__doc__ )
1748      sys.exit(0)
1749
1750    if dq == None:
1751      self.dq = dreq.loadDreq()
1752    else:
1753      self.dq = dq
1754
1755    if 'l' in self.adict:
1756      self.printList()
1757      return
1758
1759    if 'mcfg' in self.adict:
1760      ll = string.split( self.adict['mcfg'], ',' )
1761      assert len(ll) == 7, 'Length of model configuration argument must be 7 comma separated integers: %s' %  self.adict['mcfg']
1762      lli = [ int(x) for x in ll]
1763
1764    self.sc = dreqQuery( dq=self.dq )
1765    self.sc.intersection = self.intersection
1766
1767    if 'grdforce' in self.adict:
1768      self.sc.gridPolicyForce = self.adict['grdforce']
1769    if 'grdpol' in self.adict:
1770      self.sc.gridPolicyDefaultNative = self.adict['grdpol'] == 'native'
1771      print ( 'SETTING grid policy: %s' % self.sc.gridPolicyDefaultNative )
1772    if 'allgrd' in self.adict:
1773      self.sc.gridPolicyTopOnly = False
1774      print ( 'SETTING grid policy for multiple preferred grids: %s' % self.sc.gridPolicyTopOnly )
1775    if 'unique' in self.adict:
1776      self.sc.uniqueRequest = True
1777    self.sc.gridOceanStructured = not self.adict.get( 'ogrdunstr', False )
1778
1779    if 'mcfg' in self.adict:
1780      self.sc.setMcfg( lli )
1781
1782    tierMax = self.adict.get( 't', 1 )
1783    self.sc.setTierMax(  tierMax )
1784    pmax = self.adict.get( 'p', 1 )
1785
1786    makeXls = self.adict.get( 'xls', False )
1787    makeTxt = self.adict.get( 'txt', False )
1788    ##doSf = 'SF' in self.adict or 'sf' in self.adict
1789    doSf = 'legacy' not in self.adict
1790    if doSf:
1791      self.adict['sf'] = True
1792    assert not ('legacy' in self.adict and 'sf' in self.adict), "Conflicting command line argument, 'legacy' and 'sf': use only one of these"
1793    if makeXls or makeTxt or doSf:
1794      xlsOdir = self.adict.get( 'xlsdir', 'xls' )
1795      self.sc.checkDir( xlsOdir, 'xls files' )
1796
1797    tabByFreqRealm = self.adict.get( 'xfr', False )
1798    if 'SF' in self.adict:
1799      self.sc.gridPolicyDefaultNative = True
1800      vs = volsum.vsum( self.sc, odsz, npy, odir=xlsOdir, tabByFreqRealm=tabByFreqRealm )
1801      vs.analAll(pmax)
1802
1803      self.sc.gridPolicyDefaultNative = False
1804      vs = volsum.vsum( self.sc, odsz, npy, odir=xlsOdir, tabByFreqRealm=tabByFreqRealm )
1805      vs.analAll(pmax)
1806
1807      self.sc.setTierMax( 3 )
1808      vs = volsum.vsum( self.sc, odsz, npy, odir=xlsOdir, tabByFreqRealm=tabByFreqRealm )
1809      vs.analAll(3)
1810      return
1811
1812    ok = True
1813    if self.adict['m'] == '_all_':
1814      self.adict['m'] = set(self.sc.mips )
1815      mlab = 'TOTAL'
1816    else:
1817      for i in self.adict['m']:
1818        if i not in self.sc.mips:
1819          ok = False
1820          tt = misc_utils.mdiff().diff( i,self.sc.mips )
1821          assert not tt[0], 'Bad logic ... unexpected return from misc_utils.mdiff'
1822          ##cms = difflib.get_close_matches(i,self.sc.mips )
1823          if tt[1] == 0:
1824            mlg.prnt ( 'NOT FOUND: %s' % i )
1825          else:
1826            msg = []
1827            for ix in tt[2]:
1828              msg.append( '%s [%4.1f]' % (','.join( ix[1] ),ix[0]) ) 
1829
1830            mlg.prnt( '----------------------------------------' )
1831            if tt[1] == 1 and len(tt[2][0][1]) == 1:
1832              mlg.prnt ( 'NOT FOUND: %s:  SUGGESTION: %s' % (i,msg[0]) )
1833            else:
1834              mlg.prnt ( 'NOT FOUND: %s:  SUGGESTIONS: %s' % (i,'; '.join( msg ) ) ) 
1835            mlg.prnt( '----------------------------------------' )
1836      mlab = misc_utils.setMlab( self.adict['m'] )
1837    assert ok,'Available MIPs: %s' % str(self.sc.mips)
1838
1839    eid = None
1840    ex = None
1841    if 'e' in self.adict:
1842      ex = self.adict['e']
1843      if ex in self.sc.mipsp:
1844        eid = set( self.dq.inx.iref_by_sect[ex].a['experiment'] )
1845        self.sc.exptFilter = eid
1846      elif self.adict['e'] in self.sc.exptByLabel:
1847        eid = self.sc.exptByLabel[ self.adict['e'] ]
1848        self.sc.exptFilter = set( [eid,] )
1849      else:
1850        ns = 0
1851        md =  misc_utils.mdiff()
1852        ttm = md.diff( self.adict['e'],self.sc.mipsp )
1853        tte = md.diff( self.adict['e'],self.sc.exptByLabel.keys() )
1854        if ttm[1] > 0 and tte[1] == 0 or (ttm[2][0][0] > 0.6*tte[2][0][0]):
1855          oo =  md.prntprep( self.adict['e'], ttm )
1856          for l in oo:
1857            mlg.prnt( l )
1858        if tte[1] > 0 and ttm[1] == 0 or (tte[2][0][0] > 0.6*ttm[2][0][0]):
1859          oo =  md.prntprep( self.adict['e'], tte )
1860          for l in oo:
1861            mlg.prnt( l )
1862        assert False, 'Experiment/MIP %s not found' % self.adict['e']
1863
1864    if not self.adict.get( 'esm', False ):
1865      ss = set()
1866      for e in ['esm-hist','esm-hist-ext','esm-piControl','piControl-spinup','esm-piControl-spinup']:
1867        ss.add( self.sc.exptByLabel[ e ] )
1868      self.sc.exptFilterBlack = ss
1869    makeXls = self.adict.get( 'xls', False )
1870
1871    if 'sf' in self.adict:
1872      vs = volsum.vsum( self.sc, odsz, npy, odir=xlsOdir, tabByFreqRealm=tabByFreqRealm )
1873      vs.run( self.adict['m'], '%s/requestVol_%s_%s_%s' % (xlsOdir,mlab,tierMax,pmax), pmax=pmax, doxlsx=makeXls ) 
1874      totalOnly = False
1875      if len( self.adict['m'] ) == 1 or totalOnly:
1876        if makeXls:
1877          vsmode='full'
1878        else:
1879          vsmode='short'
1880        vs.anal(olab=mlab,doUnique=False, mode=vsmode, makeTabs=makeXls)
1881        for f in sorted( vs.res['vf'].keys() ):
1882           mlg.prnt ( 'Frequency: %s: %s' % (f, vs.res['vf'][f]*2.*1.e-12 ) )
1883        ttl = sum( [x for k,x in vs.res['vu'].items()] )*2.*1.e-12
1884        mlg.prnt( 'TOTAL volume: %8.2fTb' % ttl )
1885        self.printListCc(vs.res['vu'])
1886        return
1887     
1888      mips = self.adict['m']
1889      if type(mips) in [type(set()),type(dict())]:
1890          mips = self.adict['m'].copy()
1891          if len(mips) > 1:
1892            if type(mips) == type(set()):
1893               mips.add( '*TOTAL' )
1894            else:
1895               mips['*TOTAL'] = ''
1896
1897      vs.analAll(pmax,mips=mips,html=False,makeTabs=makeXls)
1898      thisd = {}
1899      for m in sorted( self.adict['m'] ) + ['*TOTAL',]:
1900        for f in sorted( vs.rres[m].keys() ):
1901           mlg.prnt ( '%s:: Frequency: %s: %s' % (m,f, vs.rres[m][f]*2.*1.e-12 ) )
1902      for m in sorted( self.adict['m'] ) + ['*TOTAL',]:
1903        thisd[m] = sum( [x for k,x in vs.rres[m].items()] )
1904        mlg.prnt( '%s:: TOTAL volume: %8.2fTb' % (m, thisd[m]*2.*1.e-12 )  )
1905      self.printListCc(vs.rresu['*TOTAL'])
1906      return
1907
1908    adsCount = self.adict.get( 'count', False )
1909
1910    self.getVolByMip(pmax,eid,adsCount)
1911    makeTxt = self.adict.get( 'txt', False )
1912    if makeXls or makeTxt:
1913      mips = self.adict['m']
1914
1915      if 'txtOpts' in self.adict:
1916        if self.adict['txtOpts'][0] == 'v':
1917          txtOpts = NT_txtopts( 'var' )
1918        else:
1919          txtOpts = NT_txtopts( 'cmv' )
1920      else:
1921        txtOpts=None
1922
1923      self.sc.xlsByMipExpt(mips,eid,pmax,odir=xlsOdir,xls=makeXls,txt=makeTxt,txtOpts=txtOpts)
1924
1925  def printListCc(self,cc):
1926    if self.adict.get( 'vars', False ):
1927      if python2:
1928            vl = sorted( cc.keys(), cmp=cmpd(cc).cmp, reverse=True )
1929      else:
1930            vl = sorted( cc.keys(), key=lambda x: cc[x], reverse=True )
1931      printLinesMax = self.adict.get( 'plm', 20 )
1932      if printLinesMax > 0:
1933        mx = min( [printLinesMax,len(vl)] )
1934      else:
1935        mx = len(vl)
1936
1937      for k in vl[:mx]:
1938            cmv = self.dq.inx.uid[k]
1939            print ('%s.%s::   %sTb' % (cmv.mipTable, cmv.label, cc[k]*2.*1.e-12) )
1940
1941  def printList(self):
1942    mips = self.adict['m']
1943    ee = {}
1944    for i in self.dq.coll['mip'].items:
1945      if i.label in mips:
1946        ee[i.label] = i
1947    if self.adict['l'] in ['o','e']:
1948      targ = {'o':'objective', 'e':'experiment' }[self.adict['l']]
1949      for k in sorted( ee.keys() ):
1950        if targ in self.dq.inx.iref_by_sect[ee[k].uid].a:
1951          for u in self.dq.inx.iref_by_sect[ee[k].uid].a[targ]:
1952            print ( '%s: %s' % (ee[k].label, self.dq.inx.uid[u].label) )
1953    else:
1954      print ('list objective *%s* not recognised (should be e or o)' % self.adict['l'] )
1955     
1956  def getVolByMip(self,pmax,eid,adsCount):
1957
1958    v0 = self.sc.volByMip( self.adict['m'], pmax=pmax, intersection=self.intersection, adsCount=adsCount, exptid=eid )
1959    mlg.prnt ( 'getVolByMip: %s [%s]' % (v0,misc_utils.vfmt(v0*2.)) )
1960    cc = collections.defaultdict( int )
1961    for e in self.sc.volByE:
1962      for v in self.sc.volByE[e][2]:
1963          cc[v] += self.sc.volByE[e][2][v]
1964    x = 0
1965    for v in cc:
1966      x += cc[v]
1967   
1968    if python2:
1969      vl = sorted( cc.keys(), cmp=cmpd(cc).cmp, reverse=True )
1970    else:
1971      vl = sorted( cc.keys(), key=lambda x: cc[x], reverse=True )
1972    if self.adict.get( 'vars', False ):
1973      printLinesMax = self.adict.get( 'plm', 20 )
1974      if printLinesMax > 0:
1975        mx = min( [printLinesMax,len(vl)] )
1976      else:
1977        mx = len(vl)
1978
1979      for v in vl[:mx]:
1980        mlg.prnt ( '%s.%s: %s' % (self.dq.inx.uid[v].mipTable,self.dq.inx.uid[v].label, misc_utils.vfmt( cc[v]*2. ) ) )
1981      if mx < len(vl):
1982        mlg.prnt ( '%s variables not listed (use --printLinesMax to print more)' % (len(vl)-mx) )
1983
Note: See TracBrowser for help on using the repository browser.