Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
import os
from bscearth.utils.date import parse_date, chunk_start_date, chunk_end_date, previous_day
from bscearth.utils.log import Log
from earthdiagnostics.frequency import Frequency, Frequencies
from earthdiagnostics.modelingrealm import ModelingRealms
from earthdiagnostics.variable import VariableType
class DataConvention(object):
def __init__(self, name, config):
self.config = config
self.name = name
self.lat_name = 'lat'
self.lon_name = 'lon'
self.time_separator = '-'
def get_file_name(self, startdate, member, domain, var, cmor_var, frequency, chunk, year, date_str, grid, ):
raise NotImplementedError
def get_cmor_folder_path(self, startdate, member, domain, var, frequency, grid, cmor_var):
raise NotImplementedError
def get_startdate_path(self, startdate):
"""
Return the path to the startdate's CMOR folder
Parameters
----------
startdate: str
Returns
-------
str
"""
return os.path.join(self.config.data_dir, self.config.experiment.expid, 'cmorfiles', self.config.cmor.activity,
self.config.experiment.institute, self.config.experiment.model,
self.experiment_name(startdate))
def experiment_name(self, startdate):
"""
Get experiment name, appending startdate if needed
Parameters
----------
startdate: str
Returns
-------
str
"""
if self.config.cmor.append_startdate:
return '{}S{}'.format(self.config.experiment.experiment_name, startdate)
else:
return self.config.experiment.experiment_name
def get_member_str(self, member):
raise NotImplementedError
def create_links(self, cmor_manager, member_str, path):
raise NotImplementedError()
def _get_time_component(self, chunk, date_str, frequency, startdate, year):
if chunk is not None:
time_bound = self._get_chunk_time_bounds(startdate, chunk)
elif year:
if frequency != Frequencies.yearly:
raise ValueError('Year may be provided instead of chunk only if frequency is "yr"')
time_bound = str(year)
else:
time_bound = date_str
return time_bound
def _get_chunk_time_bounds(self, startdate, chunk):
start = parse_date(startdate)
chunk_start = chunk_start_date(start, chunk, self.experiment.chunk_size, 'month', self.experiment.calendar)
chunk_end = chunk_end_date(chunk_start, self.experiment.chunk_size, 'month', self.experiment.calendar)
chunk_end = previous_day(chunk_end, self.experiment.calendar)
time_bound = "{0:04}{1:02}{4}{2:04}{3:02}".format(chunk_start.year, chunk_start.month, chunk_end.year,
chunk_end.month, self.time_separator)
return time_bound
class Cmor2Convention(DataConvention):
def get_scratch_masks(self, scratch_masks):
return scratch_masks
def get_file_name(self, startdate, member, domain, var, cmor_var, frequency, chunk, year, date_str, grid, ):
if cmor_var is None:
cmor_table = domain.get_table(frequency, self.config.data_convention)
else:
cmor_table = cmor_var.get_table(frequency, self.config.data_convention)
time_bound = self._get_time_component(chunk, date_str, frequency, startdate, year)
time_bound = '_{0}.nc'.format(time_bound)
file_name = '{0}_{1}_{2}_{3}_S{4}_{5}{6}'.format(var, cmor_table.name, self.experiment.model,
self.experiment_name(startdate), startdate,
self._get_member_str(member), time_bound)
return file_name
def get_cmor_folder_path(self, startdate, member, domain, var, frequency, grid, cmor_var):
folder_path = os.path.join(self.get_startdate_path(startdate), str(frequency), domain.name, var)
if grid:
folder_path = os.path.join(folder_path, grid)
folder_path = os.path.join(folder_path, self._get_member_str(member))
if self.config.cmor.version:
folder_path = os.path.join(folder_path, self.config.cmor.version)
return folder_path
def get_member_str(self, member):
template = 'r{0}i{1}p1'
return template.format(member + 1 - self.experiment.member_count_start, self.config.cmor.initialization_number)
def create_links(self, cmor_manager, member_str, path):
for freq in os.listdir(path):
Log.debug('Creating links for frequency {0}', freq)
frequency = Frequency.parse(freq)
for domain in os.listdir(os.path.join(path, freq)):
Log.debug('Creating links for domain {0}', domain)
for var in os.listdir(os.path.join(path, freq, domain)):
for member in os.listdir(os.path.join(path, freq, domain, var)):
if member_str is not None and member_str != member:
continue
for name in os.listdir(os.path.join(path, freq, domain, var, member)):
filepath = os.path.join(path, freq, domain, var, member, name)
if os.path.isfile(filepath):
cmor_manager.create_link(domain, filepath, frequency, var, "", False,
vartype=VariableType.MEAN)
else:
for filename in os.listdir(filepath):
cmor_manager.create_link(domain, os.path.join(filepath, filename), frequency, var,
"", False, vartype=VariableType.MEAN)
class SPECSConvention(Cmor2Convention):
def get_startdate_path(self, startdate):
return os.path.join(self.config.data_dir, self.experiment.expid, 'cmorfiles', self.experiment.institute,
self.experiment.model, self.experiment_name(startdate), 'S' + startdate)
class PrefaceConvention(Cmor2Convention):
def __init__(self, name, config):
super(PrefaceConvention, self).__init__(name, config)
self.time_separator = '_'
def get_startdate_path(self, startdate):
return os.path.join(self.config.data_dir, self.experiment.expid, 'cmorfiles', self.experiment.institute,
self.experiment_name(startdate), 'S' + startdate)
class Cmor3Convention(DataConvention):
def __init__(self, name, config):
super(Cmor3Convention, self).__init__(name, config)
self.lat_name = 'latitude'
self.lon_name = 'longitude'
def get_scratch_masks(self, scratch_masks):
return os.path.join(scratch_masks, self.name)
def get_file_name(self, startdate, member, domain, var, cmor_var, frequency, chunk, year, date_str, grid, ):
if cmor_var is None:
cmor_table = domain.get_table(frequency, self.config.data_convention)
else:
cmor_table = cmor_var.get_table(frequency, self.config.data_convention)
time_bound = self._get_time_component(chunk, date_str, frequency, startdate, year)
time_bound = '_{0}.nc'.format(time_bound)
if not grid:
if domain in [ModelingRealms.ocnBgchem, ModelingRealms.seaIce, ModelingRealms.ocean]:
grid = self.config.cmor.default_ocean_grid
else:
grid = self.config.cmor.default_atmos_grid
file_name = '{0}_{1}_{2}_{3}_{4}_{5}{6}'.format(var, cmor_table.name, self.experiment.model,
self.experiment_name(startdate),
self._get_member_str(member),
grid, time_bound)
return file_name
def get_cmor_folder_path(self, startdate, member, domain, var, frequency, grid, cmor_var):
if not self.config.cmor.version:
raise ValueError('CMOR version is mandatory for PRIMAVERA and CMIP6')
if not grid:
if domain in [ModelingRealms.ocnBgchem, ModelingRealms.seaIce, ModelingRealms.ocean]:
grid = self.config.cmor.default_ocean_grid
else:
grid = self.config.cmor.default_atmos_grid
if cmor_var is None:
table_name = domain.get_table(frequency, self.config.data_convention).name
else:
table_name = cmor_var.get_table(frequency, self.config.data_convention).name
folder_path = os.path.join(self.get_startdate_path(startdate), self._get_member_str(member),
table_name, var,
grid, self.config.cmor.version)
return folder_path
def create_links(self, cmor_manager, member_str, path):
for member in os.listdir(path):
for table in os.listdir(os.path.join(path, member)):
frequency = self.config.var_manager.tables[table].frequency
domain = None
Log.debug('Creating links for table {0}', table)
for var in os.listdir(os.path.join(path, member, table)):
for grid in os.listdir(os.path.join(path, member, table, var)):
if member_str is not None and member_str != member:
continue
for name in os.listdir(os.path.join(path, member, table, var, grid)):
filepath = os.path.join(path, member, table, var, grid, name)
if os.path.isfile(filepath):
self.create_link(domain, filepath, frequency, var, "", False,
vartype=VariableType.MEAN)
else:
for filename in os.listdir(filepath):
cmorfile = os.path.join(filepath, filename)
self.create_link(domain, cmorfile, frequency, var, "",
False, vartype=VariableType.MEAN)
def get_member_str(self, member):
template = 'r{0}i{1}p1f1'
return template.format(member + 1 - self.config.experiment.member_count_start,
self.config.cmor.initialization_number)
class CMIP6Convention(Cmor3Convention):
pass
class PrimaveraConvention(Cmor3Convention):
pass
class MeteoFranceConvention(DataConvention):
def get_file_name(self, startdate, member, domain, var, cmor_var, frequency, chunk, year, date_str, grid,):
time_bound = self._get_chunk_time_bounds(startdate, chunk)
file_name = '{0}_{1}_{2}_{3}.nc'.format(var, frequency, time_bound, self._get_member_str(member))
return file_name
def get_cmor_folder_path(self, startdate, member, domain, var, frequency, grid, cmor_var):
folder_path = os.path.join(self.config.data_dir, self.experiment_name(startdate),
'H{0}'.format(chr(64 + int(startdate[4:6]))),
startdate[0:4])
return folder_path
def get_member_str(self, member):
return '{0:02d}'.format(member)
def _get_chunk_time_bounds(self, startdate, chunk):
start = parse_date(startdate)
chunk_start = chunk_start_date(start, chunk, self.experiment.chunk_size, 'month', self.experiment.calendar)
time_bound = "{0:04}{1:02}".format(chunk_start.year, chunk_start.month)
return time_bound