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

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

further import corrections

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