-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmyfuncs.py
3156 lines (2810 loc) · 124 KB
/
myfuncs.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
# LIBRARIES
from typing import Type
from pandas import ExcelWriter
import xarray as xr
from xarray.core.formatting import array_repr
from importlib import reload
import numpy as np
import matplotlib.pyplot as plt
from cdo import Cdo
import os
import warnings
import sys
from datetime import datetime as dtime
import cartopy.crs as ccrs
import cartopy.feature as cfeature
import matplotlib.colors as colors
import matplotlib.cm as cm
import matplotlib.gridspec as gridspec
from matplotlib.ticker import MultipleLocator
from collections.abc import Iterable
from regionmask.defined_regions import srex as srex_regions
from scipy import stats
import dask
plt.rcParams['hatch.linewidth']=0.3
class Dataset(xr.Dataset):
'''
Wrapper for xarray.Dataset class in order to add user-defined functions
'''
__slots__ = ("dataset",)
def __init__(self,*args,keep_structure=False,**kwargs):
if not keep_structure and isinstance(args[0],xr.Dataset):
arg = args[0]
if "upward_air_velocity" in arg:
arg = UM.split_w_wind(arg)
if "m01s09i231" in arg:
arg = UM.rename_m01s09i231(arg)
if ("evaporation_flux_from_open_sea" in arg) and ("evaporation_from_soil_surface" in arg):
arg = UM.add_evaporation(arg)
if ("tendency_of_air_temperature_due_to_shortwave_heating" in arg) and ("tendency_of_air_temperature_due_to_longwave_heating" in arg):
arg = UM.add_tot_hrate(arg)
try:
args = arg[1:]
except:
args=[]
super().__init__(arg,
*args,**kwargs)
else:
super().__init__(*args,**kwargs)
def __getitem__(self, key):
"""Access variables or coordinates this dataset as a
:myfuncs:class:`~__main__.DataArray`.
Indexing with a list of names will return a new ``Dataset`` object.
"""
from xarray.core import utils
if utils.is_dict_like(key):
return DataArray(self.isel(**key))
if utils.hashable(key):
return DataArray(self._construct_dataarray(key))
else:
return Dataset(self._copy_listed(np.asarray(key)),attrs=self.attrs)
def get_spatial_coords(self):
lats=["latitude","latitude_0","lat"]
lons=["longitude","longitude_0","lon"]
count=0
for l in lats:
if l in self.dims:
coords=[l]
break
count+=1
if count == 3:
coords=[None]
count=0
for l in lons:
if l in self.dims:
coords.append(l)
break
count+=1
if count == 3:
coords.append(None)
return coords
def annual_mean(self,num=None,copy=True,update_attrs=True,normalize=False):
return annual_mean(self,num=num,copy=copy,update_attrs=update_attrs,
normalize=normalize)
def annual_cycle(self,num=None,copy=True,update_attrs=True):
return annual_cycle(self,num=num,copy=copy,update_attrs=update_attrs)
def seasonal_cycle(self,copy=True,update_attrs=True):
return seasonal_cycle(self,copy=copy,update_attrs=update_attrs)
def anomalies(self,base=None,copy=True,update_attrs=True):
return anomalies(self,x_base=base,copy=copy,update_attrs=update_attrs)
def average(self, dim=None, weights=None,**kwargs):
if not check_xarray(self, 'Dataset'):
exception_xarray(type='Dataset')
if 'keep_attrs' not in kwargs: kwargs.update({'keep_attrs':True})
return self.apply(average, dim=dim, weights=weights,**kwargs)
def latitude_mean(self,copy=True,update_attrs=True):
return latitude_mean(self,copy=copy,update_attrs=update_attrs)
def longitude_mean(self,copy=True,update_attrs=True):
return longitude_mean(self,copy=copy,update_attrs=update_attrs)
def global_mean(self,copy=True,update_attrs=True):
return global_mean(self,copy=copy,update_attrs=update_attrs)
def rms(self,copy=True,update_attrs=True):
return rms(self,copy=copy,update_attrs=update_attrs)
def to_celsius(self,copy=True):
def func(x):
try: return x.to_celsius()
except: return x
if copy: self = self.copy()
return self.apply(lambda x: func(x),keep_attrs=True)
def group_by(self,time_group,num=None,copy=True,update_attrs=True):
return group_by(self,time_group,num=num,copy=copy,update_attrs=update_attrs)
def srex_mean(self,copy=True):
mask=SREX_regions.mask()
if copy: self=self.copy()
new=self.groupby(mask).mean('stacked_lat_lon')
new.coords['srex_abbrev'] = ('srex_region', srex_regions.abbrevs)
new.coords['srex_name'] = ('srex_region', srex_regions.names)
return new
def seasonal_time_series(self,first_month_num=None,update_attrs=True):
return seasonal_time_series(self,first_month_num=first_month_num,
update_attrs=update_attrs)
def to_pressure_lev(self,data_vars=None):
return UM.to_pressure_lev(self,data_vars=data_vars)
class DataArray(xr.DataArray):
'''
Wrapper for xarray.DataArray class in order to add user-defined functions
'''
__slots__ = ("dataarray",)
def __init__(self,*args,**kwargs):
arguments=['data','coords','dims','name','attrs','indexes','fastpath']
if len(args)>0:
data=args[0]
elif 'data' in kwargs:
data=kwargs.pop('data')
else:
data = False
if isinstance(data,xr.DataArray):
super().__init__(data=data.data,coords=data.coords,dims=data.dims,name=data.name,attrs=data.attrs)
# super().__init__(data=dask.array.from_array(data),coords=data.coords,dims=data.dims,name=data.name,attrs=data.attrs)
else:
super().__init__(data,*args[1:],**kwargs)
# super().__init__(dask.array.from_array(data),*args[1:],**kwargs)
def get_spatial_coords(self):
lats=["latitude","latitude_0","lat"]
lons=["longitude","longitude_0","lon"]
count=0
for l in lats:
if l in self.dims:
coords=[l]
break
count+=1
if count == 3:
coords=[None]
count=0
for l in lons:
if l in self.dims:
coords.append(l)
break
count+=1
if count == 3:
coords.append(None)
return coords
def plotvar(self,
projection = None,
outpath = None,
name = None,
title = None,
statistics='all',
t_student=False,
nlev=None,
du= None,
units=None,
coast_kwargs = None,
land_kwargs = None,
save_kwargs = None,
grid=True,
**contourf_kwargs):
'''
Plots DataArray variablewith associated color maps, scales and projections.
'''
def _get_var(x):
keys = x.attrs.keys()
name = x.name if x.name is not None else 'data'
if 'long_name' in keys:
title = x.attrs['long_name'] if x.attrs['long_name'] is not None else ''
else:
title = x.name if x.name is not None else ''
if 'units' in keys:
units = x.attrs['units'] if x.attrs['units'] is not None else ''
else:
units = ''
if 'annual_mean' in keys:
title = title + ' Annual Mean'
name=name+'.amean'
if 'seasonal_cycle' in keys:
title = title + ' Seasonal Cycle'
name=name+'.seascyc'
cmap = cm.RdBu_r
if 'anomalies' in keys:
title = title + ' Anomalies'
name=name+'.anom'
return title,name,units
param=self._get_param(nlev=nlev)
self=param['self']
if title is None: title = _get_var(self)[0]
if name is None: name = _get_var(self)[1]
if nlev is None: nlev=100
if units is None:
units = _get_var(self)[2]
if projection is None or not projection:
projection = ccrs.PlateCarree()
elif projection != ccrs.PlateCarree():
grid=False
if 'ax' not in contourf_kwargs:
contourf_kwargs['ax'] = plt.axes(projection=projection)
ax=contourf_kwargs['ax']
if 'cmap' not in contourf_kwargs:
contourf_kwargs['cmap'] = param['cmap']
if ('levels' not in contourf_kwargs) and ('norm' not in contourf_kwargs):
if param['levels'] is None:
contourf_kwargs['levels'] = nlev
else:
contourf_kwargs['levels'] = param['levels']
if ('add_colorbar' not in contourf_kwargs):contourf_kwargs['add_colorbar']=True
if contourf_kwargs['add_colorbar']==True:
cbar_kwargs = {'orientation':'horizontal', 'label':units}
if 'cbar_kwargs' not in contourf_kwargs:
contourf_kwargs["cbar_kwargs"] = cbar_kwargs
contourf_kwargs["cbar_kwargs"]['ticks'] = param['cbticks']
else:
if 'orientation' not in contourf_kwargs['cbar_kwargs']: contourf_kwargs['cbar_kwargs']['orientation'] = 'horizontal'
if 'label' not in contourf_kwargs['cbar_kwargs']: contourf_kwargs['cbar_kwargs']['label'] = units
if du is not None:
umin=contourf_kwargs['levels'][0]
umax=contourf_kwargs['levels'][-1]
contourf_kwargs['cbar_kwargs'].update({"ticks":np.arange(umin,umax+du,du)})
if land_kwargs is not None:
land_kwargs = {'edgecolor':'face', 'facecolor':'black', **land_kwargs}
else:
land_kwargs = {'edgecolor':'face', 'facecolor':'black'}
if coast_kwargs is not None:
coast_kwargs = {**coast_kwargs}
else:
coast_kwargs = {}
im=self._to_contiguous_lon().plot.contourf(
transform=ccrs.PlateCarree(),
**contourf_kwargs)
ax.add_feature(cfeature.COASTLINE,**coast_kwargs)
if (self.name == 'tocean'):
ax.add_feature(cfeature.NaturalEarthFeature('physical', 'land', '110m'),
**land_kwargs)
if isinstance(statistics,dict):
if "value" not in statistics:
raise Exception("Missing 'value' key in statistics. 'value' must be either 'all', 'gmean' or 'rms'.")
else:
txt_kwargs=statistics.copy()
statistics = statistics.copy()['value']
del txt_kwargs["value"]
else:
txt_kwargs=dict()
txt_kwargs.setdefault("fontsize",12)
txt_kwargs.setdefault("format",".2f")
txt_kwargs.setdefault("verticalalignment",'top')
txt_kwargs.setdefault("horizontalalignment",'center')
txt_kwargs.setdefault("transform",ax.transAxes)
txt_kwargs.setdefault("weight",'bold')
if isinstance(statistics,str):
x_txt,y_txt = 0.5,-0.1
gm=self.global_mean().values
rms=self.rms().values
if statistics == 'all':
txt = f'gmean = {gm:{txt_kwargs["format"]}} | rms = {rms:{txt_kwargs["format"]}}'
elif statistics == 'gmean':
txt = f'gmean = {gm:{txt_kwargs["format"]}}'
elif statistics == 'rms':
txt = f'rms = {rms:{txt_kwargs["format"]}}'
else:
raise Exception("Invalid string for statistics. statistics must be either 'all', 'gmean' or 'rms'.")
del txt_kwargs["format"]
ax.text(x_txt,y_txt,txt,**txt_kwargs)
elif (statistics is None) or (not statistics):
pass
else: raise Exception("Invalid type for statistics. statistics must be either 'all', 'gmean' or 'rms'.")
if isinstance(t_student,bool):
if t_student:
raise Exception('t_student must be False, or equal to either a dictionary or an '
'xarray.DataArray containing t-student distribution probabilities.')
else:
if check_xarray(t_student,"DataArray"):
_check_shapes(t_student,self)
t_student = {"p":t_student}
elif isinstance(t_student,np.ndarray):
t_student = {"p":xr.DataArray(data=t_student,dims = ["latitude","longitude"], coords=[UM.latitude,UM.longitude])}
if isinstance(t_student,dict):
if "p" not in t_student:
raise Exception('t_student must be contain "p" key, containing '
'an xarray.DataArray with t-student distribution '
'probabilities.\nTo obtain t_student distribution '
'probabilities, you can use the "t_student_probability" function.')
elif isinstance(t_student["p"],np.ndarray):
t_student["p"] = xr.DataArray(data=t_student["p"],dims = ["latitude","longitude"], coords=[UM.latitude,UM.longitude])
if "treshold" in t_student:
if t_student["treshold"] > 1:
raise Exception("Treshold must be <= 1")
else:
t_student["treshold"]=0.05
if "hatches" not in t_student:
t_student["hatches"]= '///'
else:
raise Exception('t_student must be either a dictionary or an '
'xarray.DataArray containing t-student distribution probabilities.')
p=t_student["p"]
a=t_student["treshold"]
DataArray(p.where(p<a,0).where(p>=a,1))._to_contiguous_lon().plot.contourf(
ax=ax,
transform=ccrs.PlateCarree(),
levels=np.linspace(0,1,3),
hatches=['',t_student['hatches']],
alpha=0,
add_colorbar=False,
)
if grid:
gl = ax.gridlines(crs=projection, linewidth=1, color='grey', alpha=0.3, linestyle='--',draw_labels=True)
gl.top_labels = False
gl.left_labels = True
gl.right_labels=False
gl.xlines = True
title_kwargs=dict()
if isinstance(title,dict):
if "label" not in title:
raise Exception("Title dictionary needs to have the 'label' keyword for the text to use as the title")
else:
titlelabel=title.pop("label")
title_kwargs=title
else:
titlelabel=title
ax.set_title(titlelabel,**title_kwargs)
if save_kwargs is not None:
save_kwargs = {'dpi':300, 'bbox_inches':'tight', **save_kwargs}
else:
save_kwargs = {'dpi':300, 'bbox_inches':'tight'}
if outpath is not None:
plt.savefig(outpath,**save_kwargs)
return im
def _get_param(self,nlev=None):
'''
Function to set parameter for plotting
'''
cmap_tsurf=Colormaps.div_tsurf
cmap_precip=Colormaps.div_precip
keys=self.attrs.keys()
name=self.name
if nlev is None: nlev=100
levels = None
cbticks = None
cmap = None
# TATMOS
if name == 'tatmos':
cmap = cm.RdBu_r
if 'anomalies' in keys:
cmap = cmap_tsurf
levels = np.linspace(-2,2,nlev)
cbticks = np.arange(-2,2+0.4,0.4)
else:
if 'annual_mean' in keys:
levels = np.linspace(223,323,nlev)
cbticks = np.arange(223,323+10,10)
elif 'seasonal_cycle' in keys:
cmap = cmap_tsurf
levels = np.linspace(-20,20,nlev)
cbticks = np.arange(-20,20+4,4)
# TSURF
elif name == 'tsurf':
cmap = cm.RdBu_r
if 'anomalies' in keys:
cmap = cmap_tsurf
levels = np.linspace(-2,2,nlev)
cbticks = np.arange(-2,2+0.4,0.4)
else:
if 'annual_mean' in keys:
levels = np.linspace(223,323,nlev)
cbticks = np.arange(223,323+10,10)
elif 'seasonal_cycle' in keys:
cmap = cmap_tsurf
levels = np.linspace(-20,20,nlev)
cbticks = np.arange(-20,20+4,4)
# TOCEAN
elif name == 'tocean':
cmap = cm.RdBu_r
if 'anomalies' in keys:
cmap = cmap_tsurf
levels = np.linspace(-1,1,nlev)
cbticks = np.arange(-1,1+0.2,0.2)
else:
if 'annual_mean' in keys:
levels = np.linspace(273,303,nlev)
cbticks = np.arange(273,303+10,3)
elif 'seasonal_cycle' in keys:
cmap = cmap_tsurf
levels = np.linspace(-1,1,nlev)
cbticks = np.arange(-1,1+2e-1,2e-1)
# PRECIP
elif name == 'precip':
cmap = cm.GnBu
if 'anomalies' in keys:
cmap = cmap_precip
levels = np.linspace(-1,1,nlev)
cbticks = np.arange(-1,1+0.2,0.2)
else:
if 'annual_mean' in keys:
levels = np.linspace(0,9,nlev)
cbticks = np.arange(0,9+1,1)
elif 'seasonal_cycle' in keys:
cmap = cmap_precip
levels = np.linspace(-6,6,nlev)
cbticks = np.arange(-6,6+1,1)
# EVA
elif name == 'eva':
cmap = cm.GnBu
if 'anomalies' in keys:
cmap = cmap_precip
levels = np.linspace(-1,1,nlev)
cbticks = np.arange(-1,1+0.2,0.2)
else:
if 'annual_mean' in keys:
cmap = cm.Blues
levels = np.linspace(0,10,nlev)
cbticks = np.arange(0,10+1,1)
elif 'seasonal_cycle' in keys:
cmap = cmap_precip
levels = np.linspace(-3,3,nlev)
cbticks = np.arange(-3,3+0.5,0.5)
# QCRCL
elif name == 'qcrcl':
cmap = cm.RdBu_r
if 'anomalies' in keys:
cmap = cmap_tsurf
levels = np.linspace(-1,1,nlev)
cbticks = np.arange(-1,1+0.2,0.2)
else:
if 'annual_mean' in keys:
levels = np.linspace(-8,8,nlev)
cbticks = np.arange(-8,8+2,2)
elif 'seasonal_cycle' in keys:
cmap = cmap_tsurf
levels = np.linspace(-6,6,nlev)
cbticks = np.arange(-6,6+1,1)
# VAPOR
elif name == 'vapor':
cmap = cm.RdBu_r
if 'anomalies' in keys:
cmap = cmap_tsurf
levels = np.linspace(-5e-3,5e-3,nlev)
cbticks = np.arange(-5e-3,5e-3+1e-3,1e-3)
else:
if 'annual_mean' in keys:
cmap = cm.Blues
levels = np.linspace(0,0.02,nlev)
cbticks = np.arange(0,0.02+0.002,0.002)
elif 'seasonal_cycle' in keys:
cmap = cmap_tsurf
levels = np.linspace(-0.01,0.01,nlev)
cbticks = np.arange(-0.01,0.01+0.0012,0.002)
# ICE
elif name == 'ice':
cmap = cm.Blues_r
if 'anomalies' in keys:
cmap = cmap_tsurf
levels = np.linspace(-1,1,nlev)
cbticks = np.arange(-1,1+0.2,0.2)
else:
if 'annual_mean' in keys:
levels = np.linspace(0,1,nlev)
cbticks = np.arange(0,1+0.1,0.1)
elif 'seasonal_cycle' in keys:
cmap = cmap_tsurf
levels = np.linspace(0,1,nlev)
cbticks = np.arange(0,1+0.1,0.1)
# SW
elif name == 'sw':
cmap = cm.YlOrRd
if 'anomalies' in keys:
cmap = cmap_tsurf
levels = np.linspace(-5,5,nlev)
cbticks = np.arange(-5,5+1,1)
else:
if 'annual_mean' in keys:
levels = np.linspace(50,350,nlev)
cbticks = np.arange(50,350+50,50)
elif 'seasonal_cycle' in keys:
cmap = cmap_tsurf
levels = np.linspace(-180,180,nlev)
cbticks = np.arange(-180,180+40,40)
# CLOUD
elif name == 'cloud':
cmap = cm.Greys_r
if 'anomalies' in keys:
cmap = cmap_tsurf
levels = np.linspace(-0.5,0.5,nlev)
cbticks = np.arange(-0.5,0.5+0.1,0.1)
else:
if 'annual_mean' in keys:
levels = np.linspace(0,1,nlev)
cbticks = np.arange(0,1+0.1,0.1)
elif 'seasonal_cycle' in keys:
cmap = cmap_tsurf
levels = np.linspace(-1,1,nlev)
cbticks = np.arange(-1,1+0.2,0.2)
# SOLAR
elif name == 'solar':
if len(self.shape) == 1:
self=GREB.def_DataArray(data=np.broadcast_to(self,[GREB.dx()]+list(self.shape)).transpose(),
dims=('lat','lon'),
attrs=self.attrs)
cmap = cm.YlOrRd
if 'anomalies' in keys:
if 'annual_mean' in keys:
cmap = cm.hsv
levels = np.linspace(-8,0,nlev)
cbticks = np.arange(-8,1,1)
elif 'seasonal_cycle' in keys:
cmap = cmap_tsurf
levels = np.linspace(-5,5,nlev)
cbticks = np.arange(-5,5+1,1)
else:
if 'annual_mean' in keys:
levels = np.linspace(150,420,nlev)
cbticks = np.arange(150,420+40,40)
elif 'seasonal_cycle' in keys:
cmap = cmap_tsurf
levels = np.linspace(-230,230,nlev)
cbticks = np.arange(-230,230+40,40)
return {'self':self,'levels':levels,'cbticks':cbticks,'cmap':cmap}
def plotlev(self,
title = None,
units = None,
du= None,
t_student=False,
outpath = None,
save_kwargs = None,
double_axis=False,
**contourf_kwargs):
if ("latitude" in self.dims) or ("latitude_0" in self.dims) or ("lat" in self.dims):
core_dim="lat"
elif ("longitude" in self.dims) or ("longitude_0" in self.dims) or ("lon" in self.dims):
core_dim="lon"
lon = self.get_spatial_coords()[1]
l=len(self[lon])
self = self.roll({lon:int(l/2)},roll_coords=True)
oldlon=self[lon]
newlon=oldlon.where(oldlon < 180, oldlon-360)
self=self.assign_coords({lon:newlon})._to_contiguous_lon()
if "pressure" in self.dims:
vertical_levs = "pressure"
elif "model_level_number" in self.dims:
vertical_levs = "um_levs"
else:
vertical_levs = None
warnings.warn("The nature of the vertical level is not known")
ax = plt.axes() if 'ax' not in contourf_kwargs else contourf_kwargs.pop('ax')
if ('add_colorbar' not in contourf_kwargs) or contourf_kwargs['add_colorbar']:
contourf_kwargs['add_colorbar']=True
if 'cbar_kwargs' not in contourf_kwargs:
contourf_kwargs['cbar_kwargs'] = dict()
if units is not None:
contourf_kwargs['cbar_kwargs']['label']=units
if du is not None:
umin=contourf_kwargs['levels'][0]
umax=contourf_kwargs['levels'][-1]
contourf_kwargs['cbar_kwargs']['ticks']=np.arange(umin,umax+du,du)
if (double_axis):
lst=['location','orientation','fraction','fraction','shrink','aspect','pad','anchor','panchor']
if np.all([p not in contourf_kwargs['cbar_kwargs'] for p in lst]):
contourf_kwargs['cbar_kwargs']['pad']=0.15
if "yscale" not in contourf_kwargs:
contourf_kwargs['yscale'] = "log" if vertical_levs == "pressure" else "linear"
if "yincrease" not in contourf_kwargs:
contourf_kwargs['yincrease'] = False if vertical_levs == "um_levs" else True
im=self.plot.contourf(ax=ax,
**contourf_kwargs,
)
if isinstance(t_student,bool):
if t_student:
raise Exception('t_student must be False, or equal to either a dictionary or an '
'xarray.DataArray containing t-student distribution probabilities.')
else:
if check_xarray(t_student,"DataArray"):
t_student = {"p":t_student}
elif isinstance(t_student,np.ndarray):
t_student = {"p":xr.DataArray(data=t_student,dims = ["latitude","longitude"], coords=[UM.latitude,UM.longitude])}
if isinstance(t_student,dict):
if "p" not in t_student:
raise Exception('t_student must be contain "p" key, containing '
'an xarray.DataArray with t-student distribution '
'probabilities.\nTo obtain t_student distribution '
'probabilities, you can use the "t_student_probability" function.')
elif isinstance(t_student["p"],np.ndarray):
t_student["p"] = xr.DataArray(data=t_student["p"],dims = ["latitude","longitude"], coords=[UM.latitude,UM.longitude])
if "treshold" in t_student:
if t_student["treshold"] > 1:
raise Exception("Treshold must be <= 1")
else:
t_student["treshold"]=0.05
if "hatches" not in t_student:
t_student["hatches"]= '///'
else:
raise Exception('t_student must be either a dictionary or an '
'xarray.DataArray containing t-student distribution probabilities.')
p=t_student["p"]
a=t_student["treshold"]
P=DataArray(p.where(p<a,0).where(p>=a,1))
if core_dim == "lon":
P = P.roll({lon:int(l/2)},roll_coords=True).assign_coords({lon:newlon})._to_contiguous_lon()
_check_shapes(P,self)
contourf_kwargs['levels']=np.linspace(0,1,3)
contourf_kwargs['hatches']=['',t_student['hatches']]
contourf_kwargs['alpha']=0
contourf_kwargs['add_colorbar']=False
if 'cbar_kwargs' in contourf_kwargs: del contourf_kwargs['cbar_kwargs']
if 'extend' in contourf_kwargs: del contourf_kwargs['extend']
P.plot.contourf(
ax=ax,
**contourf_kwargs,
)
ax.set_xlabel("")
if core_dim == "lat":
ax.set_xticks(np.arange(-90,90+30,30))
ax.set_xticklabels(["90S","60S","30S","0","30N","60N","90N"])
ax.xaxis.set_minor_locator(MultipleLocator(10))
elif core_dim == "lon":
ax.set_xticks(np.arange(-180,180+60,60))
ax.set_xticklabels(["180W","120W","60W","0","60E","120E","180E"])
ax.xaxis.set_minor_locator(MultipleLocator(10))
if vertical_levs=="pressure":
yticks=[1000,800,600,400,200,100,50]
ax.set_yticks(yticks)
ax.set_yticklabels([str(t) for t in yticks])
ax.set_ylim([1000,50])
ax.set_ylabel("Pressure [hPa]")
elif vertical_levs=="um_levs":
ax.set_ylim([1,32])
yticks=np.arange(1,33)
ax.set_yticks(yticks)
ticklabels=[str(i) for i in yticks]
ticklabels[1::2]=["" for _ in ticklabels[1::2]]
ax.set_yticklabels(ticklabels,fontsize=8)
ax.set_ylabel("Model Level Number")
ax.grid(ls="--",which='both',alpha=0.7)
# Set double axis
if double_axis:
ax2=ax.twinx()
if vertical_levs == "pressure":
ax2.set_ylim([1000,50])
ax2.set_yscale('log')
if double_axis == "height":
ax2.set_ylabel('Height')
ax2.set_yticks([1000,800,600,400,200,100,50])
ax2.set_yticklabels(['~20m','~500m','~3km','~6km','~12km','~17km','~20km'],fontsize=8)
else:
ax2.set_ylabel('Model Level Number')
ax2.set_yticks([1000,900,700,500,200,100,60])
ax2.set_yticklabels(['~1','~5','~12','~17','~25','~29','~31'],fontsize=8)
elif vertical_levs == "um_levs":
ax2.set_ylim([1,32])
ax2.set_yticks([1,5,8,10,17,25,29,31])
if double_axis == "height":
ax2.set_ylabel('Height')
ax2.set_yticklabels(['~20m','~500m','~3km','~6km','~12km','~17km','~20km'],fontsize=8)
else:
ax2.set_ylabel('Pressure [hPa]')
ax2.set_yticklabels(['~1000','~900','~850','~750','~500','~200','~100','~60'],fontsize=8)
# Set Title
title_kwargs=dict()
if title is None:
titlelabel=self.name
elif isinstance(title,dict):
if "label" not in title:
raise Exception("Title dictionary needs to have the 'label' keyword for the text to use as the title")
else:
titlelabel=title.pop("label")
title_kwargs=title
else:
titlelabel=title
ax.set_title(titlelabel,**title_kwargs)
if save_kwargs is not None:
save_kwargs = {'dpi':300, 'bbox_inches':'tight', **save_kwargs}
else:
save_kwargs = {'dpi':300, 'bbox_inches':'tight'}
if outpath is not None:
plt.savefig(outpath,**save_kwargs)
return im
def plotprof(self,
other_data=None,
labels = None,
colors = None,
timesteps = None,
normalize = False,
xlim=None,
dx=None,
title = None,
units = None,
legend = True,
legend_kwargs={},
double_axis=False,
save_kwargs = None,
outpath = None,
**plot_kwargs
):
'''Plot DataArray vertical profiles.
If time coord is provided, plots the profiles with confidence levels (min|mean|max values)
for every vertical level.'''
if other_data is None:
all_data=[self]
else:
if not isinstance(other_data,list):
other_data=[other_data]
all_data=[self]+other_data
# Check shapes and dims are the same
if len(all_data)>1:
dims=[d.dims for d in all_data]
if dims.count(dims[0]) != len(dims):
raise Exception("Variables don't have the same dimensions!")
shapes=[d.shape for d in all_data]
if shapes.count(shapes[0]) != len(shapes):
raise Exception("Variables don't have the same shape!")
# Check and set labels
if not isinstance(labels,list):
labels=[labels]
if len(all_data) > len(labels):
labels=labels+[None for n in range(len(all_data) - len(labels))]
else:
labels=labels[:len(all_data)]
# Check and set colors
def_colors=['blue','darkorange','firebrick',
'darkgreen','m','turquoise',
'rebeccapurple', 'grey']
if colors is None:
colors=def_colors
else:
if not isinstance(colors,list):
colors=[colors]
def_colors=[c for c in def_colors if c not in colors]
colors=colors+def_colors
if len(all_data) > len(colors):
raise Exception(f"{len(all_data)} variables provided but only {len(colors)} colors available.\n \
Please provide {len(all_data)-len(colors)} more colors.")
else:
colors=colors[:len(all_data)]
d=all_data[0]
has_time = 'time' in d.dims
if has_time and timesteps is None:
timesteps = len(d.time)
if 'pressure' in d.dims:
levs = 'pressure'
yincrease = False
yscale = "log"
plev=True
ymin,ymax=1000,50
yticks=[1000,800,600,400,200,100,50]
elif 'model_level_number' in d.dims:
levs = 'model_level_number'
yincrease = True
yscale = "linear"
plev=False
ymin,ymax=1,32
yticks=np.arange(1,33)
else:
raise Exception('Vertical levels not present or not understood!')
if "ax" in plot_kwargs:
ax=plot_kwargs["ax"]
else:
ax=plt.axes()
for data,label,color in zip(all_data,labels,colors):
if plev:
data = data.sel(pressure=slice(49,1001))
else:
data = data.sel(model_level_number=slice(None,32))
if has_time:
am = data.annual_mean(timesteps,normalize=normalize)
min=data.isel(time=slice(-timesteps,None)).min('time')
max=data.isel(time=slice(-timesteps,None)).max('time')
else:
am = data
# Plot
im=am.plot(
y=levs,
yincrease=yincrease,
yscale=yscale,
label=label,
color=color,
**plot_kwargs)
# Draw confidence levels (max, min over time)
if has_time:
ax.fill_betweenx(y=getattr(am,levs), x1=min, x2=max,
color=color, alpha=0.2)
# Draw vertical 0 line
ax.vlines(0, ymin, ymax, colors='k', ls='--',lw=0.8)
# Set ylim
ax.set_ylim(ymin,ymax)
# Set xlim and xticks
if xlim is not None:
ax.set_xlim(xlim)
if dx is not None:
ax.set_xticks(np.arange(xlim[0],xlim[1]+dx,dx))
# Set yticks/yticklabels
ax.set_yticks(yticks)
if plev:
ax.set_yticklabels([str(i) for i in yticks])
else:
ticklabels=[str(i) for i in yticks]
ticklabels[1::2]=["" for _ in ticklabels[1::2]]
ax.set_yticklabels(ticklabels,fontsize=8)
# Set grid
ax.grid(ls="--",which='both',alpha=0.7)
# Set legend
if legend and np.all([l is not None for l in labels]):
ax.legend(**legend_kwargs)
# Set units (xlabel)
if units is not None:
ax.set_xlabel(units)
# Set ylabel
if plev:
ax.set_ylabel("Pressure [hPa]")
else:
ax.set_ylabel("Model Level Number")
# Set double axis
if double_axis:
ax2=ax.twinx()
if plev:
ax2.set_ylim([1000,50])
ax2.set_yscale('log')
if double_axis == "height":
ax2.set_ylabel('Height')
ax2.set_yticks([1000,800,600,400,200,100,50])
ax2.set_yticklabels(['~20m','~500m','~3km','~6km','~12km','~17km','~20km'],fontsize=8)
else:
ax2.set_ylabel('Model Level Number')
ax2.set_yticks([1000,900,700,500,200,100,60])
ax2.set_yticklabels(['~1','~5','~12','~17','~25','~29','~31'],fontsize=8)
else:
ax2.set_ylim([1,32])
ax2.set_yticks([1,5,8,10,17,25,29,31])
if double_axis == "height":
ax2.set_ylabel('Height')
ax2.set_yticklabels(['~20m','~500m','~3km','~6km','~12km','~17km','~20km'],fontsize=8)
else:
ax2.set_ylabel('Pressure [hPa]')
ax2.set_yticklabels(['~1000','~900','~850','~750','~500','~200','~100','~60'],fontsize=8)
for sp in ax2.spines:
ax2.spines[sp].set_visible(False)
# Set Title
if title is None:
title=d.name
ax.set_title(title)
# Save plot
if save_kwargs is not None:
save_kwargs = {'dpi':300, 'bbox_inches':'tight',**save_kwargs}
else:
save_kwargs = {'dpi':300, 'bbox_inches':'tight'}
if outpath is not None:
plt.savefig(outpath,**save_kwargs)
return im
def _to_contiguous_lon(self):
'''
Function to close the longitude coord (for plotting)
'''
lon=self.get_spatial_coords()[1]
if np.all(self[lon]>=0):
if (0 in self[lon]) and (360 in self[lon]):
return
elif (0 in self[lon]):
return xr.concat([self, self.sel({lon:0}).assign_coords({lon:360.})], dim=lon)
elif (360 in self[lon]):
return xr.concat([self.sel({lon:360}).assign_coords({lon:0.}), self], dim=lon)
else:
val=self.isel({lon:[0,-1]}).mean(lon)
return xr.concat([val.assign_coords({lon:0.}),self,val.assign_coords({lon:360.})], dim=lon)
else:
if (-180 in self[lon]) and (180 in self[lon]):
return
elif (-180 in self[lon]):
return xr.concat([self, self.sel({lon:-180}).assign_coords({lon:180.})], dim=lon)
elif (180 in self[lon]):
return xr.concat([self.sel({lon:180}).assign_coords({lon:-180.}), self], dim=lon)
else:
val=self.isel({lon:[0,-1]}).mean(lon)
return xr.concat([val.assign_coords({lon:-180.}),self,val.assign_coords({lon:180.})], dim=lon)
def annual_mean(self,num=None,copy=True,update_attrs=True,normalize=False):
return annual_mean(self,num=num,copy=copy,update_attrs=update_attrs,
normalize=normalize)
def annual_cycle(self,num=None,copy=True,update_attrs=True):
return annual_cycle(self,num=num,copy=copy,update_attrs=update_attrs)
def seasonal_cycle(self,copy=True,update_attrs=True):
return seasonal_cycle(self,copy=copy,update_attrs=update_attrs)
def anomalies(self,base=None,copy=True,update_attrs=True):
return anomalies(self,x_base=base,copy=copy,update_attrs=update_attrs)
def average(self, dim=None, weights=None,**kwargs):
if 'keep_attrs' not in kwargs: kwargs.update({'keep_attrs':True})
return average(self, dim=dim, weights=weights,**kwargs)
def latitude_mean(self,copy=True,update_attrs=True):
return latitude_mean(self,copy=copy,update_attrs=update_attrs)
def longitude_mean(self,copy=True,update_attrs=True):
return longitude_mean(self,copy=copy,update_attrs=update_attrs)
def global_mean(self,copy=True,update_attrs=True):
return global_mean(self,copy=copy,update_attrs=update_attrs)
def rms(self,copy=True,update_attrs=True):
return rms(self,copy=copy,update_attrs=update_attrs)
def to_celsius(self,copy=True):
if copy: self = self.copy()
if self.attrs['units'] == 'K':
self.attrs['units'] = 'C'
attrs=self.attrs
if 'anomalies' in self.attrs: return self
newarray=self-273.15
newarray.attrs = attrs
return newarray
elif self.attrs['units'] == 'C':
return self
else:
raise Exception('Cannot convert to Celsius.\n{} '.format(self.name)+
'does not have temperature units.')
def group_by(self,time_group,num=None,copy=True,update_attrs=True):
return group_by(self,time_group,num=num,copy=copy,update_attrs=update_attrs)
def srex_mean(self,copy=True):
mask=SREX_regions.mask()
if copy: self=self.copy()
new=self.groupby(mask).mean('stacked_lat_lon')
new.coords['srex_abbrev'] = ('srex_region', srex_regions.abbrevs)
new.coords['srex_name'] = ('srex_region', srex_regions.names)
return new
def seasonal_time_series(self,first_month_num=None,update_attrs=True):