/
test_kernel_execution.py
382 lines (309 loc) · 13.8 KB
/
test_kernel_execution.py
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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
import sys
from os import path
import numpy as np
import pytest
from parcels import ( # noqa
AdvectionRK4,
ErrorCode,
FieldSet,
JITParticle,
KernelAOS,
KernelError,
KernelSOA,
OperationCode,
OutOfBoundsError,
ParticleFileAOS,
ParticleFileSOA,
ParticleSetAOS,
ParticleSetSOA,
ScipyParticle,
StateCode,
)
pset_modes = ['soa', 'aos']
ptype = {'scipy': ScipyParticle, 'jit': JITParticle}
pset_type = {'soa': {'pset': ParticleSetSOA, 'pfile': ParticleFileSOA, 'kernel': KernelSOA},
'aos': {'pset': ParticleSetAOS, 'pfile': ParticleFileAOS, 'kernel': KernelAOS}}
def DoNothing(particle, fieldset, time):
return StateCode.Success
def fieldset(xdim=20, ydim=20):
"""Standard unit mesh fieldset."""
lon = np.linspace(0., 1., xdim, dtype=np.float32)
lat = np.linspace(0., 1., ydim, dtype=np.float32)
U, V = np.meshgrid(lat, lon)
data = {'U': np.array(U, dtype=np.float32), 'V': np.array(V, dtype=np.float32)}
dimensions = {'lat': lat, 'lon': lon}
return FieldSet.from_data(data, dimensions, mesh='flat')
@pytest.fixture(name="fieldset")
def fieldset_fixture(xdim=20, ydim=20):
return fieldset(xdim=xdim, ydim=ydim)
@pytest.mark.parametrize('pset_mode', pset_modes)
@pytest.mark.parametrize('mode', ['scipy', 'jit'])
@pytest.mark.parametrize('start, end, substeps, dt', [
(0., 10., 1, 1.),
(0., 10., 4, 1.),
(0., 10., 1, 3.),
(2., 16., 5, 3.),
(20., 10., 4, -1.),
(20., -10., 7, -2.),
])
def test_execution_endtime(fieldset, pset_mode, mode, start, end, substeps, dt, npart=10):
pset = pset_type[pset_mode]['pset'](fieldset, pclass=ptype[mode], time=start,
lon=np.linspace(0, 1, npart),
lat=np.linspace(1, 0, npart))
pset.execute(DoNothing, endtime=end, dt=dt)
assert np.allclose(pset.time, end)
@pytest.mark.parametrize('pset_mode', pset_modes)
@pytest.mark.parametrize('mode', ['scipy', 'jit'])
@pytest.mark.parametrize('start, end, substeps, dt', [
(0., 10., 1, 1.),
(0., 10., 4, 1.),
(0., 10., 1, 3.),
(2., 16., 5, 3.),
(20., 10., 4, -1.),
(20., -10., 7, -2.),
])
def test_execution_runtime(fieldset, pset_mode, mode, start, end, substeps, dt, npart=10):
pset = pset_type[pset_mode]['pset'](fieldset, pclass=ptype[mode], time=start,
lon=np.linspace(0, 1, npart),
lat=np.linspace(1, 0, npart))
t_step = abs(end - start) / substeps
for _ in range(substeps):
pset.execute(DoNothing, runtime=t_step, dt=dt)
assert np.allclose(pset.time, end)
@pytest.mark.parametrize('pset_mode', pset_modes)
@pytest.mark.parametrize('mode', ['scipy', 'jit'])
@pytest.mark.parametrize('time', [0., 1])
@pytest.mark.parametrize('dt', [0., 1])
def test_pset_execute_dt_0(fieldset, pset_mode, mode, time, dt, npart=2):
def SetLat(particle, fieldset, time):
particle.lat = .6
lon = np.linspace(0, 1, npart)
lat = np.linspace(1, 0, npart)
pset = pset_type[pset_mode]['pset'](fieldset, pclass=ptype[mode], lon=lon, lat=lat)
pset.execute(SetLat, endtime=time, dt=dt)
assert np.allclose(pset.lon, lon)
assert np.allclose(pset.lat, [.6])
assert np.allclose(pset.time, min([time, dt]))
pset = pset_type[pset_mode]['pset'](fieldset, pclass=ptype[mode], lon=lon, lat=lat)
pset.execute(SetLat, runtime=time, dt=dt)
assert np.allclose(pset.lon, lon)
assert np.allclose(pset.lat, [.6])
assert np.allclose(pset.time, min([time, dt]))
@pytest.mark.parametrize('pset_mode', pset_modes)
@pytest.mark.parametrize('mode', ['scipy', 'jit'])
def test_execution_fail_timed(fieldset, pset_mode, mode, npart=10):
def TimedFail(particle, fieldset, time):
if particle.time >= 10.:
return ErrorCode.Error
else:
return StateCode.Success
pset = pset_type[pset_mode]['pset'](fieldset, pclass=ptype[mode],
lon=np.linspace(0, 1, npart),
lat=np.linspace(1, 0, npart))
error_thrown = False
try:
pset.execute(TimedFail, endtime=20., dt=2.)
except KernelError:
error_thrown = True
assert error_thrown
assert len(pset) == npart
assert np.allclose(pset.time, 10.)
@pytest.mark.parametrize('pset_mode', pset_modes)
@pytest.mark.parametrize('mode', ['scipy'])
def test_execution_fail_python_exception(fieldset, pset_mode, mode, npart=10):
def PythonFail(particle, fieldset, time):
if particle.time >= 10.:
raise RuntimeError("Enough is enough!")
else:
return StateCode.Success
pset = pset_type[pset_mode]['pset'](fieldset, pclass=ptype[mode],
lon=np.linspace(0, 1, npart),
lat=np.linspace(1, 0, npart))
error_thrown = False
try:
pset.execute(PythonFail, endtime=20., dt=2.)
except KernelError:
error_thrown = True
assert error_thrown
assert len(pset) == npart
assert np.allclose(pset.time, 10.)
@pytest.mark.parametrize('pset_mode', pset_modes)
@pytest.mark.parametrize('mode', ['scipy', 'jit'])
def test_execution_fail_out_of_bounds(fieldset, pset_mode, mode, npart=10):
def MoveRight(particle, fieldset, time):
tmp1, tmp2 = fieldset.UV[time, particle.depth, particle.lat, particle.lon + 0.1] # noqa
particle.lon += 0.1
pset = pset_type[pset_mode]['pset'](fieldset, pclass=ptype[mode],
lon=np.linspace(0, 1, npart),
lat=np.linspace(1, 0, npart))
error_thrown = False
try:
pset.execute(MoveRight, endtime=10., dt=1.)
except OutOfBoundsError:
error_thrown = True
assert error_thrown
assert len(pset) == npart
assert (pset.lon - 1. > -1.e12).all()
@pytest.mark.parametrize('pset_mode', pset_modes)
@pytest.mark.parametrize('mode', ['scipy', 'jit'])
def test_execution_recover_out_of_bounds(fieldset, pset_mode, mode, npart=2):
def MoveRight(particle, fieldset, time):
tmp1, tmp2 = fieldset.UV[time, particle.depth, particle.lat, particle.lon + 0.1] # noqa
particle.lon += 0.1
def MoveLeft(particle, fieldset, time):
particle.lon -= 1.
lon = np.linspace(0.05, 0.95, npart)
lat = np.linspace(1, 0, npart)
pset = pset_type[pset_mode]['pset'](fieldset, pclass=ptype[mode], lon=lon, lat=lat)
pset.execute(MoveRight, endtime=10., dt=1.,
recovery={ErrorCode.ErrorOutOfBounds: MoveLeft})
assert len(pset) == npart
assert np.allclose(pset.lon, lon, rtol=1e-5)
assert np.allclose(pset.lat, lat, rtol=1e-5)
@pytest.mark.parametrize('pset_mode', pset_modes)
@pytest.mark.parametrize('mode', ['scipy', 'jit'])
def test_execution_delete_out_of_bounds(fieldset, pset_mode, mode, npart=10):
def MoveRight(particle, fieldset, time):
tmp1, tmp2 = fieldset.UV[time, particle.depth, particle.lat, particle.lon + 0.1] # noqa
particle.lon += 0.1
def DeleteMe(particle, fieldset, time):
particle.delete()
lon = np.linspace(0.05, 0.95, npart)
lat = np.linspace(1, 0, npart)
pset = pset_type[pset_mode]['pset'](fieldset, pclass=ptype[mode], lon=lon, lat=lat)
pset.execute(MoveRight, endtime=10., dt=1.,
recovery={ErrorCode.ErrorOutOfBounds: DeleteMe})
assert len(pset) == 0
@pytest.mark.parametrize('pset_mode', pset_modes)
@pytest.mark.parametrize('mode', ['scipy', 'jit'])
def test_kernel_add_no_new_variables(fieldset, pset_mode, mode):
def MoveEast(particle, fieldset, time):
particle.lon += 0.1
def MoveNorth(particle, fieldset, time):
particle.lat += 0.1
pset = pset_type[pset_mode]['pset'](fieldset, pclass=ptype[mode], lon=[0.5], lat=[0.5])
pset.execute(pset.Kernel(MoveEast) + pset.Kernel(MoveNorth),
endtime=1., dt=1.)
assert np.allclose(pset.lon, 0.6, rtol=1e-5)
assert np.allclose(pset.lat, 0.6, rtol=1e-5)
@pytest.mark.parametrize('pset_mode', pset_modes)
@pytest.mark.parametrize('mode', ['scipy', 'jit'])
def test_multi_kernel_duplicate_varnames(fieldset, pset_mode, mode):
# Testing for merging of two Kernels with the same variable declared
# Should throw a warning, but go ahead regardless
def MoveEast(particle, fieldset, time):
add_lon = 0.1
particle.lon += add_lon
def MoveWest(particle, fieldset, time):
add_lon = -0.3
particle.lon += add_lon
pset = pset_type[pset_mode]['pset'](fieldset, pclass=ptype[mode], lon=[0.5], lat=[0.5])
pset.execute([MoveEast, MoveWest], endtime=1., dt=1.)
assert np.allclose(pset.lon, 0.3, rtol=1e-5)
@pytest.mark.parametrize('pset_mode', pset_modes)
@pytest.mark.parametrize('mode', ['scipy', 'jit'])
def test_multi_kernel_reuse_varnames(fieldset, pset_mode, mode):
# Testing for merging of two Kernels with the same variable declared
# Should throw a warning, but go ahead regardless
def MoveEast1(particle, fieldset, time):
add_lon = 0.2
particle.lon += add_lon
def MoveEast2(particle, fieldset, time):
particle.lon += add_lon # NOQA - no flake8 testing of this line
pset = pset_type[pset_mode]['pset'](fieldset, pclass=ptype[mode], lon=[0.5], lat=[0.5])
pset.execute(pset.Kernel(MoveEast1) + pset.Kernel(MoveEast2),
endtime=1., dt=1.)
assert np.allclose(pset.lon, [0.9], rtol=1e-5) # should be 0.5 + 0.2 + 0.2 = 0.9
@pytest.mark.parametrize('pset_mode', pset_modes)
def test_combined_kernel_from_list(fieldset, pset_mode):
"""
Test pset.Kernel(List[function])
Tests that a Kernel can be created from a list functions, or a list of
mixed functions and kernel objects.
"""
def MoveEast(particle, fieldset, time):
particle.lon += 0.1
def MoveNorth(particle, fieldset, time):
particle.lat += 0.1
pset = pset_type[pset_mode]['pset'](fieldset, pclass=JITParticle, lon=[0.5], lat=[0.5])
kernels_single = pset.Kernel([AdvectionRK4])
kernels_functions = pset.Kernel([AdvectionRK4, MoveEast, MoveNorth])
# Check if the kernels were combined correctly
assert kernels_single.funcname == "AdvectionRK4"
assert kernels_functions.funcname == "AdvectionRK4MoveEastMoveNorth"
@pytest.mark.parametrize('pset_mode', pset_modes)
def test_combined_kernel_from_list_error_checking(fieldset, pset_mode):
"""
Test pset.Kernel(List[function])
Tests that various error cases raise appropriate messages.
"""
def MoveEast(particle, fieldset, time):
particle.lon += 0.1
def MoveNorth(particle, fieldset, time):
particle.lat += 0.1
pset = pset_type[pset_mode]['pset'](fieldset, pclass=JITParticle, lon=[0.5], lat=[0.5])
# Test that list has to be non-empty
with pytest.raises(ValueError):
pset.Kernel([])
# Test that list has to be all functions
with pytest.raises(ValueError):
pset.Kernel([AdvectionRK4, "something else"])
# Can't mix kernel objects and functions in list
with pytest.raises(ValueError):
kernels_mixed = pset.Kernel([pset.Kernel(AdvectionRK4), MoveEast, MoveNorth])
assert kernels_mixed.funcname == "AdvectionRK4MoveEastMoveNorth"
@pytest.mark.parametrize('pset_mode', pset_modes)
@pytest.mark.parametrize('mode', ['scipy', 'jit'])
def test_update_kernel_in_script(fieldset, pset_mode, mode):
# Testing what happens when kernels are updated during runtime of a script
# Should throw a warning, but go ahead regardless
def MoveEast(particle, fieldset, time):
add_lon = 0.1
particle.lon += add_lon
def MoveWest(particle, fieldset, time):
add_lon = -0.3
particle.lon += add_lon
pset = pset_type[pset_mode]['pset'](fieldset, pclass=ptype[mode], lon=[0.5], lat=[0.5])
pset.execute(pset.Kernel(MoveEast), endtime=1., dt=1.)
pset.execute(pset.Kernel(MoveWest), endtime=2., dt=1.)
assert np.allclose(pset.lon, 0.3, rtol=1e-5) # should be 0.5 + 0.1 - 0.3 = 0.3
@pytest.mark.parametrize('pset_mode', pset_modes)
@pytest.mark.parametrize('mode', ['scipy', 'jit'])
def test_statuscode_repeat(fieldset, pset_mode, mode):
def simpleKernel(particle, fieldset, time):
if particle.lon > .1 and time < 1.:
# if particle.lon is not re-setted before kernel repetition, it will break here
return ErrorCode.Error
particle.lon += 0.1
if particle.dt > 1.49:
# dt is used to leave the repetition loop (dt is the only variable not re-setted)
return StateCode.Success
particle.dt += .1
return OperationCode.Repeat
pset = pset_type[pset_mode]['pset'](fieldset, pclass=ptype[mode], lon=[0.], lat=[0.])
pset.execute(pset.Kernel(simpleKernel), endtime=3., dt=1.)
@pytest.mark.parametrize('pset_mode', pset_modes)
@pytest.mark.parametrize('delete_cfiles', [True, False])
@pytest.mark.skipif(sys.platform.startswith("win"), reason="skipping windows test as windows compiler generates warning")
def test_execution_keep_cfiles_and_nocompilation_warnings(pset_mode, fieldset, delete_cfiles):
pset = pset_type[pset_mode]['pset'](fieldset, pclass=JITParticle, lon=[0.], lat=[0.])
pset.execute(pset.Kernel(AdvectionRK4, delete_cfiles=delete_cfiles), endtime=1., dt=1.)
cfile = pset.kernel.src_file
logfile = pset.kernel.log_file
del pset.kernel
if delete_cfiles:
assert not path.exists(cfile)
else:
assert path.exists(cfile)
with open(logfile) as f:
assert 'warning' not in f.read(), 'Compilation WARNING in log file'
def test_compilers():
from parcels.compilation.codecompiler import (
CCompiler_SS,
Clang_parameters,
MinGW_parameters,
VS_parameters,
)
for param_class in [Clang_parameters, MinGW_parameters, VS_parameters]:
params = param_class() # noqa
print(CCompiler_SS())