-
Notifications
You must be signed in to change notification settings - Fork 38
/
test_recipe.py
1657 lines (1452 loc) · 50.7 KB
/
test_recipe.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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import os
from pathlib import Path
from pprint import pformat
from textwrap import dedent
import iris
import pytest
import yaml
from mock import create_autospec
import esmvalcore
from esmvalcore._recipe import TASKSEP, read_recipe_file
from esmvalcore._recipe_checks import RecipeError
from esmvalcore._task import DiagnosticTask
from esmvalcore.preprocessor import DEFAULT_ORDER, PreprocessingTask
from esmvalcore.preprocessor._io import concatenate_callback
from .test_diagnostic_run import write_config_user_file
from .test_provenance import check_provenance
MANDATORY_DATASET_KEYS = (
'cmor_table',
'dataset',
'diagnostic',
'end_year',
'filename',
'frequency',
'institute',
'long_name',
'mip',
'modeling_realm',
'preprocessor',
'project',
'short_name',
'standard_name',
'start_year',
'units',
)
MANDATORY_SCRIPT_SETTINGS_KEYS = (
'log_level',
'script',
'plot_dir',
'run_dir',
'work_dir',
)
DEFAULT_PREPROCESSOR_STEPS = (
'cleanup',
'cmor_check_data',
'cmor_check_metadata',
'concatenate',
'extract_time',
'fix_data',
'fix_file',
'fix_metadata',
'load',
'save',
)
@pytest.fixture
def config_user(tmp_path):
filename = write_config_user_file(tmp_path)
cfg = esmvalcore._config.read_config_user_file(filename, 'recipe_test')
cfg['synda_download'] = False
return cfg
def create_test_file(filename, tracking_id=None):
dirname = os.path.dirname(filename)
if not os.path.exists(dirname):
os.makedirs(dirname)
attributes = {}
if tracking_id is not None:
attributes['tracking_id'] = tracking_id
cube = iris.cube.Cube([], attributes=attributes)
iris.save(cube, filename)
def _get_filenames(root_path, filenames, tracking_id):
filename = filenames[0]
filename = str(root_path / 'input' / filename)
filenames = []
if filename.endswith('[_.]*nc'):
# Restore when we support filenames with no dates
# filenames.append(filename.replace('[_.]*nc', '.nc'))
filename = filename.replace('[_.]*nc', '_*.nc')
if filename.endswith('*.nc'):
filename = filename[:-len('*.nc')] + '_'
intervals = [
'1990_1999',
'2000_2009',
'2010_2019',
]
for interval in intervals:
filenames.append(filename + interval + '.nc')
else:
filenames.append(filename)
for filename in filenames:
create_test_file(filename, next(tracking_id))
return filenames
@pytest.fixture
def patched_datafinder(tmp_path, monkeypatch):
def tracking_ids(i=0):
while True:
yield i
i += 1
tracking_id = tracking_ids()
def find_files(_, filenames):
# Any occurrence of [something] in filename should have
# been replaced before this function is called.
for filename in filenames:
assert '{' not in filename
return _get_filenames(tmp_path, filenames, tracking_id)
monkeypatch.setattr(esmvalcore._data_finder, 'find_files', find_files)
@pytest.fixture
def patched_failing_datafinder(tmp_path, monkeypatch):
def tracking_ids(i=0):
while True:
yield i
i += 1
tracking_id = tracking_ids()
def find_files(_, filenames):
# Any occurrence of [something] in filename should have
# been replaced before this function is called.
for filename in filenames:
assert '{' not in filename
# Fail for specified fx variables
for filename in filenames:
if 'fx_' in filename:
return []
if 'sftlf' in filename:
return []
return _get_filenames(tmp_path, filenames, tracking_id)
monkeypatch.setattr(esmvalcore._data_finder, 'find_files', find_files)
@pytest.fixture
def patched_tas_derivation(monkeypatch):
def get_required(short_name, _):
if short_name != 'tas':
assert False
required = [
{'short_name': 'pr'},
{'short_name': 'areacella', 'mip': 'fx', 'optional': True},
]
return required
monkeypatch.setattr(
esmvalcore._recipe, 'get_required', get_required)
DEFAULT_DOCUMENTATION = dedent("""
documentation:
description: This is a test recipe.
authors:
- andela_bouwe
references:
- contact_authors
- acknow_project
projects:
- c3s-magic
""")
def get_recipe(tempdir, content, cfg):
"""Save and load recipe content."""
recipe_file = tempdir / 'recipe_test.yml'
# Add mandatory documentation section
content = str(DEFAULT_DOCUMENTATION + content)
recipe_file.write_text(content)
recipe = read_recipe_file(str(recipe_file), cfg)
return recipe
def test_simple_recipe(tmp_path, patched_datafinder, config_user):
script = tmp_path / 'diagnostic.py'
script.write_text('')
content = dedent("""
datasets:
- dataset: bcc-csm1-1
preprocessors:
preprocessor_name:
extract_levels:
levels: 85000
scheme: nearest
diagnostics:
diagnostic_name:
additional_datasets:
- dataset: GFDL-ESM2G
variables:
ta:
preprocessor: preprocessor_name
project: CMIP5
mip: Amon
exp: historical
ensemble: r1i1p1
start_year: 1999
end_year: 2002
additional_datasets:
- dataset: MPI-ESM-LR
scripts:
script_name:
script: {}
custom_setting: 1
""".format(script))
recipe = get_recipe(tmp_path, content, config_user)
raw = yaml.safe_load(content)
# Perform some sanity checks on recipe expansion/normalization
print("Expanded recipe:")
assert len(recipe.diagnostics) == len(raw['diagnostics'])
for diagnostic_name, diagnostic in recipe.diagnostics.items():
print(pformat(diagnostic))
source = raw['diagnostics'][diagnostic_name]
# Check that 'variables' have been read and updated
assert len(diagnostic['preprocessor_output']) == len(
source['variables'])
for variable_name, variables in diagnostic[
'preprocessor_output'].items():
assert len(variables) == 3
for variable in variables:
for key in MANDATORY_DATASET_KEYS:
assert key in variable and variable[key]
assert variable_name == variable['short_name']
# Check that the correct tasks have been created
variables = recipe.diagnostics['diagnostic_name']['preprocessor_output'][
'ta']
tasks = {t for task in recipe.tasks for t in task.flatten()}
preproc_tasks = {t for t in tasks if isinstance(t, PreprocessingTask)}
diagnostic_tasks = {t for t in tasks if isinstance(t, DiagnosticTask)}
assert len(preproc_tasks) == 1
for task in preproc_tasks:
print("Task", task.name)
assert task.order == list(DEFAULT_ORDER)
for product in task.products:
variable = [
v for v in variables if v['filename'] == product.filename
][0]
assert product.attributes == variable
for step in DEFAULT_PREPROCESSOR_STEPS:
assert step in product.settings
assert len(product.files) == 2
assert len(diagnostic_tasks) == 1
for task in diagnostic_tasks:
print("Task", task.name)
assert task.ancestors == list(preproc_tasks)
assert task.script == str(script)
for key in MANDATORY_SCRIPT_SETTINGS_KEYS:
assert key in task.settings and task.settings[key]
assert task.settings['custom_setting'] == 1
def test_fx_preproc_error(tmp_path, patched_datafinder, config_user):
script = tmp_path / 'diagnostic.py'
script.write_text('')
content = dedent("""
datasets:
- dataset: bcc-csm1-1
preprocessors:
preprocessor_name:
extract_season:
season: MAM
diagnostics:
diagnostic_name:
variables:
sftlf:
preprocessor: preprocessor_name
project: CMIP5
mip: fx
exp: historical
ensemble: r0i0p0
start_year: 1999
end_year: 2002
additional_datasets:
- dataset: MPI-ESM-LR
scripts: null
""")
rec_err = "Time coordinate preprocessor step extract_season \
not permitted on fx vars \
please remove them from recipe."
with pytest.raises(Exception) as rec_err_exp:
get_recipe(tmp_path, content, config_user)
assert rec_err == rec_err_exp
def test_default_preprocessor(tmp_path, patched_datafinder, config_user):
content = dedent("""
diagnostics:
diagnostic_name:
variables:
chl:
project: CMIP5
mip: Oyr
exp: historical
start_year: 2000
end_year: 2005
ensemble: r1i1p1
additional_datasets:
- {dataset: CanESM2}
scripts: null
""")
recipe = get_recipe(tmp_path, content, config_user)
assert len(recipe.tasks) == 1
task = recipe.tasks.pop()
assert len(task.products) == 1
product = task.products.pop()
preproc_dir = os.path.dirname(product.filename)
assert preproc_dir.startswith(str(tmp_path))
fix_dir = os.path.join(
preproc_dir, 'CMIP5_CanESM2_Oyr_historical_r1i1p1_chl_2000-2005_fixed')
defaults = {
'load': {
'callback': concatenate_callback,
},
'concatenate': {},
'fix_file': {
'project': 'CMIP5',
'dataset': 'CanESM2',
'short_name': 'chl',
'output_dir': fix_dir,
},
'fix_data': {
'project': 'CMIP5',
'dataset': 'CanESM2',
'short_name': 'chl',
'cmor_table': 'CMIP5',
'mip': 'Oyr',
'frequency': 'yr',
},
'fix_metadata': {
'project': 'CMIP5',
'dataset': 'CanESM2',
'short_name': 'chl',
'cmor_table': 'CMIP5',
'mip': 'Oyr',
'frequency': 'yr',
},
'extract_time': {
'start_year': 2000,
'end_year': 2006,
'start_month': 1,
'end_month': 1,
'start_day': 1,
'end_day': 1,
},
'cmor_check_metadata': {
'cmor_table': 'CMIP5',
'mip': 'Oyr',
'short_name': 'chl',
'frequency': 'yr',
},
'cmor_check_data': {
'cmor_table': 'CMIP5',
'mip': 'Oyr',
'short_name': 'chl',
'frequency': 'yr',
},
'cleanup': {
'remove': [fix_dir]
},
'save': {
'compress': False,
'filename': product.filename,
}
}
assert product.settings == defaults
def test_default_fx_preprocessor(tmp_path, patched_datafinder, config_user):
content = dedent("""
diagnostics:
diagnostic_name:
variables:
sftlf:
project: CMIP5
mip: fx
exp: historical
ensemble: r0i0p0
additional_datasets:
- {dataset: CanESM2}
scripts: null
""")
recipe = get_recipe(tmp_path, content, config_user)
assert len(recipe.tasks) == 1
task = recipe.tasks.pop()
assert len(task.products) == 1
product = task.products.pop()
preproc_dir = os.path.dirname(product.filename)
assert preproc_dir.startswith(str(tmp_path))
fix_dir = os.path.join(
preproc_dir,
'CMIP5_CanESM2_fx_historical_r0i0p0_sftlf_fixed')
defaults = {
'load': {
'callback': concatenate_callback,
},
'concatenate': {},
'fix_file': {
'project': 'CMIP5',
'dataset': 'CanESM2',
'short_name': 'sftlf',
'output_dir': fix_dir,
},
'fix_data': {
'project': 'CMIP5',
'dataset': 'CanESM2',
'short_name': 'sftlf',
'cmor_table': 'CMIP5',
'mip': 'fx',
'frequency': 'fx',
},
'fix_metadata': {
'project': 'CMIP5',
'dataset': 'CanESM2',
'short_name': 'sftlf',
'cmor_table': 'CMIP5',
'mip': 'fx',
'frequency': 'fx',
},
'cmor_check_metadata': {
'cmor_table': 'CMIP5',
'mip': 'fx',
'short_name': 'sftlf',
'frequency': 'fx',
},
'cmor_check_data': {
'cmor_table': 'CMIP5',
'mip': 'fx',
'short_name': 'sftlf',
'frequency': 'fx',
},
'cleanup': {
'remove': [fix_dir]
},
'save': {
'compress': False,
'filename': product.filename,
}
}
assert product.settings == defaults
def test_empty_variable(tmp_path, patched_datafinder, config_user):
"""Test that it is possible to specify all information in the dataset."""
content = dedent("""
diagnostics:
diagnostic_name:
additional_datasets:
- dataset: CanESM2
project: CMIP5
mip: Amon
exp: historical
start_year: 2000
end_year: 2005
ensemble: r1i1p1
variables:
pr:
scripts: null
""")
recipe = get_recipe(tmp_path, content, config_user)
assert len(recipe.tasks) == 1
task = recipe.tasks.pop()
assert len(task.products) == 1
product = task.products.pop()
assert product.attributes['short_name'] == 'pr'
assert product.attributes['dataset'] == 'CanESM2'
def test_cmip5_variable_autocomplete(tmp_path, patched_datafinder,
config_user):
"""Test that required information is automatically added for CMIP5."""
content = dedent("""
diagnostics:
test:
additional_datasets:
- dataset: CanESM2
project: CMIP5
mip: 3hr
exp: historical
start_year: 2000
end_year: 2001
ensemble: r1i1p1
variables:
pr:
scripts: null
""")
recipe = get_recipe(tmp_path, content, config_user)
variable = recipe.diagnostics['test']['preprocessor_output']['pr'][0]
reference = {
'dataset': 'CanESM2',
'diagnostic': 'test',
'end_year': 2001,
'ensemble': 'r1i1p1',
'exp': 'historical',
'frequency': '3hr',
'institute': ['CCCma'],
'long_name': 'Precipitation',
'mip': '3hr',
'modeling_realm': ['atmos'],
'preprocessor': 'default',
'project': 'CMIP5',
'short_name': 'pr',
'standard_name': 'precipitation_flux',
'start_year': 2000,
'units': 'kg m-2 s-1',
}
for key in reference:
assert variable[key] == reference[key]
def test_cmip6_variable_autocomplete(tmp_path, patched_datafinder,
config_user):
"""Test that required information is automatically added for CMIP6."""
content = dedent("""
diagnostics:
test:
additional_datasets:
- dataset: HadGEM3-GC31-LL
project: CMIP6
mip: 3hr
exp: historical
start_year: 2000
end_year: 2001
ensemble: r2i1p1f1
grid: gn
variables:
pr:
scripts: null
""")
recipe = get_recipe(tmp_path, content, config_user)
variable = recipe.diagnostics['test']['preprocessor_output']['pr'][0]
reference = {
'activity': 'CMIP',
'dataset': 'HadGEM3-GC31-LL',
'diagnostic': 'test',
'end_year': 2001,
'ensemble': 'r2i1p1f1',
'exp': 'historical',
'frequency': '3hr',
'grid': 'gn',
'institute': ['MOHC'],
'long_name': 'Precipitation',
'mip': '3hr',
'modeling_realm': ['atmos'],
'preprocessor': 'default',
'project': 'CMIP6',
'short_name': 'pr',
'standard_name': 'precipitation_flux',
'start_year': 2000,
'units': 'kg m-2 s-1',
}
for key in reference:
assert variable[key] == reference[key]
def test_reference_dataset(tmp_path, patched_datafinder, config_user,
monkeypatch):
levels = [100]
get_reference_levels = create_autospec(
esmvalcore._recipe.get_reference_levels, return_value=levels)
monkeypatch.setattr(esmvalcore._recipe, 'get_reference_levels',
get_reference_levels)
content = dedent("""
preprocessors:
test_from_reference:
regrid:
target_grid: reference_dataset
scheme: linear
extract_levels:
levels: reference_dataset
scheme: linear
test_from_cmor_table:
extract_levels:
levels:
cmor_table: CMIP6
coordinate: alt16
scheme: nearest
diagnostics:
diagnostic_name:
variables:
ta: &var
preprocessor: test_from_reference
project: CMIP5
mip: Amon
exp: historical
start_year: 2000
end_year: 2005
ensemble: r1i1p1
additional_datasets:
- {dataset: GFDL-CM3}
- {dataset: MPI-ESM-LR}
reference_dataset: MPI-ESM-LR
ch4:
<<: *var
preprocessor: test_from_cmor_table
additional_datasets:
- {dataset: GFDL-CM3}
scripts: null
""")
recipe = get_recipe(tmp_path, content, config_user)
assert len(recipe.tasks) == 2
# Check that the reference dataset has been used
task = next(t for t in recipe.tasks
if t.name == 'diagnostic_name' + TASKSEP + 'ta')
assert len(task.products) == 2
product = next(p for p in task.products
if p.attributes['dataset'] == 'GFDL-CM3')
reference = next(p for p in task.products
if p.attributes['dataset'] == 'MPI-ESM-LR')
assert product.settings['regrid']['target_grid'] == reference.files[0]
assert product.settings['extract_levels']['levels'] == levels
fix_dir = os.path.splitext(reference.filename)[0] + '_fixed'
get_reference_levels.assert_called_once_with(
reference.files[0],
'CMIP5',
'MPI-ESM-LR',
'ta',
fix_dir,
)
assert 'regrid' not in reference.settings
assert 'extract_levels' not in reference.settings
# Check that levels have been read from CMOR table
task = next(t for t in recipe.tasks
if t.name == 'diagnostic_name' + TASKSEP + 'ch4')
assert len(task.products) == 1
product = next(iter(task.products))
assert product.settings['extract_levels']['levels'] == [
0,
250,
750,
1250,
1750,
2250,
2750,
3500,
4500,
6000,
8000,
10000,
12000,
14500,
16000,
18000,
]
def test_custom_preproc_order(tmp_path, patched_datafinder, config_user):
content = dedent("""
preprocessors:
default: &default
area_statistics:
operator: mean
multi_model_statistics:
span: overlap
statistics: [mean ]
custom:
custom_order: true
<<: *default
diagnostics:
diagnostic_name:
variables:
chl_default: &chl
short_name: chl
preprocessor: default
project: CMIP5
mip: Oyr
exp: historical
start_year: 2000
end_year: 2005
ensemble: r1i1p1
additional_datasets:
- {dataset: CanESM2}
chl_custom:
<<: *chl
preprocessor: custom
scripts: null
""")
recipe = get_recipe(tmp_path, content, config_user)
assert len(recipe.tasks) == 2
default = next(t for t in recipe.tasks if tuple(t.order) == DEFAULT_ORDER)
custom = next(t for t in recipe.tasks if tuple(t.order) != DEFAULT_ORDER)
assert custom.order.index('area_statistics') < custom.order.index(
'multi_model_statistics')
assert default.order.index('area_statistics') > default.order.index(
'multi_model_statistics')
def test_derive(tmp_path, patched_datafinder, config_user):
content = dedent("""
diagnostics:
diagnostic_name:
variables:
toz:
project: CMIP5
mip: Amon
exp: historical
start_year: 2000
end_year: 2005
derive: true
force_derivation: true
additional_datasets:
- {dataset: GFDL-CM3, ensemble: r1i1p1}
scripts: null
""")
recipe = get_recipe(tmp_path, content, config_user)
# Check generated tasks
assert len(recipe.tasks) == 1
task = recipe.tasks.pop()
assert task.name == 'diagnostic_name' + TASKSEP + 'toz'
assert len(task.ancestors) == 2
assert 'diagnostic_name' + TASKSEP + 'toz_derive_input_ps' in [
t.name for t in task.ancestors
]
assert 'diagnostic_name' + TASKSEP + 'toz_derive_input_tro3' in [
t.name for t in task.ancestors
]
# Check product content of tasks
assert len(task.products) == 1
product = task.products.pop()
assert 'derive' in product.settings
assert product.attributes['short_name'] == 'toz'
assert product.files
ps_product = next(p for a in task.ancestors for p in a.products
if p.attributes['short_name'] == 'ps')
tro3_product = next(p for a in task.ancestors for p in a.products
if p.attributes['short_name'] == 'tro3')
assert ps_product.filename in product.files
assert tro3_product.filename in product.files
def test_derive_not_needed(tmp_path, patched_datafinder, config_user):
content = dedent("""
diagnostics:
diagnostic_name:
variables:
toz:
project: CMIP5
mip: Amon
exp: historical
start_year: 2000
end_year: 2005
derive: true
force_derivation: false
additional_datasets:
- {dataset: GFDL-CM3, ensemble: r1i1p1}
scripts: null
""")
recipe = get_recipe(tmp_path, content, config_user)
# Check generated tasks
assert len(recipe.tasks) == 1
task = recipe.tasks.pop()
assert task.name == 'diagnostic_name/toz'
assert len(task.ancestors) == 1
ancestor = [t for t in task.ancestors][0]
assert ancestor.name == 'diagnostic_name/toz_derive_input_toz'
# Check product content of tasks
assert len(task.products) == 1
product = task.products.pop()
assert product.attributes['short_name'] == 'toz'
assert 'derive' in product.settings
assert len(ancestor.products) == 1
ancestor_product = ancestor.products.pop()
assert ancestor_product.filename in product.files
assert ancestor_product.attributes['short_name'] == 'toz'
assert 'derive' not in ancestor_product.settings
# Check that fixes are applied just once
fixes = ('fix_file', 'fix_metadata', 'fix_data')
for fix in fixes:
assert fix in ancestor_product.settings
assert fix not in product.settings
def test_derive_with_fx_ohc(tmp_path, patched_datafinder, config_user):
content = dedent("""
diagnostics:
diagnostic_name:
variables:
ohc:
mip: Omon
exp: historical
start_year: 2000
end_year: 2005
derive: true
force_derivation: true
additional_datasets:
- {dataset: GFDL-CM3, ensemble: r1i1p1, project: CMIP5}
- {dataset: GFDL-CM4, ensemble: r1i1p1f1, project: CMIP6,
grid: gr1}
- {dataset: TEST, project: OBS, type: reanaly, version: 1,
tier: 1}
scripts: null
""")
recipe = get_recipe(tmp_path, content, config_user)
# Check generated tasks
assert len(recipe.tasks) == 1
task = recipe.tasks.pop()
assert task.name == 'diagnostic_name' + TASKSEP + 'ohc'
# Check products
all_product_files = []
assert len(task.products) == 3
for product in task.products:
assert 'derive' in product.settings
assert product.attributes['short_name'] == 'ohc'
all_product_files.extend(product.files)
# Check ancestors
assert len(task.ancestors) == 2
assert task.ancestors[0].name == (
'diagnostic_name/ohc_derive_input_thetao')
assert task.ancestors[1].name == (
'diagnostic_name/ohc_derive_input_volcello')
for ancestor_product in task.ancestors[0].products:
assert ancestor_product.attributes['short_name'] == 'thetao'
assert ancestor_product.filename in all_product_files
for ancestor_product in task.ancestors[1].products:
assert ancestor_product.attributes['short_name'] == 'volcello'
if ancestor_product.attributes['project'] == 'CMIP6':
assert ancestor_product.attributes['mip'] == 'Ofx'
else:
assert ancestor_product.attributes['mip'] == 'fx'
assert ancestor_product.filename in all_product_files
def test_derive_with_fx_ohc_fail(tmp_path,
patched_failing_datafinder,
config_user):
content = dedent("""
diagnostics:
diagnostic_name:
variables:
ohc:
mip: Omon
exp: historical
start_year: 2000
end_year: 2005
derive: true
force_derivation: true
additional_datasets:
- {dataset: GFDL-CM3, ensemble: r1i1p1, project: CMIP5}
- {dataset: GFDL-CM4, ensemble: r1i1p1f1, project: CMIP6,
grid: gr1}
- {dataset: TEST, project: OBS, type: reanaly, version: 1,
tier: 1}
scripts: null
""")
with pytest.raises(RecipeError):
get_recipe(tmp_path, content, config_user)
def test_derive_with_optional_var(tmp_path,
patched_datafinder,
patched_tas_derivation,
config_user):
content = dedent("""
diagnostics:
diagnostic_name:
variables:
tas:
mip: Amon
exp: historical
start_year: 2000
end_year: 2005
derive: true
force_derivation: true
additional_datasets:
- {dataset: GFDL-CM3, ensemble: r1i1p1, project: CMIP5}
- {dataset: GFDL-CM4, ensemble: r1i1p1f1, project: CMIP6,
grid: gr1}
- {dataset: TEST, project: OBS, type: reanaly, version: 1,
tier: 1}
scripts: null
""")
recipe = get_recipe(tmp_path, content, config_user)
# Check generated tasks
assert len(recipe.tasks) == 1
task = recipe.tasks.pop()
assert task.name == 'diagnostic_name' + TASKSEP + 'tas'
# Check products
all_product_files = []
assert len(task.products) == 3
for product in task.products:
assert 'derive' in product.settings
assert product.attributes['short_name'] == 'tas'
all_product_files.extend(product.files)
# Check ancestors
assert len(task.ancestors) == 2
assert task.ancestors[0].name == (
'diagnostic_name/tas_derive_input_pr')
assert task.ancestors[1].name == (
'diagnostic_name/tas_derive_input_areacella')
for ancestor_product in task.ancestors[0].products:
assert ancestor_product.attributes['short_name'] == 'pr'
assert ancestor_product.filename in all_product_files
for ancestor_product in task.ancestors[1].products:
assert ancestor_product.attributes['short_name'] == 'areacella'
assert ancestor_product.filename in all_product_files
def test_derive_with_optional_var_nodata(tmp_path,
patched_failing_datafinder,
patched_tas_derivation,
config_user):
content = dedent("""
diagnostics:
diagnostic_name:
variables:
tas:
mip: Amon
exp: historical
start_year: 2000
end_year: 2005
derive: true
force_derivation: true
additional_datasets:
- {dataset: GFDL-CM3, ensemble: r1i1p1, project: CMIP5}
- {dataset: GFDL-CM4, ensemble: r1i1p1f1, project: CMIP6,
grid: gr1}
- {dataset: TEST, project: OBS, type: reanaly, version: 1,
tier: 1}
scripts: null