source: CMIP6dreq/trunk/dreqPy/volsum.py @ 886

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

release cand

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