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

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

brought branches-mnj back to trunk

Line 
1import string
2import utils_c4 as utils
3import os
4import os.path as op
5import shutil
6
7##############################################################################
8# Configure config-file paths
9#
10# All configuration directories, e.g. cmip5_vocabs, are looked for in a single
11# parent directory.  This is the "config" directory within the package unless
12# the environment variable CC_CONFIG_DIR is set.
13
14HERE = op.dirname(__file__)
15CC_CONFIG_DEFAULT_DIR = op.join(HERE, 'config')
16CC_CONFIG_DIR = os.environ.get('CC_CONFIG_DIR', CC_CONFIG_DEFAULT_DIR)
17
18##############################################################################
19
20validCmip5Experiments = ['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']
21
22validCordexExperiment = validCmip5Experiments + ['evaluation']
23
24
25validCmip5Frequencies = ['fx','yr','monClim','mon','day','6hr','3hr','subhr']
26validCordexFrequencies = ['fx','sem','mon','day','6hr','3hr']
27validSpecsFrequencies = ['fx','mon','day','6hr']
28validCcmiFrequencies = ['fx','yr','mon','day','hr','subhr']
29validSpecsExptFamilies = map( lambda x: string.split( x )[0], 
30                              open( op.join(CC_CONFIG_DIR, 'specs_vocabs/exptFamily.txt' )).readlines() )
31
32validCordexDomainsL = [ 'SAM-44', 'CAM-44', 'NAM-44', 'EUR-44', 'AFR-44', 'WAS-44', 'EAS-44', 'CAS-44', 'AUS-44', 'ANT-44', 'ARC-44', 'MED-44']
33validCordexDomainsLi = map( lambda x: x + 'i', validCordexDomainsL )
34validCordexDomainsH = ['EUR-11']
35validCordexDomains = validCordexDomainsL + validCordexDomainsLi + validCordexDomainsH
36
37plevRequired = ['clh', 'clm', 'cll', 'ua850', 'va850', 'ta850', 'hus850', 'ua500', 'va500', 'ta500', 'zg500', 'ua200', 'va200', 'ta200', 'zg200']
38plevBndsRequired = ['clh', 'clm', 'cll']
39heightRequired = ['tas','tasmax','tasmin','huss','sfcWind','sfcWindmax','wsgsmax','uas','vas']
40
41
42ii = open( op.join(CC_CONFIG_DIR, 'cordex_vocabs/GCMModelName.txt' )).readlines()
43validGcmNames = []
44for l in ii:
45  if l[0] != '#' and len( string.strip(l) ) > 0:
46    validGcmNames.append( string.split(l)[0] )
47
48ii = open( op.join(CC_CONFIG_DIR, 'cordex_vocabs/RCMModelName.txt' )).readlines()
49validRcmNames = []
50validInstNames = []
51for l in ii:
52  if l[0] != '#' and len( string.strip(l) ) > 0:
53    bits = string.split(l)
54    validRcmNames.append( bits[0] )
55    validInstNames.append( bits[1] )
56
57plevValues = {'clh':22000, 'clm':56000, 'cll':84000}
58for i in [200,500,850]:
59  for v in ['zg','ua', 'va', 'ta', 'hus']:
60    k = '%s%s' % (v,i)
61    plevValues[k] = i*100
62
63heightRequired = ['tas', 'tasmax', 'tasmin', 'huss', 'sfcWind', 'sfcWindmax', 'wsgsmax', 'uas', 'vas']
64heightValues = {}
65heightRange = {}
66for v in heightRequired:
67  if v in ['tas', 'tasmax', 'tasmin', 'huss']:
68    heightValues[v] = 2
69  else:
70    heightValues[v] = 10
71  heightRange[v] = (1.5,10.)
72
73ii = open( op.join(CC_CONFIG_DIR, 'cordex_vocabs/cordex_domains.csv' )).readlines()
74keys = ['name','tag','res','grid_np_lon','grid_np_lat','nlon','nlat','w','e','s','n']
75rotatedPoleGrids = {}
76for l in ii[2:16]:
77  bits = string.split(string.strip(l),',')
78  ee = {}
79  i = 0
80  for k in keys:
81    if k in ['nlon','nlat']:
82      ee[k] = int(bits[i])
83    elif k in ['grid_np_lon','grid_np_lat','w','e','s','n','res']:
84      if bits[i] != 'N/A':
85        ee[k] = float(bits[i])
86      else:
87        ee[k] = bits[i]
88    else:
89      ee[k] = bits[i]
90    i += 1
91    rotatedPoleGrids[bits[1]] = ee
92
93##Area,Name, deg,Nlon,Nlat,West8,East8,South8,North8,
94keys = ['name','tag','res','nlon','nlat','w','e','s','n']
95interpolatedGrids = {}
96for l in ii[18:33]:
97  bits = string.split(string.strip(l),',')
98  ee = {}
99  i = 0
100  for k in keys:
101    if k in ['nlon','nlat']:
102      ee[k] = int(bits[i])
103    elif k in ['w','e','s','n','res']:
104        ee[k] = float(bits[i])
105    else:
106      ee[k] = bits[i]
107    i += 1
108    interpolatedGrids[bits[1]] = ee
109
110class readVocab(object):
111
112  def __init__(self,dir):
113    self.dir = dir
114
115  def getSimpleList(self,file,bit=None):
116    ii = open('%s/%s/%s' % (CC_CONFIG_DIR, self.dir,file) )
117    oo = []
118    for l in ii.readlines():
119      if l[0] != '#':
120        ll = string.strip(l)
121        if bit == None:
122          oo.append(ll)
123        else:
124          oo.append(string.split(ll)[bit])
125    return oo
126
127validSpecsInstitutions = ['IC3', 'MPI-M', 'KNMI', 'UOXF', 'CNRM-CERFACS', 'ENEA', 'MOHC', 'SMHI', 'IPSL', 'UREAD', 'ECWMF']
128
129def getVocabs(pcfg):
130  "Returns a dictionary of vocabulary details for the project provided."
131  if pcfg.project == 'SPECS':
132               ##'experiment_id':utils.patternControl( 'experiment_id', "(?P<val>.*)[0-9]{4}", list=validSpecsExptFamilies ), \
133    vocabs = { 'variable':utils.mipVocab(pcfg), \
134               'Conventions':utils.listControl( 'Conventions', ['CF-1.6'] ), \
135               'frequency':utils.listControl( 'frequency', validSpecsFrequencies ), \
136               'experiment_id':utils.listControl( 'experiment_id', validSpecsExptFamilies ), \
137               'initialization_method':utils.patternControl( 'initialization_method', "[0-9]+" ), \
138               'physics_version':utils.patternControl( 'physics_version', "[0-9]+" ), \
139               'realization':utils.patternControl( 'realization', "[0-9]+" ), \
140               'project_id':utils.listControl( 'project_id', ['SPECS'] ), \
141               ## 'institution':utils.listControl( 'institution', validSpecsInstitutions ), \
142               'modeling_realm':utils.listControl( 'realm', ['atmos', 'ocean', 'land', 'landIce', 'seaIce', 'aerosol', 'atmosChem', 'ocnBgchem'], split=True ), \
143               'series':utils.listControl( 'series', ['series1','series2'] ), \
144             }
145  elif pcfg.project == 'CMIP5':
146               ##'experiment_id':utils.patternControl( 'experiment_id', "(?P<val>.*)[0-9]{4}", list=validSpecsExptFamilies ), \
147    lrdr = readVocab( 'cmip5_vocabs/')
148    vocabs = { 'variable':utils.mipVocab(pcfg), \
149               'Conventions':utils.listControl( 'Conventions', ['CF-1.4','CF-1.5'] ), \
150               'experiment_id':utils.listControl( 'experiment_id', lrdr.getSimpleList( 'experiments.txt' ) ), \
151               'frequency':utils.listControl( 'frequency', validCmip5Frequencies ), \
152               'initialization_method':utils.patternControl( 'initialization_method', "[0-9]+" ), \
153               'physics_version':utils.patternControl( 'physics_version', "[0-9]+" ), \
154               'realization':utils.patternControl( 'realization', "[0-9]+" ), \
155               'project_id':utils.listControl( 'project_id', ['CMIP5'] ), \
156               ## 'institution':utils.listControl( 'institution', validSpecsInstitutions ), \
157               'modeling_realm':utils.listControl( 'realm', ['atmos', 'ocean', 'land', 'landIce', 'seaIce', 'aerosol', 'atmosChem', 'ocnBgchem'], split=True ), \
158             }
159  elif pcfg.project == 'CCMI':
160   
161    lrdr = readVocab( 'ccmi_vocabs/')
162    vocabs = { 'variable':utils.mipVocab(pcfg), \
163               'frequency':utils.listControl( 'frequency', validCcmiFrequencies ), \
164               'experiment_id':utils.listControl( 'experiment_id', lrdr.getSimpleList( 'ccmi_experiments.txt', bit=-1 ) ), \
165## do not preserve or check relation between model and institution.
166               'institution':utils.listControl( 'institution', lrdr.getSimpleList( 'models_insts.txt', bit=1 ) ), \
167               'model_id':utils.listControl( 'model_id', lrdr.getSimpleList( 'models_insts.txt', bit=0 ) ), \
168               'modeling_realm':utils.listControl( 'realm', ['atmos', 'ocean', 'land', 'landIce', 'seaIce', 'aerosol', 'atmosChem', 'ocnBgchem'] ), \
169'atmosChem' and 'ocnBgchem'
170               'project_id':utils.listControl( 'project_id', ['CCMI'] ) }
171  elif pcfg.project == '__dummy':
172    vocabs = { 'variable':utils.mipVocab(pcfg,dummy=True) }
173  else:
174    vocabs = { 'variable':utils.mipVocab(pcfg), \
175           'driving_experiment_name':utils.listControl( 'driving_experiment_name', validCordexExperiment ), \
176           'project_id':utils.listControl( 'project_id', ['CORDEX'] ), \
177           'CORDEX_domain':utils.listControl( 'CORDEX_domain',  validCordexDomains ), \
178           'driving_model_id':utils.listControl( 'driving_model_id',  validGcmNames ), \
179           'driving_model_ensemble_member':utils.patternControl( 'driving_model_ensemble_member',  'r[0-9]+i[0-9]+p[0-9]+' ), \
180           'rcm_version_id':utils.patternControl( 'rcm_version_id',  '[a-zA-Z0-9-]+' ), \
181           'model_id':utils.listControl( 'model_id',  validRcmNames ), \
182           'institute_id':utils.listControl( 'institute_id',  validInstNames ), \
183           'frequency':utils.listControl( 'frequency', validCordexFrequencies ) }
184
185  return vocabs
186
187class projectConfig(object):
188
189  def __init__(self, project):
190    knownProjects = ['CMIP5','CCMI','CORDEX','SPECS','__dummy']
191    assert project in knownProjects, 'Project %s not in knownProjects %s' % (project, str(knownProjects))
192
193    self.project = project
194    self.gridSpecTol = 0.01
195    if project == 'CORDEX':
196      self.requiredGlobalAttributes = [ 'institute_id', 'contact', 'rcm_version_id', 'product', 'CORDEX_domain', 'creation_date', \
197             'frequency', 'model_id', 'driving_model_id', 'driving_experiment', 'driving_model_ensemble_member', 'experiment_id']
198      self.controlledGlobalAttributes = ['frequency', 'driving_experiment_name', 'project_id', 'CORDEX_domain', 'driving_model_id', 'model_id', 'institute_id','driving_model_ensemble_member','rcm_version_id']
199      self.globalAttributesInFn = [None,'CORDEX_domain','driving_model_id','experiment_id','driving_model_ensemble_member','model_id','rcm_version_id']
200      self.requiredVarAttributes = ['long_name', 'standard_name', 'units']
201      self.drsMappings = {'variable':'@var','institute':'institute_id', 'product':'product', 'experiment':'experiment_id', \
202                        'ensemble':'driving_model_ensemble_member', 'model':'model_id', 'driving_model':'driving_model_id', \
203                        'frequency':'frequency', \
204                        'project':'project_id', 'domain':'CORDEX_domain', 'model_version':'rcm_version_id' }
205
206    elif project == 'SPECS':
207      lrdr = readVocab( 'specs_vocabs/')
208      self.requiredGlobalAttributes = [ 'contact', 'product', 'creation_date', 'tracking_id', \
209              'experiment_id', 'series']
210      self.requiredGlobalAttributes = lrdr.getSimpleList( 'globalAts.txt' )
211      self.exptFamilies = lrdr.getSimpleList( 'exptFamily.txt', bit=0 )
212      self.controlledGlobalAttributes = [ 'project_id','experiment_id', 'series','frequency','Conventions','modeling_realm', \
213                       'initialization_method','physics_version','realization']
214      self.globalAttributesInFn = [None,'@mip_id','model_id','experiment_id','series','@forecast_reference_time','@ensemble']
215#sic_Oimon_EC-Earth2_seaIceBestInit_S19910501_series1_r1i1p1_199501-199502.nc
216## mip_id derived from global attribute Table_id (CMOR convention); experiment family derived from experiment_id, ensemble derived from rip attributes.
217      self.requiredVarAttributes = ['long_name', 'standard_name', 'units']
218      self.drsMappings = {'variable':'@var', 'institute':'institute_id', 'product':'product', 'experiment':'experiment_id', \
219                        'ensemble':'@ensemble', 'model':'model_id', 'series':'series', 'realm':'modeling_realm', \
220                        'frequency':'frequency', 'start_date':'@forecast_reference_time', \
221                        'table':'@mip_id',
222                        'project':'project_id'}
223
224    elif project == 'CMIP5':
225      lrdr = readVocab( 'cmip5_vocabs/')
226      self.requiredGlobalAttributes = [ 'contact', 'product', 'creation_date', 'tracking_id', \
227              'experiment_id']
228      ##self.requiredGlobalAttributes = lrdr.getSimpleList( 'globalAts.txt' )
229      self.controlledGlobalAttributes = [ 'project_id','experiment_id', 'frequency','Conventions','modeling_realm', \
230                       'initialization_method','physics_version','realization']
231      self.globalAttributesInFn = [None,'@mip_id','model_id','experiment_id','@ensemble']
232#sic_Oimon_EC-Earth2_seaIceBestInit_S19910501_series1_r1i1p1_199501-199502.nc
233## mip_id derived from global attribute Table_id (CMOR convention); experiment family derived from experiment_id, ensemble derived from rip attributes.
234      self.requiredVarAttributes = ['long_name', 'standard_name', 'units']
235## key: DRS element name, value: global attribute name or tag for mapping from file information ("@....").
236      self.drsMappings = {'variable':'@var', 'institute':'institute_id', 'product':'product', 'experiment':'experiment_id', \
237                        'ensemble':'@ensemble', 'model':'model_id', 'realm':'modeling_realm', \
238                        'frequency':'frequency',  'table':'@mip_id',
239                        'project':'project_id'}
240
241    elif project == 'CCMI':
242      lrdr = readVocab( 'ccmi_vocabs/')
243      self.requiredGlobalAttributes = [ 'creation_date', 'tracking_id', 'forcing', 'model_id', 'parent_experiment_id', 'parent_experiment_rip', 'branch_time', 'contact', 'institute_id' ]
244      self.requiredGlobalAttributes = lrdr.getSimpleList( 'globalAts.txt' )
245      self.controlledGlobalAttributes = [ 'experiment_id', 'project', 'frequency' ]
246      self.globalAttributesInFn = [None,'@mip_id','model_id','experiment_id','@ensemble']
247      self.requiredVarAttributes = ['long_name', 'standard_name', 'units']
248      self.drsMappings = {'variable':'@var'}
249
250    elif project == '__dummy':
251      self.requiredGlobalAttributes = map( lambda x: 'ga%s' % x, range(10) )
252      self.controlledGlobalAttributes = [ ]
253      self.globalAttributesInFn = [None,'ga2', 'ga3', 'ga4' ]
254      self.requiredVarAttributes = ['long_name', 'standard_name', 'units']
255      self.drsMappings = {'variable':'@var'}
256
257####### used in checkStandardDims
258
259    self.plevRequired = plevRequired
260    self.plevValues = plevValues
261    self.heightRequired = heightRequired
262    self.heightValues = heightValues
263    self.heightRange = heightRange
264
265####### used in checkGrids
266    self.rotatedPoleGrids = rotatedPoleGrids
267    self.interpolatedGrids = interpolatedGrids
268    self.doCheckGrids = self.project in ['CORDEX',]
269
270####### used in checkFileName (freqIndex also used in checkByVar)
271
272    if self.project == 'CORDEX':
273      self.fnPartsOkLen = [8,9]
274      self.fnPartsOkFixedLen = [8,]
275      self.fnPartsOkUnfixedLen = [9,]
276      self.checkTrangeLen = True
277      self.domainIndex = 1
278      self.freqIndex = 7
279    elif self.project == 'CMIP5':
280## cRoot_Lmon_CESM1-WACCM_rcp85_r3i1p1_200601-205512.nc
281      self.fnPartsOkLen = [5,6]
282      self.fnPartsOkFixedLen = [5,]
283      self.fnPartsOkUnfixedLen = [6,]
284      self.checkTrangeLen = False
285      self.domainIndex = None
286      self.freqIndex = None
287    elif self.project == 'SPECS':
288      self.fnPartsOkLen = [7,8]
289      self.fnPartsOkFixedLen = [7,]
290      self.fnPartsOkUnfixedLen = [8,]
291      self.checkTrangeLen = False
292      self.domainIndex = None
293      self.freqIndex = 1
294    elif self.project == 'CCMI':
295      self.fnPartsOkLen = [5,6]
296      self.fnPartsOkFixedLen = [5,]
297      self.fnPartsOkUnfixedLen = [6,]
298      self.checkTrangeLen = False
299      self.domainIndex = None
300      self.freqIndex = None
301    elif self.project == '__dummy':
302      self.fnPartsOkLen = [4,5]
303      self.fnPartsOkFixedLen = [4,]
304      self.fnPartsOkUnfixedLen = [5,]
305      self.checkTrangeLen = False
306      self.domainIndex = None
307      self.freqIndex = 1
308
309
310    self.defaults = { 'variableDataType':'float' }
311######## used in mipVocabs
312    if self.project == 'CORDEX':
313       self.mipVocabDir = op.join(CC_CONFIG_DIR, 'cordex_vocabs/mip/')
314       self.mipVocabTl = ['fx','sem','mon','day','6h','3h']
315       self.mipVocabVgmap = {'6h':'6hr','3h':'3hr'}
316       self.mipVocabFnpat = 'CORDEX_%s'
317    elif self.project == 'CMIP5':
318       self.mipVocabDir = op.join(CC_CONFIG_DIR, 'cmip5_vocabs/mip/')
319       self.mipVocabTl = ['fx','Oyr','Oclim','Omon','Amon','Lmon','LImon','OImon','cfMon','aero','cfDay','day','cfOff','cfSites','6hrLev','6hrPlev','3hr','cf3hr']
320       self.mipVocabVgmap = {}
321       self.mipVocabFnpat = 'CMIP5_%s'
322       self.defaults['variableDataType'] = None 
323    elif self.project == 'SPECS':
324       self.mipVocabDir = op.join(CC_CONFIG_DIR, 'specs_vocabs/mip/')
325       self.mipVocabTl = ['fx','Omon','Amon','Lmon','OImon','day','6hr']
326       self.mipVocabVgmap = {}
327       self.mipVocabFnpat = 'SPECS_%s'
328    elif self.project == 'CCMI':
329       self.mipVocabDir = op.join(CC_CONFIG_DIR, 'ccmi_vocabs/mip/')
330       self.mipVocabTl = ['fixed','annual','monthly','daily','hourly']
331       self.mipVocabVgmap = {'fixed':'fx','annual':'yr','monthly':'mon','daily':'day','hourly':'hr'}
332       self.mipVocabFnpat = 'CCMI1_%s_comp-v5.txt'
333    else:
334       self.mipVocabDir = None
335       self.mipVocabTl = ['day', 't2']
336       self.mipVocabVgmap = {}
337       self.mipVocabFnpat = None
338    self.mipVocabPars = [self.mipVocabDir, self.mipVocabTl, self.mipVocabVgmap, self.mipVocabFnpat]
339
340######## used in checkByVar
341    if self.project == 'CORDEX':
342      self.groupIndex = 7
343    elif self.project in ['CMIP5','CCMI','SPECS','__dummy']:
344      self.groupIndex = 1
345
346    self.vocabs = getVocabs(self)
347
348    ##assert self.project != 'CCMI', 'Not completely set up for CCMI yet'
349
350
351def copy_config(dest_dir):
352   """
353   Copy the current default configuration directory into a separate directory.
354
355   The directory <ceda_cc-package-dir>/config is copied to `dest_dir`.
356   This is useful when ceda-cc is installed as a Python package and the user may
357   not know where the config directory is stored.
358
359   :param dest_dir: should be a path to a directory which does not yet exist. 
360       The configuration directory will be copied to this path.
361
362   """
363   shutil.copytree(CC_CONFIG_DEFAULT_DIR, dest_dir)
Note: See TracBrowser for help on using the repository browser.