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

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

candidate

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