source: CMIP6dreqbuild/trunk/src/framework/dreqPy/volsum.py @ 1254

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

fixed --txt option

Line 
1import xlsxwriter
2from xlsxwriter.utility import xl_rowcol_to_cell
3import collections, os
4
5
6try:
7  import dreq
8  imm=1
9except:
10  import dreqPy.dreq  as dreq
11  imm=2
12
13if imm == 1:
14  import misc_utils
15  import table_utils
16  import overviewTabs
17  from extensions import collect as extCollect
18##
19## the double underscore causes some confusion, creating an error message _vsum__requestLink__expt not found.
20  from extensions.collect import _requestLink__expt as requestLink__expt
21else:
22  import dreqPy.misc_utils as misc_utils
23  import dreqPy.table_utils as table_utils
24  import dreqPy.overviewTabs as overviewTabs
25  from dreqPy.extensions import collect as extCollect
26  from dreqPy.extensions.collect import _requestLink__expt as requestLink__expt
27
28
29
30class xlsx(object):
31  def __init__(self,fn,txtOpts=None):
32    """Class to write spreadsheets of CMOR variables"""
33    self.txtOpts = txtOpts
34    self.mcfgNote = 'Reference Volume (1 deg. atmosphere, 0.5 deg. ocean)'
35    self.wb = xlsxwriter.Workbook('%s.xlsx' % fn)
36    self.hdr_cell_format = self.wb.add_format({'text_wrap': True, 'font_size': 14, 'font_color':'#0000ff', 'bold':1, 'fg_color':'#aaaacc'})
37    self.hdr_cell_format.set_text_wrap()
38    self.sect_cell_format = self.wb.add_format({'text_wrap': True, 'font_size': 14, 'font_color':'#0000ff', 'bold':1, 'fg_color':'#ccccbb'})
39    self.sect_cell_format.set_text_wrap()
40    self.cell_format = self.wb.add_format({'text_wrap': True, 'font_size': 11})
41    self.cell_format.set_text_wrap()
42
43  def newSheet(self,name):
44    self.sht = self.wb.add_worksheet(name=name)
45    return self.sht
46
47  def tabrec(self,j,orec):
48        for i in range(len(orec)):
49          if orec[i] != '' and type( orec[i] ) == type( '' ) and orec[i][0] == '$':
50             self.sht.write_formula(j,i, '{=%s}' % orec[i][1:])
51          else:
52             if j == 0:
53               self.sht.write( j,i, orec[i], self.hdr_cell_format )
54             else:
55               self.sht.write( j,i, orec[i], self.cell_format )
56
57  def close(self):
58      self.wb.close()
59
60class vsum(object):
61  def __init__(self,sc,odsz,npy,exptFilter=None, odir='xls', tabByFreqRealm=False,txt=False,txtOpts=None):
62    self.tabByFreqRealm = tabByFreqRealm
63    self.doTxt = txt
64    self.txtOpts = txtOpts
65    idir = dreq.DOC_DIR
66    if 'collect' not in sc.dq._extensions_:
67      extCollect.add(sc.dq)
68    self.sc = sc
69    self.exptMipRql = collections.defaultdict( set )
70    for i in self.sc.dq.coll['requestLink'].items:
71      expts = requestLink__expt(i,rql=[i.uid,])
72      for e in expts:
73        self.exptMipRql[ (i.mip,self.sc.dq.inx.uid[e].label) ].add( i.uid)
74    self.odsz=odsz
75    self.npy = npy
76    self.exptFilter = exptFilter
77    self.strSz = dict()
78    self.accum = False
79    self.odir = odir
80    self.efnsfx = ''
81    if sc.gridPolicyForce == 'native':
82      self.efnsfx = '_fn'
83    elif sc.gridPolicyForce == '1deg':
84      self.efnsfx = '_f1'
85    elif sc.gridPolicyDefaultNative:
86      self.efnsfx = '_dn'
87    if not os.path.isdir( odir ):
88      print ( 'Creating new directory for xlsx output: %s' % odir )
89      os.mkdir( odir )
90
91    self.xlsPrefixM = 'cmvmm'
92    self.xlsPrefixE = 'cmvme'
93    self.xlsPrefixU = 'cmvume'
94    if tabByFreqRealm:
95      self.xlsPrefixM += 'fr'
96      self.xlsPrefixE += 'fr'
97      self.xlsPrefixU += 'fr'
98    ii = open( '%s/sfheadings.csv' % idir, 'r' )
99    self.infoRows = []
100    for l in ii.readlines():
101      ll = l.strip().split( '\t' )
102      assert len(ll) == 2, 'Failed to parse info row: %s' % l
103      self.infoRows.append( ll )
104    ii.close()
105
106  def analAll(self,pmax,mips=None,html=True,makeTabs=True):
107      volsmm={}
108      volsmmt={}
109      volsme={}
110      volsue={}
111      if mips == None:
112        theseMips =  ['TOTAL',] + self.sc.mips
113      else:
114        theseMips = list(mips)
115
116## move *TOTAL to end of list.
117      if '*TOTAL' in theseMips:
118         theseMips.remove( '*TOTAL' )
119         theseMips.append( '*TOTAL' )
120
121      self.rres = {}
122      self.rresu = {}
123      self.accPdict = collections.defaultdict( set )
124   
125      for m in theseMips:
126        olab = m
127        useAccPdict = False
128        if m == '*TOTAL':
129            thism = theseMips[:]
130            if type( thism ) == type( set() ):
131              thism.remove( '*TOTAL' )
132            else:
133              thism.remove( '*TOTAL' )
134            olab = misc_utils.setMlab( thism )
135            useAccPdict = True
136        elif type( theseMips ) == type( dict() ):
137            thism = {m:theseMips[m]}
138        else:
139            thism = m
140
141        if m != 'TOTAL' and 'TOTAL' in theseMips:
142          cmv1, cmvts = self.sc.cmvByInvMip(thism,pmax=pmax,includeYears=True)
143          self.uniqueCmv = self.sc.differenceSelectedCmvDict(  cmv1, cmvTotal )
144
145        self.run( thism, '%s/requestVol_%s_%s_%s' % (self.odir,olab,self.sc.tierMax,pmax), pmax=pmax,doxlsx=makeTabs )
146
147        self.anal(olab=olab,doUnique='TOTAL' in theseMips, makeTabs=makeTabs, useAccPdict=useAccPdict)
148        ttl = sum( [x for k,x in self.res['vu'].items()] )*2.*1.e-12
149        volsmm[m] = self.res['vm']
150        volsmmt[m] = self.res['vmt']
151        volsme[m] = self.res['ve']
152        volsue[m] = self.res['uve']
153        self.rres[m] = self.res['vf'].copy()
154        self.rresu[m] = self.res['vu'].copy()
155        if m == 'TOTAL':
156          cmvTotal = self.sc.selectedCmv.copy()
157          self.uniqueCmv =  {}
158      if html:
159        r1 = overviewTabs.r1( self.sc, table_utils.tables, pmax=pmax, vols=( volsmm, volsme, volsmmt,volsue ) )
160
161  def _analSelectedCmv(self,cmv):
162    lex = collections.defaultdict( list )
163    vet = collections.defaultdict( int )
164    vf = collections.defaultdict( int )
165    vu = collections.defaultdict( float )
166    mvol = collections.defaultdict( dict )
167
168    for u in cmv:
169      i = self.sc.dq.inx.uid[u]
170      if i._h.label != 'remarks':
171        npy = self.npy[ i.frequency ]
172        isClim = i.frequency.lower().find( 'clim' ) != -1 or i.frequency in ['monC', '1hrCM']
173        st = self.sc.dq.inx.uid[i.stid]
174        c1 = 0
175        for e,g in cmv[u]:
176          ee = self.sc.dq.inx.uid[e]
177          if ee.mip not in ['SolarMIP']:
178            lex[e].append( u )
179            t1, tt = self.sc.getStrSz( g, stid=i.stid, tt=True, cmv=u )
180            np = t1[1]*npy
181            if not isClim:
182              np = np*cmv[u][(e,g)]
183            c1 += cmv[u][(e,g)]
184            vet[(e,i.mipTable)] += np
185            vf[i.frequency] += np
186            vu[u] += np
187          else:
188            print ('ERROR.obsoleteMip.00001: %s,%s,%s' % (ee.mip,ee.label,ee.uid) )
189        if i.frequency in ['mon','monPt']:
190            mvol[tt][u] = c1
191
192    return dict(lex), dict(vet), dict(vf), dict(vu), dict(mvol)
193
194  def xlsDest(self,mode,olab,lab2):
195    if mode == 'e':
196      return '%s/%s_%s_%s_%s_%s%s' % (self.odir,self.xlsPrefixE,olab,lab2,self.sc.tierMax,self.pmax,self.efnsfx)
197    elif mode == 'u':
198      return '%s/%s_%s_%s_%s_%s%s' % (self.odir,self.xlsPrefixU,olab,lab2,self.sc.tierMax,self.pmax,self.efnsfx)
199    else:
200      return '%s/%s_%s_%s_%s_%s%s' % (self.odir,self.xlsPrefixM,olab,lab2,self.sc.tierMax,self.pmax,self.efnsfx)
201
202  def anal(self,olab=None,doUnique=False,makeTabs=False,mode='full',useAccPdict=False):
203    vmt = collections.defaultdict( int )
204    vm = collections.defaultdict( int )
205    ve = collections.defaultdict( int )
206    uve = collections.defaultdict( int )
207    lm = collections.defaultdict( set )
208
209    lex, vet, vf, vu, mvol = self._analSelectedCmv(self.sc.selectedCmv )
210    if mode == 'short':
211      self.res = { 'vet':vet,  'lex':lex, 'vu':vu, 'vf':vf}
212      return
213
214    if olab != 'TOTAL' and doUnique:
215      s_lex, s_vet, s_vf, s_vu, s_mvol = self._analSelectedCmv(self.uniqueCmv )
216      s_lm = set( self.uniqueCmv.keys() )
217      s_cc = collections.defaultdict( int )
218      for e,t in s_vet:
219        s_cc[t] += s_vet[(e,t)]
220        vm['Unique'] += s_vet[(e,t)]
221        vmt[('Unique',t)] += s_vet[(e,t)]
222        uve[e] += s_vet[(e,t)]
223
224    checkMvol = -1
225    if checkMvol > 0:
226      for k in mvol:
227        sp = self.sc.dq.inx.uid[k[0]]
228        if k not in self.mvol:
229          print ( 'INFO.volsum.01001: %s missing from mvol: ' % str(k) )
230        else:
231          if checkMvol > 1:
232            for u in mvol[k]:
233              la = self.sc.dq.inx.uid[u].label
234              if self.mvol[k][u] != mvol[k][u]:
235                print ( 'MISMATCH IN %s (%s): %s:: %s,%s' % (str(k),sp.label,la,mvol[k][u],self.mvol[k][u]) )
236         
237    for e in lex:
238      ee = self.sc.dq.inx.uid[e]
239      for i in lex[e]:
240        lm[ee.mip].add( i )
241
242    for e,t in vet:
243      ee = self.sc.dq.inx.uid[e]
244      vmt[(ee.mip,t)] += vet[(e,t)]
245      vm[ee.mip] += vet[(e,t)]
246      ve[e] += vet[(e,t)]
247##
248## makeTab needs: cc[m]: volume summary, by table,   lm[m]: list of CMOR variables
249##
250    cc = collections.defaultdict( dict )
251    cct = collections.defaultdict( int )
252    for m,t in vmt:
253      cc[m][t] = vmt[(m,t) ]
254    ss = set()
255    for m in sorted( vm.keys() ):
256      if olab != None:
257        for t in cc[m]:
258          cct[t] += cc[m][t]
259        ss = ss.union( lm[m] )
260        if makeTabs:
261          ##table_utils.makeTab(self.sc.dq, subset=lm[m], dest=self.xlsDest('m',olab,m), collected=cc[m],exptUid=self.sc.exptByLabel.get(m,m) )
262          table_utils.makeTab(self.sc, subset=lm[m], dest=self.xlsDest('m',olab,m), collected=cc[m], txt=self.doTxt, txtOpts=self.txtOpts )
263
264    if olab != None and makeTabs:
265        table_utils.makeTab(self.sc, subset=ss, dest=self.xlsDest('m',olab,'TOTAL'), collected=cct, txt=self.doTxt, txtOpts=self.txtOpts )
266        if olab != 'TOTAL' and doUnique:
267          table_utils.makeTab(self.sc, subset=s_lm, dest=self.xlsDest('m',olab,'Unique'), collected=s_cc, txt=self.doTxt, txtOpts=self.txtOpts )
268
269    cc = collections.defaultdict( dict )
270    ucc = collections.defaultdict( dict )
271    cct = collections.defaultdict( int )
272    for e,t in vet:
273      cc[e][t] = vet[(e,t) ]
274    for e in sorted( ve.keys() ):
275      if olab != None and makeTabs:
276        el = self.sc.dq.inx.uid[e].label
277
278        if useAccPdict:
279          pdict = collections.defaultdict( set )
280          for vid, p in self.accPdict[e]:
281               pdict[vid].add( p )
282             
283        elif olab in ['Total','TOTAL']:
284          pdict = None
285        elif (olab,el) in self.exptMipRql:
286          pdict = collections.defaultdict( set )
287          for rqlid in self.exptMipRql[(olab,el)]:
288             rql = self.sc.dq.inx.uid[rqlid]
289             for rqvid in self.sc.dq.inx.iref_by_sect[rql.refid].a['requestVar']:
290               rqv = self.sc.dq.inx.uid[rqvid]
291               pdict[rqv.vid].add( rqv.priority )
292               self.accPdict[e].add( (rqv.vid,rqv.priority) )
293        else:
294          print ( 'INFO.00201: olab,e not found:',olab,el )
295          pdict = None
296
297        tslice = {}
298        for v in self.sc.cmvts:
299          if e in self.sc.cmvts[v]:
300            tslice[v] = self.sc.cmvts[v][e]
301        dest = self.xlsDest('e',olab,el)
302        mode ='e'
303        table_utils.makeTab(self.sc, subset=lex[e], dest=self.xlsDest(mode,olab,el), collected=cc[e],byFreqRealm=self.tabByFreqRealm, tslice=tslice, exptUid=e, tabMode=mode, pdict=pdict, txt=self.doTxt, txtOpts=self.txtOpts )
304
305    if olab != 'TOTAL' and doUnique:
306      for e,t in s_vet:
307        ucc[e][t] = s_vet[(e,t) ]
308      for e in sorted( uve.keys() ):
309        if olab != None and makeTabs:
310          el = self.sc.dq.inx.uid[e].label
311          table_utils.makeTab(self.sc, subset=s_lex[e], dest=self.xlsDest('u',olab,el), collected=ucc[e], txt=self.doTxt, txtOpts=self.txtOpts)
312
313    self.res = { 'vmt':vmt, 'vet':vet, 'vm':vm, 'uve':uve, 've':ve, 'lm':lm, 'lex':lex, 'vu':vu, 'cc':cc, 'cct':cct, 'vf':vf}
314       
315  def csvFreqStrSummary(self,mip,pmax=1):
316    sf, c3 = self.sc.getFreqStrSummary(mip,pmax=pmax)
317    self.c3 = c3
318    self.pmax = pmax
319    lf = sorted( list(sf) )
320    hdr0 = ['','','','']
321    hdr1 = ['','','','']
322    for f in lf:
323      hdr0 += [f,'','','']
324      hdr1 += ['','','',str( self.npy.get( f, '****') )]
325    orecs = [hdr0,hdr1,]
326    crecs = [None,None,]
327    self.mvol = collections.defaultdict( dict )
328    self.rvol = dict()
329    ix = 3
330    for tt in sorted( c3.keys() ):
331      s,o,g = tt
332      i = self.sc.dq.inx.uid[ s ]
333      if o != '' and type(o) == type('x'):
334        msg = '%48.48s [%s]' % (i.title,o)
335      else:
336        msg = '%48.48s' % i.title
337      if g != 'native':
338        msg += '{%s}' % g
339      szg = self.sc.getStrSz( g, s=s, o=o )[1]
340      self.rvol[tt] = szg
341
342      rec = [msg,szg,2,'']
343      crec = ['','','','']
344      for f in lf:
345        if f in c3[tt]:
346            nn,ny,ne,labs,expts = c3[tt][f]
347            rec += [nn,ny,ne,'']
348            clabs = [self.sc.dq.inx.uid[x].label for x in labs.keys()]
349            crec += [sorted(clabs),'',expts,'']
350            if f.lower().find( 'clim' ) == -1:
351              assert abs( nn*ny - sum( [x for k,x in labs.items()] ) ) < .1, 'Inconsistency in year count: %s, %s, %s' % (str(tt),nn,ny)
352            if f == 'mon':
353              for k in labs:
354                self.mvol[tt][k] = labs[k]
355        else:
356            rec += ['','','','']
357            crec += ['','','','']
358      colr = xl_rowcol_to_cell(0, len(rec))
359      colr = colr[:-1]
360      eq = '$SUMPRODUCT(--(MOD(COLUMN(E%(ix)s:%(colr)s%(ix)s)-COLUMN(A%(ix)s)+1,4)=0),E%(ix)s:%(colr)s%(ix)s)' % {'ix':ix,'colr':colr}
361      ix += 1
362      rec[3] = eq
363      orecs.append( rec )
364      crecs.append( crec )
365   
366    return (orecs, crecs)
367
368  def byExpt(self):
369    for cmv in self.sc.selectedCmv.keys():
370      pass
371     
372  def run(self,mip='_all_',fn='test',pmax=1,doxlsx=True):
373    if mip == '_all_':
374      mip = set(self.sc.mips )
375    self.mip = mip
376    orecs, crecs = self.csvFreqStrSummary(mip,pmax=pmax)
377    if not doxlsx:
378      return
379    print ('INFO.volsum.01002: Writing %s.xlsx' % fn )
380    self.x = xlsx( fn )
381    self.sht = self.x.newSheet( 'Volume' )
382    oh = orecs[0]
383    self.sht.set_column(0,0,60)
384    self.sht.set_column(1,1,15)
385    self.sht.set_column(2,2,4)
386    self.sht.set_column(3,3,15)
387    for k in range( int( (len(oh)-3)/4 ) ):
388      self.sht.set_column((k+1)*4,(k+1)*4,4)
389      self.sht.set_column((k+1)*4+1,(k+1)*4+1,8)
390      self.sht.set_column((k+1)*4+2,(k+1)*4+2,4)
391      self.sht.set_column((k+1)*4+3,(k+1)*4+3,12)
392     
393    oo = []
394    for i in range( len(oh) ):
395      oo.append( '' )
396    kk = 0
397    rr1 = 2
398    rr1p = rr1 + 1
399    for ix in range(len(orecs)):
400      o = orecs[ix]
401      kk += 1
402      if kk > 2:
403        for i in range( 7,len(o),4):
404          frq = oh[i-3]
405         
406          cell = xl_rowcol_to_cell(0, i)[:-1]
407          ca = xl_rowcol_to_cell(0, i-3)[:-1]
408          ##if frq.lower().find( 'clim' ) == -1:
409          cb = xl_rowcol_to_cell(0, i-2)[:-1]
410          ##else:
411          ##cb = xl_rowcol_to_cell(0, i-1)[:-1]
412          eq = '$%(cell)s$%(rr1)s*%(cb)s%(kk)s*%(ca)s%(kk)s*$B%(kk)s*$C%(kk)s*0.000000001' % locals()
413          o[i] = eq
414        self.x.tabrec(kk-1, o )
415        if crecs[ix] != None:
416          crec = crecs[ix]
417          for j in range(len(crec)):
418            if crec[j] != '':
419              self.sht.write_comment( kk-1, j, ' '.join( crec[j] ) )
420      else:
421        if kk == 1:
422          for i in range( 4,len(o),4):
423            cell = xl_rowcol_to_cell(0, i)[:-1]
424            cell2 = xl_rowcol_to_cell(0, i+3)[:-1]
425            self.sht.merge_range('%s1:%s1' % (cell,cell2), 'Merged Range')
426        self.x.tabrec(kk-1, o )
427
428    n = len(orecs)
429    for i in range( 3,len(oo),4):
430      cell = xl_rowcol_to_cell(0, i)[:-1]
431      oo[i] = '$SUM(%(cell)s%(rr1p)s:%(cell)s%(n)s)*0.001' % locals()
432    for i in range( 5,len(oo),4):
433      oo[i] = oh[i-1]
434    oo[0] = 'TOTAL VOLUME (Tb)'
435    self.x.tabrec(kk, oo )
436
437    n += 2
438    for a,b in self.infoRows:
439       self.sht.merge_range('B%s:H%s' % (n+1,n+1), 'Merged Range')
440       self.sht.write( n,0, a )
441       self.sht.write( n,1, b )
442       n += 1
443
444    self.x.close()
Note: See TracBrowser for help on using the repository browser.