source: CCCC/trunk/ceda_cc/config_c4.py @ 298

Subversion URL: http://proj.badc.rl.ac.uk/svn/exarch/CCCC/trunk/ceda_cc/config_c4.py@298
Revision 298, 25.4 KB checked in by astephen, 7 years ago (diff)

added activity to json record for ESA-CCI

Line 
1import string
2import utils_c4 as utils
3import os
4import os.path as op
5import shutil, collections
6from versionConfig import version, versionComment
7
8NT_project = collections.namedtuple( 'project', ['id','v'] )
9NT_fnParts = collections.namedtuple( 'fnParts', ['len','fxLen','unfLen','checkTLen','ixDomain','ixFreq'] )
10
11##############################################################################
12# Configure config-file paths
13#
14# All configuration directories, e.g. cmip5_vocabs, are looked for in a single
15# parent directory.  This is the "config" directory within the package unless
16# the environment variable CC_CONFIG_DIR is set.
17
18HERE = op.dirname(__file__)
19CC_CONFIG_DEFAULT_DIR = op.join(HERE, 'config')
20CC_CONFIG_DIR = os.environ.get('CC_CONFIG_DIR', CC_CONFIG_DEFAULT_DIR)
21
22##############################################################################
23
24validCmip5Experiments = ['1pctCO2', 'abrupt4xCO2', 'amip', 'amip4K', 'amip4xCO2', 'amipFuture', 'aqua4K', 'aqua4xCO2', 'aquaControl', 'decadal1959', 'decadal1960', 'decadal1961', 'decadal1962', 'decadal1963', 'decadal1964', 'decadal1965', 'decadal1966', 'decadal1967', 'decadal1968', 'decadal1969', 'decadal1970', 'decadal1971', 'decadal1972', 'decadal1973', 'decadal1974', 'decadal1975', 'decadal1976', 'decadal1977', 'decadal1978', 'decadal1979', 'decadal1980', 'decadal1981', 'decadal1982', 'decadal1983', 'decadal1984', 'decadal1985', 'decadal1986', 'decadal1987', 'decadal1988', 'decadal1989', 'decadal1990', 'decadal1991', 'decadal1992', 'decadal1993', 'decadal1994', 'decadal1995', 'decadal1996', 'decadal1997', 'decadal1998', 'decadal1999', 'decadal2000', 'decadal2001', 'decadal2002', 'decadal2003', 'decadal2004', 'decadal2005', 'decadal2006', 'decadal2007', 'decadal2008', 'decadal2009', 'decadal2010', 'decadal2011', 'decadal2012', 'esmControl', 'esmFdbk1', 'esmFdbk2', 'esmFixClim1', 'esmFixClim2', 'esmHistorical', 'esmrcp85', 'historical', 'historicalExt', 'historicalGHG', 'historicalMisc', 'historicalNat', 'lgm', 'midHolocene', 'noVolc1960', 'noVolc1965', 'noVolc1970', 'noVolc1975', 'noVolc1980', 'noVolc1985', 'noVolc1990', 'noVolc1995', 'noVolc2000', 'noVolc2005', 'past1000', 'piControl', 'rcp26', 'rcp45', 'rcp60', 'rcp85', 'sst2020', 'sst2030', 'sst2090', 'sst2090rcp45', 'sstClim', 'sstClim4xCO2', 'sstClimAerosol', 'sstClimSulfate', 'volcIn2010']
25
26validCordexExperiment = validCmip5Experiments + ['evaluation']
27
28
29validCmip5Frequencies = ['fx','yr','monClim','mon','day','6hr','3hr','subhr']
30validCordexFrequencies = ['fx','sem','mon','day','6hr','3hr']
31validSpecsFrequencies = ['fx','mon','day','6hr']
32validCcmiFrequencies = ['fx','yr','mon','day','hr','subhr']
33validSpecsExptFamilies = map( lambda x: string.strip( x ), 
34                              open( op.join(CC_CONFIG_DIR, 'specs_vocabs/exptFamily.txt' )).readlines() )
35
36validCordexDomainsL = [ 'SAM-44', 'CAM-44', 'NAM-44', 'EUR-44', 'AFR-44', 'WAS-44', 'EAS-44', 'CAS-44', 'AUS-44', 'ANT-44', 'ARC-44', 'MED-44']
37validCordexDomainsLi = map( lambda x: x + 'i', validCordexDomainsL )
38validCordexDomainsH = ['EUR-11']
39validCordexDomains = validCordexDomainsL + validCordexDomainsLi + validCordexDomainsH
40
41plevRequired = ['clh', 'clm', 'cll', 'ua850', 'va850', 'ta850', 'hus850', 'ua500', 'va500', 'ta500', 'zg500', 'ua200', 'va200', 'ta200', 'zg200']
42plevBndsRequired = ['clh', 'clm', 'cll']
43heightRequired = ['tas','tasmax','tasmin','huss','sfcWind','sfcWindmax','wsgsmax','uas','vas']
44
45
46ii = open( op.join(CC_CONFIG_DIR, 'cordex_vocabs/GCMModelName.txt' )).readlines()
47validGcmNames = []
48for l in ii:
49  if l[0] != '#' and len( string.strip(l) ) > 0:
50    validGcmNames.append( string.split(l)[0] )
51
52ii = open( op.join(CC_CONFIG_DIR, 'cordex_vocabs/RCMModelName.txt' )).readlines()
53validRcmNames = []
54validInstNames = []
55for l in ii:
56  if l[0] != '#' and len( string.strip(l) ) > 0:
57    bits = string.split(l)
58    validRcmNames.append( bits[0] )
59    validInstNames.append( bits[1] )
60
61plevValues = {'clh':22000, 'clm':56000, 'cll':84000}
62for i in [200,500,850]:
63  for v in ['zg','ua', 'va', 'ta', 'hus']:
64    k = '%s%s' % (v,i)
65    plevValues[k] = i*100
66
67heightRequired = ['tas', 'tasmax', 'tasmin', 'huss', 'sfcWind', 'sfcWindmax', 'wsgsmax', 'uas', 'vas']
68heightValues = {}
69heightRange = {}
70for v in heightRequired:
71  if v in ['tas', 'tasmax', 'tasmin', 'huss']:
72    heightValues[v] = 2
73  else:
74    heightValues[v] = 10
75  heightRange[v] = (1.5,10.)
76
77ii = open( op.join(CC_CONFIG_DIR, 'cordex_vocabs/cordex_domains.csv' )).readlines()
78keys = ['name','tag','res','grid_np_lon','grid_np_lat','nlon','nlat','w','e','s','n']
79rotatedPoleGrids = {}
80for l in ii[2:16]:
81  bits = string.split(string.strip(l),',')
82  ee = {}
83  i = 0
84  for k in keys:
85    if k in ['nlon','nlat']:
86      ee[k] = int(bits[i])
87    elif k in ['grid_np_lon','grid_np_lat','w','e','s','n','res']:
88      if bits[i] != 'N/A':
89        ee[k] = float(bits[i])
90      else:
91        ee[k] = bits[i]
92    else:
93      ee[k] = bits[i]
94    i += 1
95    rotatedPoleGrids[bits[1]] = ee
96
97##Area,Name, deg,Nlon,Nlat,West8,East8,South8,North8,
98keys = ['name','tag','res','nlon','nlat','w','e','s','n']
99interpolatedGrids = {}
100for l in ii[18:33]:
101  bits = string.split(string.strip(l),',')
102  ee = {}
103  i = 0
104  for k in keys:
105    if k in ['nlon','nlat']:
106      ee[k] = int(bits[i])
107    elif k in ['w','e','s','n','res']:
108        ee[k] = float(bits[i])
109    else:
110      ee[k] = bits[i]
111    i += 1
112    interpolatedGrids[bits[1]] = ee
113
114class readVocab(object):
115
116  def __init__(self,dir):
117    self.dir = dir
118
119  def driver(self,tt):
120    if tt[0] == "simpleList":
121      tx = tt + (None,None,None,None)
122      return self.getSimpleList( tx[1],bit=tx[2],omt=tx[3],options=tx[4] )
123    else:
124      print 'readVocab.driver: option %s not recgnised' % tt[0]
125
126  def getEvalAssign(self, file ):
127    ii = open('%s/%s/%s' % (CC_CONFIG_DIR, self.dir,file) )
128    ll = []
129    for l in ii.readlines():
130      if l[0] != '#':
131        ll.append( l )
132    assert len(ll) == 1, 'Too many lines in %s' % file 
133    try:
134      return eval( ll[0] )
135    except:
136      print 'Failed to evaluate configuration line from %s:\n%s' % (file,l[0])
137      raise
138
139  def getSimpleList(self,file,bit=None,omt=None,options=None):
140    ii = open('%s/%s/%s' % (CC_CONFIG_DIR, self.dir,file) )
141    oo = []
142    if options == None:
143      olist = []
144    else:
145      olist = string.split(options,',')
146
147    if 'returnMappings' in olist:
148      assert bit in [0, -1], 'only support returnMappings for bit = -1 or 0'
149      ee = {}
150
151    for l in ii.readlines():
152      if l[0] != '#':
153        ll = string.strip(l)
154        if omt == 'last':
155          oo.append(string.join(string.split(ll)[:-1]))
156        elif bit == None:
157          oo.append(ll)
158        else:
159          if 'returnMappings' in olist:
160            bb = string.split(ll)
161            if bit == -1:
162              ee[bb[-1]] = string.join( bb[:-1] )
163            else:
164              ee[bb[0]] = string.join( bb[1:] )
165            oo.append( bb[bit] )
166          else:
167            oo.append(string.split(ll)[bit])
168
169    if 'noneMap' in olist:
170      oo = map( lambda x: {'None':None}.get(x,x), oo )
171
172    if 'returnMappings' in olist:
173      return oo, ee
174    else:
175      return oo
176
177validSpecsInstitutions = ['IC3', 'MPI-M', 'KNMI', 'UOXF', 'CNRM-CERFACS', 'ENEA', 'MOHC', 'SMHI', 'IPSL', 'UREAD', 'ECWMF']
178
179class projectConfig(object):
180
181  def __init__(self, project, version=-1):
182    knownProjects = ['CMIP5','CCMI','CORDEX','SPECS','ESA-CCI', '__dummy']
183    assert project in knownProjects, 'Project %s not in knownProjects %s' % (project, str(knownProjects))
184
185    self.project = project
186    self.fNameSep = '_'
187    self.varIndex = 0
188    self.fnvdict = None
189    self.varTables='CMIP'
190    self.checkVarType = True
191    self.projectV = NT_project(project,version)
192    self.gridSpecTol = 0.01
193## default encoding of time range in file names: YYYY[MM[DD[HH]]]-YYYY[MM[DD[HH]]]
194    self.trangeType = 'CMIP'
195    self.controlledFnParts = []
196    if project == 'CORDEX':
197      self.requiredGlobalAttributes = [ 'institute_id', 'contact', 'rcm_version_id', 'product', 'CORDEX_domain', 'creation_date', \
198             'frequency', 'model_id', 'driving_model_id', 'driving_experiment', 'driving_model_ensemble_member', 'experiment_id']
199      self.controlledGlobalAttributes = ['frequency', 'driving_experiment_name', 'project_id', 'CORDEX_domain', 'driving_model_id', 'model_id', 'institute_id','driving_model_ensemble_member','rcm_version_id']
200      self.globalAttributesInFn = [None,'CORDEX_domain','driving_model_id','experiment_id','driving_model_ensemble_member','model_id','rcm_version_id']
201      self.requiredVarAttributes = ['long_name', 'standard_name', 'units']
202      self.drsMappings = {'variable':'@var','institute':'institute_id', 'product':'product', 'experiment':'experiment_id', \
203                        'ensemble':'driving_model_ensemble_member', 'model':'model_id', 'driving_model':'driving_model_id', \
204                        'frequency':'frequency', \
205                        'project':'project_id', 'domain':'CORDEX_domain', 'model_version':'rcm_version_id' }
206
207    elif project == 'SPECS':
208      lrdr = readVocab( 'specs_vocabs/')
209      self.requiredGlobalAttributes = lrdr.driver( ('simpleList', 'globalAts.txt' ) )
210      self.exptFamilies = lrdr.driver( ('simpleList', 'exptFamily.txt', 0 ) )
211      self.controlledGlobalAttributes = lrdr.driver( ('simpleList', 'controlledGlobalAttributes_sv0101.txt' ) )
212                       ##'initialization_method','physics_version','realization']
213      self.globalAttributesInFn = lrdr.driver( ('simpleList', 'globalAttributesInFn_sv0101.txt',0,0,'noneMap' ) )
214      self.requiredVarAttributes = ['long_name', 'standard_name', 'units']
215      oo, self.drsMappings = lrdr.driver( ('simpleList', 'drsMappings_sv0101.txt',0,0,'returnMappings' ) )
216
217      ##self.drsMappings = {'variable':'@var', 'institute':'institute_id', 'product':'product', 'experiment':'experiment_id', \
218                        ##'ensemble':'@ensemble', 'model':'model_id', 'realm':'modeling_realm', \
219                        ##'frequency':'frequency', 'start_date':'@forecast_reference_time', \
220                        ##'table':'@mip_id',
221                        ##'project':'project_id'}
222
223    elif project == 'CMIP5':
224      lrdr = readVocab( 'cmip5_vocabs/')
225      self.requiredGlobalAttributes = [ 'contact', 'product', 'creation_date', 'tracking_id', \
226              'experiment_id']
227      ##self.requiredGlobalAttributes = lrdr.getSimpleList( 'globalAts.txt' )
228      self.controlledGlobalAttributes = [ 'project_id','experiment_id', 'frequency','Conventions','modeling_realm', \
229                       'initialization_method','physics_version','realization']
230      self.globalAttributesInFn = [None,'@mip_id','model_id','experiment_id','@ensemble']
231#sic_Oimon_EC-Earth2_seaIceBestInit_S19910501_series1_r1i1p1_199501-199502.nc
232## mip_id derived from global attribute Table_id (CMOR convention); experiment family derived from experiment_id, ensemble derived from rip attributes.
233      self.requiredVarAttributes = ['long_name', 'standard_name', 'units']
234## key: DRS element name, value: global attribute name or tag for mapping from file information ("@....").
235      self.drsMappings = {'variable':'@var', 'institute':'institute_id', 'product':'product', 'experiment':'experiment_id', \
236                        'ensemble':'@ensemble', 'model':'model_id', 'realm':'modeling_realm', \
237                        'frequency':'frequency',  'table':'@mip_id',
238                        'project':'project_id'}
239
240    elif project == 'CCMI':
241      lrdr = readVocab( 'ccmi_vocabs/')
242      self.requiredGlobalAttributes = [ 'creation_date', 'tracking_id', 'forcing', 'model_id', 'parent_experiment_id', 'parent_experiment_rip', 'branch_time', 'contact', 'institute_id' ]
243      self.requiredGlobalAttributes = lrdr.getSimpleList( 'globalAts.txt', bit=0 )
244      self.controlledGlobalAttributes = [ 'experiment_id', 'project', 'frequency' ]
245      self.globalAttributesInFn = [None,'@mip_id','model_id','experiment_id','@ensemble']
246      self.requiredVarAttributes = ['long_name', 'units']
247      self.drsMappings = {'variable':'@var', 'institute':'institute_id', 'product':'product', 'experiment':'experiment_id', \
248                        'ensemble':'@ensemble', 'model':'model_id', 'realm':'modeling_realm', \
249                        'frequency':'frequency',  'table':'@mip_id',
250                        'project':'project_id'}
251
252    elif project == 'ESA-CCI':
253      lrdr = readVocab( 'esacci_vocabs/')
254      self.varTables='FLAT'
255      self.fNameSep = '-'
256      self.checkVarType = False
257      self.requiredGlobalAttributes = lrdr.getSimpleList( 'requiredGlobalAts.txt', bit=0 )
258      self.controlledGlobalAttributes = ['platform','sensor','project','Conventions','institution','cdm_data_type','time_coverage_duration','spatial_resolution' ]
259      self.controlledFnParts = ['level','cciProject','var','version']
260      self.requiredVarAttributes = ['long_name', 'standard_name', 'units']
261      self.drsMappings = {'variable':'#var','platform':'platform','sensor':'sensor','level':'#level', \
262                'standard_name':'*standard_name', \
263                'activity':'=CLIPC', \
264                'algorithm':'$algorithm:unset', 'frequency':'$frequency', \
265                'spatial_resolution':'spatial_resolution', 'ecv':'@ecv','version':'#version','convention_version':'#gdsv'}
266      self.globalAttributesInFn = [None,]
267    elif project == '__dummy':
268      self.requiredGlobalAttributes = map( lambda x: 'ga%s' % x, range(10) )
269      self.controlledGlobalAttributes = [ ]
270      self.globalAttributesInFn = [None,'ga2', 'ga3', 'ga4' ]
271      self.requiredVarAttributes = ['long_name', 'standard_name', 'units']
272      self.drsMappings = {'variable':'@var'}
273
274####### used in checkStandardDims
275
276    self.plevRequired = plevRequired
277    self.plevValues = plevValues
278    self.heightRequired = heightRequired
279    self.heightValues = heightValues
280    self.heightRange = heightRange
281
282####### used in checkGrids
283    self.rotatedPoleGrids = rotatedPoleGrids
284    self.interpolatedGrids = interpolatedGrids
285    self.doCheckGrids = self.projectV.id in ['CORDEX',]
286
287####### used in checkFileName (freqIndex also used in checkByVar)
288
289    if self.projectV.id == 'CORDEX':
290      self.fnParts = NT_fnParts( len=[8,9], fxLen=[8,],  unfLen=[9,], checkTLen=True, ixDomain=1, ixFreq=7 )
291    elif self.projectV.id == 'CMIP5':
292      self.fnParts = NT_fnParts( len=[5,6], fxLen=[5,],  unfLen=[6,], checkTLen=False, ixDomain=None, ixFreq=None )
293    elif self.projectV.id == 'SPECS':
294      self.fnParts = lrdr.getEvalAssign( 'fnParts_sv0101.txt' )
295    elif self.projectV.id == 'CCMI':
296      self.fnParts = NT_fnParts( len=[5,6], fxLen=[5,],  unfLen=[6,], checkTLen=False, ixDomain=None, ixFreq=None )
297    elif self.projectV.id == 'ESA-CCI':
298      self.fnParts = NT_fnParts( len=[7,8,9], fxLen=[0,],  unfLen=[7,8,9,], checkTLen=False, ixDomain=None, ixFreq=1 )
299      self.trangeType = 'ESA-CCI'
300    elif self.projectV.id == '__dummy':
301      self.fnParts = NT_fnParts( len=[4,5], fxLen=[4,],  unfLen=[5,], checkTLen=False, ixDomain=None, ixFreq=1 )
302
303    self.fnPartsOkLen = self.fnParts.len
304    self.fnPartsOkFixedLen = self.fnParts.fxLen
305    self.fnPartsOkUnfixedLen = self.fnParts.unfLen
306    self.checkTrangeLen = self.fnParts.checkTLen
307    self.domainIndex = self.fnParts.ixDomain
308    self.freqIndex = self.fnParts.ixFreq
309
310
311    self.defaults = { 'variableDataType':'float' }
312######## used in mipVocabs
313    if self.projectV.id == 'CORDEX':
314       self.mipVocabDir = op.join(CC_CONFIG_DIR, 'cordex_vocabs/mip/')
315       self.mipVocabTl = ['fx','sem','mon','day','6h','3h']
316       self.mipVocabVgmap = {'6h':'6hr','3h':'3hr'}
317       self.mipVocabFnpat = 'CORDEX_%s'
318    elif self.projectV.id == 'CMIP5':
319       self.mipVocabDir = op.join(CC_CONFIG_DIR, 'cmip5_vocabs/mip/')
320       self.mipVocabTl = ['fx','Oyr','Oclim','Omon','Amon','Lmon','LImon','OImon','cfMon','aero','cfDay','day','cfOff','cfSites','6hrLev','6hrPlev','3hr','cf3hr']
321       self.mipVocabVgmap = {}
322       self.mipVocabFnpat = 'CMIP5_%s'
323       self.defaults['variableDataType'] = None 
324    elif self.projectV.id == 'SPECS':
325       self.mipVocabDir = op.join(CC_CONFIG_DIR, 'specs_vocabs/mip/')
326       self.mipVocabTl = ['fx','Omon','Amon','Lmon','OImon','day','6hr']
327       self.mipVocabVgmap = {}
328       self.mipVocabFnpat = 'SPECS_%s'
329    elif self.projectV.id == 'CCMI':
330       self.mipVocabDir = op.join(CC_CONFIG_DIR, 'ccmi_vocabs/mip/')
331       self.mipVocabTl = ['fixed','annual','monthly','daily','hourly']
332       self.mipVocabVgmap = {'fixed':'fx','annual':'yr','monthly':'mon','daily':'day','hourly':'hr'}
333       self.mipVocabFnpat = 'CCMI1_%s'
334    elif self.projectV.id == 'ESA-CCI':
335       self.mipVocabDir = op.join(CC_CONFIG_DIR, 'esacci_vocabs/')
336       self.mipVocabTl = []
337       self.mipVocabVgmap = 'ESACCI'
338       self.mipVocabFnpat = 'variableInFile.txt'
339    else:
340       self.mipVocabDir = None
341       self.mipVocabTl = ['day', 't2']
342       self.mipVocabVgmap = {}
343       self.mipVocabFnpat = None
344    self.mipVocabPars = [self.mipVocabDir, self.mipVocabTl, self.mipVocabVgmap, self.mipVocabFnpat]
345
346######## used in checkByVar
347    if self.project == 'CORDEX':
348      self.groupIndex = 7
349    elif self.project in ['CMIP5','CCMI','SPECS','__dummy']:
350      self.groupIndex = 1
351    elif self.project in ['ESA-CCI']:
352      self.fnvdict = { 'SSTskin':{'v':'sea_surface_temperature', 'sn':'sea_surface_skin_temperature'} }
353      self.fnoptions = {'groupIndex':[3,1], 'trangeIndex':[0,-2] }
354      self.fnoptions['inFn'] = [[None,'*activity','*level','*project','*var','*product','*additional','*gdsv','*version'],
355                                ['*activity','*project','*level','*var','*additional',None,'*version']]
356      self.fnoptions['varIndex'] = [4,3]
357##Indicative Date>[<Indicative Time>]-ESACCI-<Processing Level>_<CCI Project>-<Data Type>-<Product String>[- <Additional Segregator>][-v<GDS version>]-fv<File version>.nc
358##ESACCI-<CCI Project>-<Processing Level>-<Data Type>-<Product String>[-<Additional Segregator>]-<IndicativeDate>[<Indicative Time>]-fv<File version>.nc
359
360    self.trangeIndex = -1
361
362    self.getVocabs()
363    test = False
364    if test:
365      for k in self.vocabs['variable'].varcons.keys():
366        for k2 in self.vocabs['variable'].varcons[k].keys():
367          if "height2m" in self.vocabs['variable'].varcons[k][k2].get( '_dimension',[]):
368            print 'config_c4: %s , %s: %s' % (k,k2,str(self.vocabs['variable'].varcons[k][k2]['_dimension'] ) )
369
370    ##assert self.project != 'CCMI', 'Not completely set up for CCMI yet'
371
372  def getExtraAtts(self):
373
374    eafile = self.mipVocabDir + 'extraAtts.txt'
375    self.extraAtts = {}
376    if os.path.isfile( eafile ):
377      for l in open( eafile ).readlines():
378        if l[0] != '#':
379          bits = map( string.strip, string.split(l,',') )
380          id = '%s.%s' % (bits[0],bits[1])
381          ee = {}
382          for b in bits[2:]:
383            bb = string.split(b,'=')
384            ee[bb[0]] = bb[1]
385          self.extraAtts[id] = ee
386
387  def getVocabs(self):
388  ## "Returns a dictionary of vocabulary details for the project provided."
389    if self.projectV.id == 'SPECS':
390               ##'experiment_id':utils.patternControl( 'experiment_id', "(?P<val>.*)[0-9]{4}", list=validSpecsExptFamilies ), \
391      vocabs = { 'variable':utils.mipVocab(self), \
392               'Conventions':utils.listControl( 'Conventions', ['CF-1.6'] ), \
393               'frequency':utils.listControl( 'frequency', validSpecsFrequencies ), \
394               'experiment_id':utils.listControl( 'experiment_id', validSpecsExptFamilies ), \
395               'initialization_method':utils.patternControl( 'initialization_method', "[0-9]+" ), \
396               'physics_version':utils.patternControl( 'physics_version', "[0-9]+" ), \
397               'realization':utils.patternControl( 'realization', "[0-9]+" ), \
398               'startdate':utils.patternControl( 'startdate', "S[0-9]{8}" ), \
399               ## 'associated_experiment':utils.patternControl( 'associated_experment', "(?P<val>(N/A|(decadal|seasonal): r\*i[0-9]{1,4}p[0-9]{1,4}))" ), \
400               'project_id':utils.listControl( 'project_id', ['SPECS', 'NMME-SPECS'] ), \
401               ## 'institution':utils.listControl( 'institution', validSpecsInstitutions ), \
402               'modeling_realm':utils.listControl( 'realm', ['atmos', 'ocean', 'land', 'landIce', 'seaIce', 'aerosol', 'atmosChem', 'ocnBgchem'], split=True ), \
403             }
404    elif self.projectV.id == 'CMIP5':
405               ##'experiment_id':utils.patternControl( 'experiment_id', "(?P<val>.*)[0-9]{4}", list=validSpecsExptFamilies ), \
406      lrdr = readVocab( 'cmip5_vocabs/')
407      vocabs = { 'variable':utils.mipVocab(self), \
408               'Conventions':utils.listControl( 'Conventions', ['CF-1.4','CF-1.5'] ), \
409               'experiment_id':utils.listControl( 'experiment_id', lrdr.getSimpleList( 'experiments.txt' ) ), \
410               'frequency':utils.listControl( 'frequency', validCmip5Frequencies ), \
411               'initialization_method':utils.patternControl( 'initialization_method', "[0-9]+" ), \
412               'physics_version':utils.patternControl( 'physics_version', "[0-9]+" ), \
413               'realization':utils.patternControl( 'realization', "[0-9]+" ), \
414               'project_id':utils.listControl( 'project_id', ['CMIP5'] ), \
415               ## 'institution':utils.listControl( 'institution', validSpecsInstitutions ), \
416               'modeling_realm':utils.listControl( 'realm', ['atmos', 'ocean', 'land', 'landIce', 'seaIce', 'aerosol', 'atmosChem', 'ocnBgchem'], split=True ), \
417             }
418    elif self.projectV.id == 'CCMI':
419   
420      lrdr = readVocab( 'ccmi_vocabs/')
421      vocabs = { 'variable':utils.mipVocab(self), \
422               'frequency':utils.listControl( 'frequency', validCcmiFrequencies ), \
423               'experiment_id':utils.listControl( 'experiment_id', lrdr.getSimpleList( 'ccmi_experiments.txt', bit=-1 ) ), \
424## do not preserve or check relation between model and institution.
425               'institution':utils.listControl( 'institution', lrdr.getSimpleList( 'models_insts.txt', bit=1 ) ), \
426               'model_id':utils.listControl( 'model_id', lrdr.getSimpleList( 'models_insts.txt', bit=0 ) ), \
427               'modeling_realm':utils.listControl( 'realm', ['atmos', 'ocean', 'land', 'landIce', 'seaIce', 'aerosol', 'atmosChem', 'ocnBgchem'] ), \
428               'project_id':utils.listControl( 'project_id', ['CCMI'] ) }
429
430    elif self.projectV.id == 'ESA-CCI':
431      lrdr = readVocab( 'esacci_vocabs/')
432      cciProjectList, self.ecvMappings = lrdr.getSimpleList( 'cciProject.txt', bit=-1, options='returnMappings' )
433      vocabs = { 'variable':utils.mipVocab(self), \
434               'version':utils.patternControl( 'version',  '^(fv[0-9]+(\.[0-9]+){0,1})$', examples=['fv1.1'] ), \
435               'level':utils.listControl( 'level', lrdr.getSimpleList( 'procLevel01.txt', bit=0 ) ), \
436               'platform':utils.listControl( 'platforms', lrdr.getSimpleList( 'platforms.txt', bit=0), enumeration=True, split=True, splitVal=',' ), \
437               'institution':utils.listControl( 'institution', lrdr.getSimpleList( 'institutions.txt', omt='last' ) ), \
438               'Conventions':utils.patternControl( 'Conventions', '^CF-1.[56789](,.*){0,1}$', examples=['CF-1.6'] ), \
439               'sensor':utils.listControl( 'sensors', lrdr.getSimpleList( 'sensors.txt', bit=0 ) ), \
440               'cdm_data_type':utils.listControl( 'cdm_data_type', lrdr.getSimpleList( 'threddsDataType.txt', bit=0 ) ), \
441               'time_coverage_duration':utils.patternControl( 'time_coverage_duration',  'ISO8601 duration', cls='ISO',examples=['P1Y'] ), \
442               'spatial_resolution':utils.patternControl( 'spatial_resolution',  '([0-9]+(.[0-9]+){0,1})[\s]*(km|m).*', examples=['20km','1 km at nadir'] ), \
443               'project':utils.listControl( 'project', ['Climate Change Initiative - European Space Agency'] ), \
444               'cciProject':utils.listControl( 'cciproject', cciProjectList ), \
445               'var':utils.listControl( 'var', lrdr.getSimpleList( 'variables.txt', bit=-1 ) ) \
446             }
447    elif self.projectV.id == '__dummy':
448      vocabs = { 'variable':utils.mipVocab(self,dummy=True) }
449    else:
450      vocabs = { 'variable':utils.mipVocab(self), \
451           'driving_experiment_name':utils.listControl( 'driving_experiment_name', validCordexExperiment ), \
452           'project_id':utils.listControl( 'project_id', ['CORDEX'] ), \
453           'CORDEX_domain':utils.listControl( 'CORDEX_domain',  validCordexDomains ), \
454           'driving_model_id':utils.listControl( 'driving_model_id',  validGcmNames ), \
455           'driving_model_ensemble_member':utils.patternControl( 'driving_model_ensemble_member',  'r[0-9]+i[0-9]+p[0-9]+' ), \
456           'rcm_version_id':utils.patternControl( 'rcm_version_id',  '[a-zA-Z0-9-]+' ), \
457           'model_id':utils.listControl( 'model_id',  validRcmNames ), \
458           'institute_id':utils.listControl( 'institute_id',  validInstNames ), \
459           'frequency':utils.listControl( 'frequency', validCordexFrequencies ) }
460
461    self.vocabs = vocabs
462
463
464  def setEsaCciFNType(self,id):
465      self.groupIndex =  self.fnoptions['groupIndex'][id]
466      self.trangeIndex = self.fnoptions['trangeIndex'][id]
467      self.globalAttributesInFn = self.fnoptions['inFn'][id]
468      self.varIndex = self.fnoptions['varIndex'][id]
469
470
471def copy_config(dest_dir):
472   """
473   Copy the current default configuration directory into a separate directory.
474
475   The directory <ceda_cc-package-dir>/config is copied to `dest_dir`.
476   This is useful when ceda-cc is installed as a Python package and the user may
477   not know where the config directory is stored.
478
479   :param dest_dir: should be a path to a directory which does not yet exist. 
480       The configuration directory will be copied to this path.
481
482   """
483   shutil.copytree(CC_CONFIG_DEFAULT_DIR, dest_dir)
Note: See TracBrowser for help on using the repository browser.