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

Subversion URL: http://proj.badc.rl.ac.uk/svn/exarch/CMIP6dreq/trunk/dreqPy/scope.py@1309
Revision 1309, 74.9 KB checked in by mjuckes, 10 months ago (diff)

01.00.30beta

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