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

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

release candidate

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=None,tables=None,exptFilter=None, odir='xls', tabByFreqRealm=False):
47    self.tabByFreqRealm = tabByFreqRealm
48    self.makeTab = makeTab
49    self.mt_tables = 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,makeTabs=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
94      self.rres = {}
95   
96      for m in theseMips:
97        olab = m
98        if m == '*TOTAL':
99            thism = theseMips.copy()
100            if type( thism ) == type( set() ):
101              thism.remove( '*TOTAL' )
102            else:
103              thism.pop( '*TOTAL' )
104            olab = misc_utils.setMlab( thism )
105        elif type( theseMips ) == type( dict() ):
106            thism = {m:theseMips[m]}
107        else:
108            thism = m
109
110        if m != 'TOTAL' and 'TOTAL' in theseMips:
111          cmv1, cmvts = self.sc.cmvByInvMip(thism,pmax=pmax,includeYears=True)
112          self.uniqueCmv = self.sc.differenceSelectedCmvDict(  cmv1, cmvTotal )
113
114        self.run( thism, '%s/requestVol_%s_%s_%s' % (self.odir,olab,self.sc.tierMax,pmax), pmax=pmax,doxlsx=makeTabs )
115
116        self.anal(olab=olab,doUnique='TOTAL' in theseMips, makeTabs=makeTabs)
117        ttl = sum( [x for k,x in self.res['vu'].items()] )*2.*1.e-12
118        volsmm[m] = self.res['vm']
119        volsmmt[m] = self.res['vmt']
120        volsme[m] = self.res['ve']
121        volsue[m] = self.res['uve']
122        self.rres[m] = self.res['vf'].copy()
123        if m == 'TOTAL':
124          cmvTotal = self.sc.selectedCmv.copy()
125          self.uniqueCmv =  {}
126      if html:
127        r1 = overviewTabs.r1( self.sc, self.mt_tables, pmax=pmax, vols=( volsmm, volsme, volsmmt,volsue ) )
128
129  def _analSelectedCmv(self,cmv):
130    lex = collections.defaultdict( list )
131    vet = collections.defaultdict( int )
132    vf = collections.defaultdict( int )
133    vu = collections.defaultdict( float )
134    mvol = collections.defaultdict( dict )
135
136    for u in cmv:
137      i = self.sc.dq.inx.uid[u]
138      if i._h.label != 'remarks':
139        npy = self.npy[ i.frequency ]
140        isClim = i.frequency.lower().find( 'clim' ) != -1
141        st = self.sc.dq.inx.uid[i.stid]
142        c1 = 0
143        for e,g in cmv[u]:
144          ee = self.sc.dq.inx.uid[e]
145          if ee.mip not in ['SolarMIP']:
146            lex[e].append( u )
147            t1, tt = self.sc.getStrSz( g, stid=i.stid, tt=True, cmv=u )
148            np = t1[1]*npy
149            if not isClim:
150              np = np*cmv[u][(e,g)]
151            c1 += cmv[u][(e,g)]
152            vet[(e,i.mipTable)] += np
153            vf[i.frequency] += np
154            vu[u] += np
155          else:
156            print ('ERROR.obsoleteMip.00001: %s,%s,%s' % (ee.mip,ee.label,ee.uid) )
157        if i.frequency == 'mon':
158            mvol[tt][u] = c1
159
160    return dict(lex), dict(vet), dict(vf), dict(vu), dict(mvol)
161
162  def xlsDest(self,mode,olab,lab2):
163    if mode == 'e':
164      return '%s/%s_%s_%s_%s_%s%s' % (self.odir,self.xlsPrefixE,olab,lab2,self.sc.tierMax,self.pmax,self.efnsfx)
165    elif mode == 'u':
166      return '%s/%s_%s_%s_%s_%s%s' % (self.odir,self.xlsPrefixU,olab,lab2,self.sc.tierMax,self.pmax,self.efnsfx)
167    else:
168      return '%s/%s_%s_%s_%s_%s%s' % (self.odir,self.xlsPrefixM,olab,lab2,self.sc.tierMax,self.pmax,self.efnsfx)
169
170  def anal(self,olab=None,doUnique=False,makeTabs=False,mode='full'):
171    vmt = collections.defaultdict( int )
172    vm = collections.defaultdict( int )
173    ve = collections.defaultdict( int )
174    uve = collections.defaultdict( int )
175    lm = collections.defaultdict( set )
176
177    lex, vet, vf, vu, mvol = self._analSelectedCmv(self.sc.selectedCmv )
178    if mode == 'short':
179      self.res = { 'vet':vet,  'lex':lex, 'vu':vu, 'vf':vf}
180      return
181    if olab != 'TOTAL' and doUnique:
182      s_lex, s_vet, s_vf, s_vu, s_mvol = self._analSelectedCmv(self.uniqueCmv )
183      s_lm = set( self.uniqueCmv.keys() )
184      s_cc = collections.defaultdict( int )
185      for e,t in s_vet:
186        s_cc[t] += s_vet[(e,t)]
187        vm['Unique'] += s_vet[(e,t)]
188        vmt[('Unique',t)] += s_vet[(e,t)]
189        uve[e] += s_vet[(e,t)]
190
191    checkMvol = -1
192    if checkMvol > 0:
193      for k in mvol:
194        sp = self.sc.dq.inx.uid[k[0]]
195        if k not in self.mvol:
196          print ( '%s missing from mvol: ' % str(k) )
197        else:
198          if checkMvol > 1:
199            for u in mvol[k]:
200              la = self.sc.dq.inx.uid[u].label
201              if self.mvol[k][u] != mvol[k][u]:
202                print ( 'MISMATCH IN %s (%s): %s:: %s,%s' % (str(k),sp.label,la,mvol[k][u],self.mvol[k][u]) )
203         
204    for e in lex:
205      ee = self.sc.dq.inx.uid[e]
206      for i in lex[e]:
207        lm[ee.mip].add( i )
208
209    for e,t in vet:
210      ee = self.sc.dq.inx.uid[e]
211      vmt[(ee.mip,t)] += vet[(e,t)]
212      vm[ee.mip] += vet[(e,t)]
213      ve[e] += vet[(e,t)]
214
215##
216## makeTab needs: cc[m]: volume summary, by table,   lm[m]: list of CMOR variables
217##
218    cc = collections.defaultdict( dict )
219    cct = collections.defaultdict( int )
220    for m,t in vmt:
221      cc[m][t] = vmt[(m,t) ]
222    ss = set()
223    for m in sorted( vm.keys() ):
224      if olab != None:
225        for t in cc[m]:
226          cct[t] += cc[m][t]
227        ss = ss.union( lm[m] )
228        if makeTabs:
229          self.makeTab(self.sc.dq, subset=lm[m], dest=self.xlsDest('m',olab,m), collected=cc[m])
230
231    if olab != None and makeTabs:
232        self.makeTab(self.sc.dq, subset=ss, dest=self.xlsDest('m',olab,'TOTAL'), collected=cct)
233        if olab != 'TOTAL' and doUnique:
234          self.makeTab(self.sc.dq, subset=s_lm, dest=self.xlsDest('m',olab,'Unique'), collected=s_cc)
235
236    cc = collections.defaultdict( dict )
237    ucc = collections.defaultdict( dict )
238    cct = collections.defaultdict( int )
239    for e,t in vet:
240      cc[e][t] = vet[(e,t) ]
241    for e in sorted( ve.keys() ):
242      if olab != None and makeTabs:
243        el = self.sc.dq.inx.uid[e].label
244        tslice = {}
245        for v in self.sc.cmvts:
246          if e in self.sc.cmvts[v]:
247            tslice[v] = self.sc.cmvts[v][e]
248        dest = self.xlsDest('e',olab,el)
249        self.makeTab(self.sc.dq, subset=lex[e], dest=self.xlsDest('e',olab,el), collected=cc[e],byFreqRealm=self.tabByFreqRealm, tslice=tslice)
250        ##self.makeTab(self.sc.dq, subset=lex[e], dest=self.xlsDest('e',olab,el), collected=cc[e],byFreqRealm=self.tabByFreqRealm)
251
252    if olab != 'TOTAL' and doUnique:
253      for e,t in s_vet:
254        ucc[e][t] = s_vet[(e,t) ]
255      for e in sorted( uve.keys() ):
256        if olab != None and makeTabs:
257          el = self.sc.dq.inx.uid[e].label
258          self.makeTab(self.sc.dq, subset=s_lex[e], dest=self.xlsDest('u',olab,el), collected=ucc[e])
259
260    self.res = { 'vmt':vmt, 'vet':vet, 'vm':vm, 'uve':uve, 've':ve, 'lm':lm, 'lex':lex, 'vu':vu, 'cc':cc, 'cct':cct, 'vf':vf}
261       
262  def csvFreqStrSummary(self,mip,pmax=1):
263    sf, c3 = self.sc.getFreqStrSummary(mip,pmax=pmax)
264    self.c3 = c3
265    self.pmax = pmax
266    lf = sorted( list(sf) )
267    hdr0 = ['','','','']
268    hdr1 = ['','','','']
269    for f in lf:
270      hdr0 += [f,'','','']
271      hdr1 += ['','','',str( self.npy.get( f, '****') )]
272    orecs = [hdr0,hdr1,]
273    crecs = [None,None,]
274    self.mvol = collections.defaultdict( dict )
275    self.rvol = dict()
276    ix = 3
277    for tt in sorted( c3.keys() ):
278      s,o,g = tt
279      i = self.sc.dq.inx.uid[ s ]
280      if o != '':
281        msg = '%48.48s [%s]' % (i.title,o)
282      else:
283        msg = '%48.48s' % i.title
284      if g != 'native':
285        msg += '{%s}' % g
286      szg = self.sc.getStrSz( g, s=s, o=o )[1]
287      self.rvol[tt] = szg
288
289      rec = [msg,szg,2,'']
290      crec = ['','','','']
291      for f in lf:
292        if f in c3[tt]:
293            nn,ny,ne,labs,expts = c3[tt][f]
294            rec += [nn,ny,ne,'']
295            clabs = [self.sc.dq.inx.uid[x].label for x in labs.keys()]
296            crec += [sorted(clabs),'',expts,'']
297            if f.lower().find( 'clim' ) == -1:
298              assert abs( nn*ny - sum( [x for k,x in labs.items()] ) ) < .1, 'Inconsistency in year count: %s, %s, %s' % (str(tt),nn,ny)
299            if f == 'mon':
300              for k in labs:
301                self.mvol[tt][k] = labs[k]
302        else:
303            rec += ['','','','']
304            crec += ['','','','']
305      colr = xl_rowcol_to_cell(0, len(rec))
306      colr = colr[:-1]
307      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}
308      ix += 1
309      rec[3] = eq
310      orecs.append( rec )
311      crecs.append( crec )
312   
313    return (orecs, crecs)
314
315  def byExpt(self):
316    for cmv in self.sc.selectedCmv.keys():
317      pass
318     
319  def run(self,mip='_all_',fn='test',pmax=1,doxlsx=True):
320    if mip == '_all_':
321      mip = set(self.sc.mips )
322    self.mip = mip
323    orecs, crecs = self.csvFreqStrSummary(mip,pmax=pmax)
324    print 'csvFreqStrSummary: %s, %s: %s, %s' % (str(mip),pmax,len(orecs),len(crecs))
325    if not doxlsx:
326      return
327    print ('Writing %s' % fn )
328    self.x = xlsx( fn )
329    self.sht = self.x.newSheet( 'Volume' )
330    oh = orecs[0]
331    self.sht.set_column(0,0,60)
332    self.sht.set_column(1,1,15)
333    self.sht.set_column(2,2,4)
334    self.sht.set_column(3,3,15)
335    for k in range( int( (len(oh)-3)/4 ) ):
336      self.sht.set_column((k+1)*4,(k+1)*4,4)
337      self.sht.set_column((k+1)*4+1,(k+1)*4+1,8)
338      self.sht.set_column((k+1)*4+2,(k+1)*4+2,4)
339      self.sht.set_column((k+1)*4+3,(k+1)*4+3,12)
340     
341    oo = []
342    for i in range( len(oh) ):
343      oo.append( '' )
344    kk = 0
345    rr1 = 2
346    rr1p = rr1 + 1
347    for ix in range(len(orecs)):
348      o = orecs[ix]
349      kk += 1
350      if kk > 2:
351        for i in range( 7,len(o),4):
352          frq = oh[i-3]
353         
354          cell = xl_rowcol_to_cell(0, i)[:-1]
355          ca = xl_rowcol_to_cell(0, i-3)[:-1]
356          ##if frq.lower().find( 'clim' ) == -1:
357          cb = xl_rowcol_to_cell(0, i-2)[:-1]
358          ##else:
359          ##cb = xl_rowcol_to_cell(0, i-1)[:-1]
360          eq = '$%(cell)s$%(rr1)s*%(cb)s%(kk)s*%(ca)s%(kk)s*$B%(kk)s*$C%(kk)s*0.000000001' % locals()
361          o[i] = eq
362        self.x.tabrec(kk-1, o )
363        if crecs[ix] != None:
364          crec = crecs[ix]
365          for j in range(len(crec)):
366            if crec[j] != '':
367              self.sht.write_comment( kk-1, j, ' '.join( crec[j] ) )
368      else:
369        if kk == 1:
370          for i in range( 4,len(o),4):
371            cell = xl_rowcol_to_cell(0, i)[:-1]
372            cell2 = xl_rowcol_to_cell(0, i+3)[:-1]
373            self.sht.merge_range('%s1:%s1' % (cell,cell2), 'Merged Range')
374        self.x.tabrec(kk-1, o )
375
376    n = len(orecs)
377    for i in range( 3,len(oo),4):
378      cell = xl_rowcol_to_cell(0, i)[:-1]
379      oo[i] = '$SUM(%(cell)s%(rr1p)s:%(cell)s%(n)s)*0.001' % locals()
380    for i in range( 5,len(oo),4):
381      oo[i] = oh[i-1]
382    oo[0] = 'TOTAL VOLUME (Tb)'
383    self.x.tabrec(kk, oo )
384
385    n += 2
386    for a,b in self.infoRows:
387       self.sht.merge_range('B%s:H%s' % (n+1,n+1), 'Merged Range')
388       self.sht.write( n,0, a )
389       self.sht.write( n,1, b )
390       n += 1
391
392    self.x.close()
Note: See TracBrowser for help on using the repository browser.