-
Notifications
You must be signed in to change notification settings - Fork 64
Expand file tree
/
Copy pathtest_dataarray.py
More file actions
1492 lines (1114 loc) · 43.6 KB
/
Copy pathtest_dataarray.py
File metadata and controls
1492 lines (1114 loc) · 43.6 KB
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
from datetime import datetime
from pathlib import Path
import numpy as np
import pandas as pd
import matplotlib.pyplot as plt
import pytest
import mikeio
from mikeio import EUMType, EUMUnit, ItemInfo, Mesh, DataArray
from mikeio.exceptions import OutsideModelDomainError
@pytest.fixture
def da0() -> mikeio.DataArray:
time = "2000-01-01 00:00:00"
da = mikeio.DataArray(
data=np.array([7.0]),
time=time,
item=ItemInfo(name="Foo"),
)
return da
@pytest.fixture
def da1() -> mikeio.DataArray:
nt = 10
start = 10.0
time = pd.date_range(start="2000-01-01", freq="s", periods=nt)
da = mikeio.DataArray(
data=np.arange(start, start + nt, dtype=float),
time=time,
item=ItemInfo(name="Foo"),
)
return da
@pytest.fixture
def da2() -> mikeio.DataArray:
nt = 10
nx = 7
da = mikeio.DataArray(
data=np.zeros([nt, nx]) + 0.1,
time=pd.date_range(start="2000-01-01", freq="s", periods=nt),
item=ItemInfo("Foo"),
geometry=mikeio.Grid1D(x0=1000.0, dx=10.0, nx=nx),
)
return da
@pytest.fixture
def da_grid2d() -> mikeio.DataArray:
nt = 10
nx = 7
ny = 14
da = mikeio.DataArray(
data=np.zeros([nt, ny, nx]) + 0.1,
time=pd.date_range(start="2000-01-01", freq="h", periods=nt),
item=ItemInfo("Foo"),
geometry=mikeio.Grid2D(x0=10.0, dx=0.1, nx=nx, ny=ny, dy=1.0, y0=-10.0),
)
return da
@pytest.fixture
def da_grid2d_proj() -> mikeio.DataArray:
nt = 10
nx = 7
ny = 14
da = mikeio.DataArray(
data=np.zeros([nt, ny, nx]) + 0.1,
time=pd.date_range(start="2000-01-01", freq="s", periods=nt),
item=ItemInfo("Foo"),
geometry=mikeio.Grid2D(
x0=1000, dx=100, nx=nx, ny=ny, dy=10, y0=2000, projection="UTM-32"
),
)
return da
@pytest.fixture
def da_time_space() -> DataArray:
nt = 10
time = pd.date_range(start="2000-01-01", freq="s", periods=nt)
da = mikeio.DataArray(
data=np.zeros(shape=(nt, 2), dtype=float),
time=time,
item=ItemInfo(name="Foo"),
geometry=mikeio.Grid1D(nx=2, dx=1.0),
)
return da
def test_concat_dataarray_by_time() -> None:
da1 = mikeio.read("tests/testdata/tide1.dfs1")[0]
da2 = mikeio.read("tests/testdata/tide2.dfs1")[0]
da3 = mikeio.DataArray.concat([da1, da2])
assert da3.start_time == da1.start_time
assert da3.start_time < da2.start_time
assert da3.end_time == da2.end_time
assert da3.end_time > da1.end_time
assert da3.n_timesteps == 145
assert da3.is_equidistant
def test_write_1d(da2: DataArray, tmp_path: Path) -> None:
outfilename = tmp_path / "grid1d.dfs1"
da2.to_dfs(outfilename)
ds = mikeio.read(outfilename)
assert ds.n_items == 1
assert isinstance(ds.geometry, mikeio.Grid1D)
def test_dataset_with_asterisk(da2: DataArray) -> None:
da2.name = "Foo * Bar"
ds1 = mikeio.Dataset([da2], validate=False)
assert ds1[0].name == "Foo * Bar"
ds2 = mikeio.Dataset({"Foo * Bar": da2})
assert ds2[0].name == "Foo * Bar"
def test_data_0d(da0: DataArray) -> None:
assert da0.ndim == 1
assert da0.dims == ("time",)
assert "values" in repr(da0)
assert "values" in repr(da0[:4])
da0 = da0.squeeze()
assert da0.ndim == 0
assert "values" in repr(da0)
def test_dataarray_init() -> None:
nt = 10
start = 10.0
data = np.arange(start, start + nt, dtype=float)
time = pd.date_range(start="2000-01-01", freq="s", periods=nt)
item = ItemInfo(name="Foo")
da = mikeio.DataArray(data=data, time=time)
assert isinstance(da, mikeio.DataArray)
assert da.name == "NoName" # default name
assert da.item.type == EUMType.Undefined
da = mikeio.DataArray(data=data, time=time, item=item)
assert isinstance(da, mikeio.DataArray)
assert da.name == "Foo"
assert da.ndim == 1
assert da.dims == ("time",)
da = mikeio.DataArray(data=data, time="2018")
assert isinstance(da, mikeio.DataArray)
assert da.n_timesteps == 1
assert da.ndim == 1
assert da.dims == ("x",)
da = mikeio.DataArray(data=data)
assert da.n_timesteps == 1
assert da.ndim == 1
assert da.dims == ("x",)
assert da.time[0] == pd.Timestamp(2018, 1, 1)
def test_dataarray_init_no_item() -> None:
nt = 10
data = data = np.zeros([nt, 4]) + 0.1
time = time = pd.date_range(start="2000-01-01", freq="s", periods=nt)
da = mikeio.DataArray(data=data, time=time)
assert da.type == EUMType.Undefined
assert da.unit == EUMUnit.undefined
def test_dataarray_init_2d() -> None:
nt = 10
time = pd.date_range(start="2000-01-01", freq="s", periods=nt)
# 2d with time
ny, nx = 5, 6
data2d = np.zeros([nt, ny, nx]) + 0.1
da = mikeio.DataArray(data=data2d, time=time)
assert da.ndim == 3
assert da.dims == ("time", "y", "x")
# singleton time, requires spec of dims
dims = ("time", "y", "x")
data2d = np.zeros([1, ny, nx]) + 0.1
da = mikeio.DataArray(data=data2d, time="2018", dims=dims)
assert isinstance(da, mikeio.DataArray)
assert da.n_timesteps == 1
assert da.ndim == 3
assert da.dims == dims
# no time
data2d = np.zeros([ny, nx]) + 0.1
da = mikeio.DataArray(data=data2d, time="2018")
assert isinstance(da, mikeio.DataArray)
assert da.n_timesteps == 1
assert da.ndim == 2
assert da.dims == ("y", "x")
# x, y swapped
dims = ("x", "y")
data2d = np.zeros([nx, ny]) + 0.1
da = mikeio.DataArray(data=data2d, time="2018", dims=dims)
assert da.n_timesteps == 1
assert da.ndim == 2
assert da.dims == dims
def test_dataarray_init_wrong_dim() -> None:
nt = 10
start = 10.0
data = np.arange(start, start + nt, dtype=float)
time_long = pd.date_range(start="2000-01-01", freq="s", periods=(nt + 1))
item = ItemInfo(name="Foo")
with pytest.raises(ValueError):
mikeio.DataArray(data=data, time=time_long, item=item)
nt, ny, nx = 10, 5, 6
data2d = np.zeros([nt, ny, nx]) + 0.1
with pytest.raises(ValueError):
mikeio.DataArray(data=data2d, time=time_long)
# time must be first dim
dims = ("x", "y", "time")
time = pd.date_range(start="2000-01-01", freq="s", periods=nt)
with pytest.raises(ValueError):
mikeio.DataArray(data=data2d, time=time, dims=dims)
# time must be first dim
data2d = np.zeros([ny, nt, nx]) + 0.1
with pytest.raises(ValueError):
mikeio.DataArray(data=data2d, time=time)
def test_dataarray_init_grid1d() -> None:
nt = 10
nx = 5
time = pd.date_range(start="2000-01-01", freq="s", periods=nt)
data = np.zeros([nt, nx]) + 0.1
g = mikeio.Grid1D(nx=nx, dx=1.0)
da = mikeio.DataArray(data=data, time=time, geometry=g)
assert da.ndim == 2
assert da.dims == ("time", "x")
# singleton time
data = np.zeros([1, nx]) + 0.1
da = mikeio.DataArray(data=data, time="2018", geometry=g)
assert da.ndim == 2
assert da.dims == ("time", "x")
# no time
data = np.zeros([nx]) + 0.1
da = mikeio.DataArray(data=data, time="2018", geometry=g)
assert da.ndim == 1
assert da.dims == ("x",)
def test_dataarray_init_grid2d() -> None:
nt = 10
ny, nx = 7, 5
time = pd.date_range(start="2000-01-01", freq="s", periods=nt)
data = np.zeros([nt, ny, nx]) + 0.1
g = mikeio.Grid2D(dx=0.5, nx=nx, ny=ny)
da = mikeio.DataArray(data=data, time=time, geometry=g)
assert da.ndim == 3
assert da.dims == ("time", "y", "x")
# singleton time
data = np.zeros([1, ny, nx]) + 0.1
da = mikeio.DataArray(data=data, time="2018", geometry=g)
assert da.ndim == 3
assert da.dims == ("time", "y", "x") # TODO: fails
# no time
data = np.zeros([ny, nx]) + 0.1
da = mikeio.DataArray(data=data, time="2018", geometry=g)
assert da.ndim == 2
assert da.dims == ("y", "x")
def test_dataarray_init_dfsu2d() -> None:
nt = 10
time = pd.date_range(start="2000-01-01", freq="s", periods=nt)
filename = "tests/testdata/north_sea_2.mesh"
msh = Mesh(filename)
g = msh.geometry
ne = g.n_elements
# time-varying
data = np.zeros([nt, ne]) + 0.1
da = mikeio.DataArray(data=data, time=time, geometry=g)
assert da.ndim == 2
assert da.dims == ("time", "element")
assert da.geometry == g
# singleton time
data = np.zeros([1, ne]) + 0.1
da = mikeio.DataArray(data=data, time="2018", geometry=g)
assert da.ndim == 2
assert da.dims == ("time", "element") # TODO: fails
assert da.n_timesteps == 1
# no time
data = np.zeros([ne]) + 0.1
da = mikeio.DataArray(data=data, time="2018", geometry=g)
assert da.ndim == 1
assert da.dims == ("element",)
def test_dataarray_init_dfsu3d() -> None:
nt = 10
time = pd.date_range(start="2000-01-01", freq="s", periods=nt)
filename = "tests/testdata/basin_3d.dfsu"
dfs = mikeio.Dfsu3D(filename)
g = dfs.geometry
ne = g.n_elements
# time-varying
data = np.zeros([nt, ne]) + 0.1
da = mikeio.DataArray(data=data, time=time, geometry=g)
assert da.ndim == 2
assert da.dims == ("time", "element")
assert da.geometry == g
# singleton time
data = np.zeros([1, ne]) + 0.1
da = mikeio.DataArray(data=data, time="2018", geometry=g)
assert da.ndim == 2
assert da.dims == ("time", "element") # TODO: fails
# no time
data = np.zeros([ne]) + 0.1
da = mikeio.DataArray(data=data, time="2018", geometry=g)
assert da.ndim == 1
assert da.dims == ("element",)
def test_dataarray_indexing(da1: mikeio.DataArray) -> None:
assert da1.shape == (10,)
subset = da1[3]
assert isinstance(subset, mikeio.DataArray)
assert da1.shape == (10,)
assert subset.to_numpy() == np.array([13.0])
def test_dataarray_dfsu3d_indexing() -> None:
filename = "tests/testdata/oresund_sigma_z.dfsu"
ds = mikeio.read(filename)
sal = ds["Salinity"]
assert isinstance(ds["Salinity"].geometry, mikeio.spatial.GeometryFM3D)
# indexing in time selecting a single record
da = sal[0, :] # type: ignore
assert isinstance(da.geometry, mikeio.spatial.GeometryFM3D)
# indexing in space selecting a single element
da = sal[:, 0] # type: ignore
assert isinstance(da.geometry, mikeio.spatial.GeometryPoint3D)
# indexing in space selecting a multiple elements with slice
da = sal[:, 0:45] # type: ignore
assert isinstance(da.geometry, mikeio.spatial.GeometryFM3D)
# indexing in space selecting a multiple elements with tuple
da = sal[:, (3, 6, 12)] # type: ignore
assert isinstance(da.geometry, mikeio.spatial.GeometryFM3D)
# indexing in both time and space
da = sal[0, 0]
assert isinstance(da.geometry, mikeio.spatial.GeometryPoint3D)
assert da.shape == ()
def test_dataarray_grid1d_repr(da2: DataArray) -> None:
assert "Grid1D" in repr(da2)
assert "values" not in repr(da2)
def test_dataarray_grid1d_indexing(da2: DataArray) -> None:
da = da2
nt, nx = da.shape
assert da[0].shape == (nx,)
assert da[0, :].shape == (nx,)
assert da[:, -1].shape == (nt,)
assert da[:, :].shape == (nt, nx)
assert da[0, 0].shape == ()
assert isinstance(da[:, :].geometry, mikeio.Grid1D)
assert isinstance(da[:, -1].geometry, mikeio.spatial.GeometryUndefined)
def test_dataarray_grid2d_repr(da_grid2d: DataArray) -> None:
assert "Grid2D" in repr(da_grid2d)
assert "values" not in repr(da_grid2d)
da = da_grid2d[:, -1]
assert "geometry: Grid1D" in repr(da)
assert "values" not in repr(da)
da = da_grid2d[:, -1, 0]
assert "geometry: GeometryPoint2D" in repr(da)
assert "values" in repr(da)
da = da_grid2d[0, 0, 0]
assert "geometry: GeometryPoint2D" in repr(da)
assert "values" in repr(da)
def test_dataarray_grid2d_indexing(da_grid2d: DataArray) -> None:
da = da_grid2d
nt, ny, nx = da.shape # 10, 14, 7
assert da[0].shape == (ny, nx)
assert da[0, :, :].shape == (ny, nx)
assert da[0, [0, 1, 2, 3], [2, 4, 6]].shape == (4, 3)
assert da[:, 0, 1:4].shape == (nt, 3)
assert da[5:, :, 0].shape == (5, ny)
assert da[0:5, -1, 0].shape == (5,)
assert da[0, :, 4].shape == (ny,)
assert da[0, -1, :].shape == (nx,)
assert da[0, 0, 0].shape == ()
assert isinstance(da[0, :, :].geometry, mikeio.Grid2D)
assert isinstance(da[0, 0, :].geometry, mikeio.Grid1D)
assert isinstance(da[:, :, 0].geometry, mikeio.Grid1D)
assert isinstance(da[:, -1, 0].geometry, mikeio.spatial.GeometryPoint2D)
# TODO: slices in other than the time direction will give GeometryUndefined
assert isinstance(da[:, 2:5, 0].geometry, mikeio.Grid1D)
assert isinstance(da[:, 2:5, 0:4].geometry, mikeio.Grid2D)
def test_dataarray_grid3d_indexing() -> None:
da = mikeio.read("tests/testdata/test_dfs3.dfs3")[0]
nt, nz, ny, nx = da.shape # 2, 34, 17, 21
assert da[0].shape == (nz, ny, nx)
assert da[0, :, :].shape == (nz, ny, nx)
assert da[0, [0, 1, 2, 3], [2, 4, 6]].shape == (4, 3, nx)
assert da[:, 0, 1:4].shape == (nt, 3, nx)
assert da[:, -1, 0].shape == (nt, nx)
assert da[:, :, -1, 0].shape == (nt, nz)
assert da[0, :, 4].shape == (nz, nx)
assert da[0, -1, :].shape == (ny, nx)
assert da[0, 0, 0, 0].shape == ()
assert isinstance(da[0, ::5, ::5, ::5].geometry, mikeio.Grid3D)
assert isinstance(da[0, :, :].geometry, mikeio.Grid3D)
assert isinstance(da[0, 0, :].geometry, mikeio.Grid2D)
assert isinstance(da[:, :, 0].geometry, mikeio.Grid2D)
assert isinstance(da[:, :, :, -1].geometry, mikeio.Grid2D)
assert isinstance(da[:, -1, 0].geometry, mikeio.Grid1D)
# with multi-index along one dimension
assert isinstance(da[:, 2:5, 0, :].geometry, mikeio.Grid2D)
# TODO: wait for merge of https://github.com/DHI/mikeio/pull/311
# assert isinstance(da[:, 1, ::3, :].geometry, mikeio.Grid2D)
def test_da_sel_xyz_grid3d() -> None:
da = mikeio.read("tests/testdata/test_dfs3.dfs3")[0]
x0, y0 = da.geometry.x[2], da.geometry.y[3]
z0 = da.geometry.z[1]
da2 = da.sel(x=x0, y=y0, z=z0)
assert da2.shape == (da.n_timesteps,)
def test_da_sel_x_grid3d() -> None:
da = mikeio.read("tests/testdata/test_dfs3.dfs3")[0]
x0 = da.geometry.x[2]
da2 = da.sel(x=x0)
# selecting x reduces x dim, keeps z and y
assert da2.shape == (da.n_timesteps, da.geometry.nz, da.geometry.ny)
def test_da_sel_z_grid3d() -> None:
da = mikeio.read("tests/testdata/test_dfs3.dfs3")[0]
z0 = da.geometry.z[1]
da2 = da.sel(z=z0)
# selecting z reduces z dim, keeps x and y => Grid2D
assert isinstance(da2.geometry, mikeio.Grid2D)
assert da2.shape == (da.n_timesteps, da.geometry.ny, da.geometry.nx)
def test_da_sel_area_grid3d() -> None:
da = mikeio.read("tests/testdata/test_dfs3.dfs3")[0]
x = da.geometry.x
y = da.geometry.y
area = (x[1], y[1], x[4], y[4])
da2 = da.sel(area=area)
assert isinstance(da2.geometry, mikeio.Grid3D)
def test_da_sel_slice_grid3d() -> None:
da = mikeio.read("tests/testdata/test_dfs3.dfs3")[0]
x = da.geometry.x
z = da.geometry.z
da2 = da.sel(x=slice(x[1], x[4]), z=slice(z[0], z[2]))
assert isinstance(da2.geometry, mikeio.Grid3D)
# assert isinstance(da[:, 1, -3, 4:].geometry, mikeio.Grid2D)
def test_dataarray_getitem_time_string_not_supported(da_grid2d: DataArray) -> None:
da = da_grid2d
# time=pd.date_range("2000-01-01", freq="h", periods=10)
# string indexing is not supported, use .sel(time=...) or .isel(time=...) instead
with pytest.raises(TypeError, match="not supported"):
da["2000-1-1"]
with pytest.raises(TypeError, match="not supported"):
da["2000-1-1 02:00":"2000-1-1 05:00"] # type: ignore
time = ["2000-1-1 02:00", "2000-1-1 04:00", "2000-1-1 06:00"]
with pytest.raises(TypeError, match="not supported"):
da[time]
def test_dataarray_getitem_time(da_grid2d: DataArray) -> None:
da = da_grid2d
# time=pd.date_range("2000-01-01", freq="h", periods=10)
time = [da.time[0], da.time[1], da.time[3], da.time[7]]
da_sel = da[time]
assert da_sel.n_timesteps == 4
assert not da_sel.is_equidistant
da_sel = da[da.time[:5]]
assert da_sel.n_timesteps == 5
assert da_sel.is_equidistant
def test_dataarray_grid2d_indexing_error(da_grid2d: DataArray) -> None:
with pytest.raises(IndexError, match="Key has more dimensions"):
da_grid2d[0, :, :, 4]
with pytest.raises(IndexError):
da_grid2d[12]
with pytest.raises(IndexError):
da_grid2d[14:18]
with pytest.raises(IndexError):
da_grid2d[3, :, 100]
def test_dropna(da2: DataArray) -> None:
da2[8:] = np.nan # type: ignore
da3 = da2.dropna()
assert da2.n_timesteps == 10
assert da3.n_timesteps == 8
def test_da_isel_space(da_grid2d: DataArray) -> None:
assert da_grid2d.geometry.nx == 7
assert da_grid2d.geometry.ny == 14
da_sel = da_grid2d.isel(y=0)
assert da_sel.dims == ("time", "x")
assert isinstance(da_sel.geometry, mikeio.Grid1D)
da_sel = da_grid2d.isel(x=0)
assert da_sel.dims == ("time", "y")
assert isinstance(da_sel.geometry, mikeio.Grid1D)
da_sel = da_grid2d.isel(time=0)
assert da_sel.dims == ("y", "x")
def test_da_isel_empty(da_grid2d: DataArray) -> None:
with pytest.raises(ValueError):
da_grid2d.isel(y=slice(100, 200))
def test_da_isel_space_multiple_elements(da_grid2d: DataArray) -> None:
assert da_grid2d.geometry.nx == 7
assert da_grid2d.geometry.ny == 14
da_sel = da_grid2d.isel(y=(0, 1, 2, 10))
assert da_sel.dims == ("time", "y", "x")
assert da_sel.shape == (10, 4, 7)
assert isinstance(da_sel.geometry, mikeio.spatial.GeometryUndefined)
da_sel = da_grid2d.isel(x=slice(None, 3))
assert da_sel.dims == ("time", "y", "x")
assert da_sel.shape == (10, 14, 3)
assert isinstance(da_sel.geometry, mikeio.Grid2D)
def test_da_isel_space_named_axis(da_grid2d: mikeio.DataArray) -> None:
da_sel = da_grid2d.isel(y=0)
assert da_sel.dims[0] == "time"
da_sel = da_grid2d.isel(x=0)
assert da_sel.dims == ("time", "y")
da_sel = da_grid2d.isel(time=0)
assert da_sel.dims == ("y", "x")
def test_da_isel_space_named_missing_axis(da_grid2d: mikeio.DataArray) -> None:
with pytest.raises(ValueError) as excinfo:
da_grid2d.isel(layer=0)
assert "layer" in str(excinfo.value)
def test_da_sel_layer() -> None:
filename = "tests/testdata/oresund_sigma_z.dfsu"
da = mikeio.read(filename, items=0)[0]
assert da.geometry.n_elements == 17118
assert da.geometry.is_layered
da1 = da.sel(layers=-1)
assert da1.geometry.n_elements == 3700
assert not da1.geometry.is_layered
da2 = da.sel(layers="top")
assert da2.geometry.n_elements == 3700
# assert
da3 = da.sel(layers="bottom")
assert da3.geometry.n_elements == 3700
def test_da_sel_xy_grid2d(da_grid2d: DataArray) -> None:
# Grid2D(x0=10.0, dx=0.1, nx=7, ny=14, dy=1.0, y0=-10.0),
da = da_grid2d
da1 = da.sel(x=10.4, y=0.0)
assert isinstance(da1.geometry, mikeio.spatial.GeometryPoint2D)
assert da1.geometry.x == 10.4
assert da1.geometry.y == 0.0
assert np.all(da1.to_numpy() == da.to_numpy()[:, 10, 4])
# da2 = da.sel(x=100.4, y=0.0) # TODO outside grid
def test_da_sel_multi_xy_grid2d(da_grid2d: DataArray) -> None:
# Grid2D(x0=10.0, dx=0.1, nx=7, ny=14, dy=1.0, y0=-10.0),
pass
# TODO: not implemented:
# da1 = da.sel(x=xx, y=yy)
# assert da1.shape == (10, 3)
def test_da_sel_area_dfsu2d() -> None:
filename = "tests/testdata/FakeLake.dfsu"
da = mikeio.read(filename, items=0)[0]
area = (-0.1, 0.15, 0.0, 0.2)
da1 = da.sel(area=area)
assert da1.geometry.n_elements == 14
area = (-0.1, 0.15, 0.0, 0.2)
da1 = da.sel(area=area)
assert da1.geometry.n_elements == 14
def test_da_isel_order_is_important_dfsu2d() -> None:
filename = "tests/testdata/FakeLake.dfsu"
da = mikeio.read(filename, items=0, time=0)[0]
# select elements sorted
da1 = da.isel(element=[0, 1])
assert da1.values[0] == pytest.approx(-3.2252840995788574)
assert da1.geometry.element_coordinates[0, 0] == pytest.approx(-0.61049269425)
# select elements in arbitrary order
da2 = da.isel(element=[1, 0])
assert da2.values[1] == pytest.approx(-3.2252840995788574)
assert da2.geometry.element_coordinates[1, 0] == pytest.approx(-0.61049269425)
# select same elements multiple times, not sure why, but consistent with NumPy, xarray
da3 = da.isel(element=[1, 0, 1])
assert da3.values[1] == pytest.approx(-3.2252840995788574)
assert da3.geometry.element_coordinates[1, 0] == pytest.approx(-0.61049269425)
assert len(da3.geometry.element_coordinates) == 3
def test_da_sel_area_grid2d() -> None:
filename = "tests/testdata/gebco_sound.dfs2"
da = mikeio.read(filename, items=0)[0]
assert da.dims == ("time", "y", "x")
bbox = (12.4, 55.2, 22.0, 55.6)
da1 = da.sel(area=bbox)
assert da1.geometry.nx == 168
assert da1.geometry.ny == 96
das = da.squeeze()
assert das.dims == ("y", "x")
da = das.sel(area=bbox)
assert da1.geometry.nx == 168
assert da1.geometry.ny == 96
def test_da_sel_area_and_xy_not_ok() -> None:
filename = "tests/testdata/FakeLake.dfsu"
da = mikeio.read(filename, items=0)[0]
area = (-0.1, 0.15, 0.0, 0.2)
with pytest.raises(ValueError) as excinfo:
da.sel(area=area, x=0.0, y=0.1)
assert "area" in str(excinfo.value)
def test_da_sel_area_3d() -> None:
filename = "tests/testdata/oresund_sigma_z.dfsu"
da = mikeio.read(filename, items=0)[0]
assert da.geometry.n_elements == 17118
assert da.geometry.n_layers == 9
area = (340000, 6140000, 360000, 6170000)
da1 = da.sel(area=area)
assert da1.geometry.n_elements == 4567
assert da1.geometry.n_layers == 6
def test_da_sel_area_2dv() -> None:
filename = "tests/testdata/basin_2dv.dfsu"
da = mikeio.read(filename, items=0)[0]
assert da.geometry.is_layered
# TODO
# area = [100, 10, 300, 30]
# da1 = da.sel(area=area)
# assert da1.geometry.n_elements == 128
# assert da1.geometry.is_layered
def test_describe(da_grid2d: DataArray) -> None:
df = da_grid2d.describe()
assert isinstance(df, pd.DataFrame)
assert len(df.columns) == 1
assert "max" in df.index
def test_plot_grid1d(da2: DataArray) -> None:
# Not very functional tests, but at least it runs without errors
da2.plot(title="The TITLE")
da2.plot.line()
da2.plot.timeseries(figsize=(12, 4))
_, (ax1, ax2) = plt.subplots(nrows=1, ncols=2)
da2.plot.imshow(ax=ax1)
da2.plot.pcolormesh(ax=ax2)
plt.close("all")
def test_plot_grid2d_proj(da_grid2d_proj: DataArray) -> None:
da_grid2d_proj.plot()
def test_timestep(da1: DataArray) -> None:
assert da1.timestep == 1.0
def test_interp_time(da1: DataArray) -> None:
da = mikeio.read("tests/testdata/HD2D.dfsu")[0]
dai = da.interp_time(dt=1800)
assert dai.timestep == 1800
def test_interp_like_index(da1: DataArray) -> None:
da = mikeio.read("tests/testdata/HD2D.dfsu")[0]
dai = da.interp_like(da.time)
assert any(dai.time == da.time)
def test_dims_time(da1: DataArray) -> None:
assert da1.dims[0][0] == "t"
def test_dims_time_space1d(da_time_space: DataArray) -> None:
assert da_time_space.dims[1] == "x"
def test_repr(da_time_space: DataArray) -> None:
text = repr(da_time_space)
assert "DataArray" in text
assert "dims: (time:10, x:2)" in text
def test_plot(da1: DataArray) -> None:
da1.plot()
assert True
def test_modify_values(da1: DataArray) -> None:
assert all(~np.isnan(da1.values))
da1[0] = np.nan # type: ignore
assert any(np.isnan(da1.values))
with pytest.raises(ValueError):
da1.values = np.array([1.0]) # you can not set data to another shape
# This is allowed
da1.values = np.zeros_like(da1.values) + 2.0
def test_modify_values_1d(da1: DataArray) -> None:
assert da1.values[4] == 14.0
# selecting a slice will return a view. The original is changed.
da1.isel(slice(4, 6)).values[0] = 13.0
assert da1.values[4] == 13.0
# __getitem__ uses isel()
da1[4:6].values[0] = 12.0
assert da1.values[4] == 12.0
# values is scalar, therefore copy by definition. Original is not changed.
# TODO is the treatment of scalar sensible, i.e. consistent with xarray?
da1.isel(4).values = 11.0 # type: ignore
assert da1.values[4] != 11.0
# fancy indexing will return copy! Original is *not* changed.
da1.isel([0, 4, 7]).values[1] = 10.0
assert da1.values[4] != 10.0
def test_get_2d_slice_with_sel(da_grid2d: DataArray) -> None:
assert da_grid2d.shape == (10, 14, 7)
da3 = da_grid2d.sel(x=slice(10.0, 10.3))
assert da3.shape == (10, 14, 3)
da4 = da_grid2d.sel(y=slice(-5.0, 0.0))
assert da4.shape == (10, 5, 7)
da5 = da_grid2d.sel(x=slice(10.0, 10.3), y=slice(-5.0, 0.0))
assert da5.shape == (10, 5, 3)
da6 = da_grid2d.sel(x=slice(None, 10.3), y=slice(-4.0, None))
assert da6.shape == (10, 8, 3)
def test_get_2d_outside_domain_raises_error(da_grid2d: DataArray) -> None:
with pytest.raises(OutsideModelDomainError):
da_grid2d.sel(x=0.0)
with pytest.raises(OutsideModelDomainError):
da_grid2d.sel(x=slice(0.0, 1.0))
def test_modify_values_2d_all(da2: DataArray) -> None:
assert da2.shape == (10, 7)
assert da2.values[2, 5] == 0.1
da2 += 0.1
assert da2.values[2, 5] == 0.2
vals = 0.3 * np.ones(da2.shape)
da2.values = vals
assert da2.values[2, 5] == 0.3
def test_modify_values_2d_idx(da2: DataArray) -> None:
assert da2.shape == (10, 7)
assert da2.values[2, 5] == 0.1
# selecting a single index will return a view. The original is changed.
da2.isel(time=2).values[5] = 0.2
assert da2.values[2, 5] == 0.2
da2.isel(x=5).values[2] = 0.3
assert da2.values[2, 5] == 0.3
da2.values[2, 5] = 0.4
assert da2.values[2, 5] == 0.4
# __getitem__ uses isel()
da2[2].values[5] = 0.5
assert da2.values[2, 5] == 0.5
da2[:, 5].values[2] = 0.6
assert da2.values[2, 5] == 0.6
def test_modify_values_2d_slice(da2: DataArray) -> None:
assert da2.shape == (10, 7)
assert da2.values[2, 5] == 0.1
# selecting a slice will return a view. The original is changed.
da2.isel(time=slice(2, 6)).values[0, 5] = 0.4
assert da2.values[2, 5] == 0.4
da2.isel(x=slice(5, 7)).values[2, 0] = 0.5
assert da2.values[2, 5] == 0.5
# __getitem__ uses isel()
da2[2:5].values[0, 5] = 0.6
assert da2.values[2, 5] == 0.6
da2[:, 5:7].values[2, 0] = 0.7
assert da2.values[2, 5] == 0.7
def test_modify_values_2d_fancy(da2: DataArray) -> None:
assert da2.shape == (10, 7)
assert da2.values[2, 5] == 0.1
# fancy indexing will return a *copy*. The original is NOT changed.
da2.isel(time=[2, 3, 4, 5]).values[0, 5] = 0.4
assert da2.values[2, 5] != 0.4
da2.isel(x=[5, 6]).values[2, 0] = 0.5
assert da2.values[2, 5] != 0.5
# __getitem__ uses isel()
da2[[2, 3, 4, 5]].values[0, 5] = 0.6
assert da2.values[2, 5] != 0.6
da2[:, [5, 6]].values[2, 0] = 0.7
assert da2.values[2, 5] != 0.7
def test_add_scalar(da1: DataArray) -> None:
da2 = da1 + 10.0
assert isinstance(da2, mikeio.DataArray)
assert np.all(da2.to_numpy() - da1.to_numpy() == 10.0)
da3 = 10.0 + da1 # __radd__
assert isinstance(da3, mikeio.DataArray)
assert np.all(da3.to_numpy() == da2.to_numpy())
def test_subtract_scalar(da1: DataArray) -> None:
da2 = da1 - 10.0
assert isinstance(da2, mikeio.DataArray)
assert np.all(da2.to_numpy() - da1.to_numpy() == -10.0)
da3 = 10.0 - da1 # __rsub__
assert isinstance(da3, mikeio.DataArray)
assert da3.to_numpy()[-1] == -9.0
def test_multiply_scalar(da1: DataArray) -> None:
da2 = da1 * 2.0
assert isinstance(da2, mikeio.DataArray)
assert np.all(da2.to_numpy() / da1.to_numpy() == 2.0)
da3 = 2.0 * da1 # __rmul__
assert isinstance(da3, mikeio.DataArray)
assert np.all(da3.to_numpy() == da2.to_numpy())
def test_multiply_string_is_not_valid(da1: DataArray) -> None:
with pytest.raises(TypeError):
da1 * "2.0" # type: ignore
def test_multiply_two_dataarrays(da1: DataArray) -> None:
da3 = da1 * da1
assert isinstance(da3, mikeio.DataArray)
assert da1.shape == da3.shape
da3 = da1 * da1.values
assert isinstance(da3, mikeio.DataArray)
assert da1.shape == da3.shape
def test_multiply_two_dataarrays_broadcasting(da_grid2d: DataArray) -> None:
da1 = da_grid2d
da2 = da1 * da1.values[0, 0, :]
assert isinstance(da2, mikeio.DataArray)
assert da1.shape == da2.shape
# nt,ny,nx * ny,nx
da3 = da1 * da1.max()
assert isinstance(da3, mikeio.DataArray)
assert da_grid2d.shape == da3.shape
def test_math_two_dataarrays(da1: DataArray) -> None:
da3 = da1 + da1
assert isinstance(da3, mikeio.DataArray)
assert da1.shape == da3.shape
da3 = da1 - da1
assert isinstance(da3, mikeio.DataArray)
assert da1.shape == da3.shape
da3 = da1 / da1
assert isinstance(da3, mikeio.DataArray)
assert da1.shape == da3.shape
da3 = da1 * da1