-
Notifications
You must be signed in to change notification settings - Fork 15
Expand file tree
/
Copy pathpsyplot.data.html
More file actions
4245 lines (4070 loc) · 475 KB
/
Copy pathpsyplot.data.html
File metadata and controls
4245 lines (4070 loc) · 475 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
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title><no title> — psyplot documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../_static/nc-table-styles.css?v=d585f46f" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=87e54e7c" />
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css" />
<link rel="shortcut icon" href="../_static/psyplot.ico"/>
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/design-tabs.js?v=f930bc37"></script>
<script src="../_static/js/theme.js"></script>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="<no title>" href="psyplot.docstring.html" />
<link rel="prev" title="<no title>" href="psyplot.sphinxext.extended_napoleon.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home">
psyplot
<img src="../_static/psyplot.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../about.html">About psyplot</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../about.html#why-psyplot">Why psyplot?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../about.html#what-it-is-and-what-it-is-not">What it is, and what it is not</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../about.html#what-it-is">What it is</a></li>
<li class="toctree-l3"><a class="reference internal" href="../about.html#what-it-is-not">What it is not</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../about.html#about-the-author">About the author</a></li>
<li class="toctree-l2"><a class="reference internal" href="../about.html#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../installing.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../installing.html#how-to-install">How to install</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../installing.html#installation-using-conda">Installation using conda</a></li>
<li class="toctree-l3"><a class="reference internal" href="../installing.html#installation-using-pip">Installation using pip</a></li>
<li class="toctree-l3"><a class="reference internal" href="../installing.html#installation-from-source">Installation from source</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../installing.html#dependencies">Dependencies</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../installing.html#required-dependencies">Required dependencies</a></li>
<li class="toctree-l3"><a class="reference internal" href="../installing.html#optional-dependencies">Optional dependencies</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../installing.html#running-the-tests">Running the tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installing.html#building-the-docs">Building the docs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installing.html#uninstallation">Uninstallation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../installing.html#uninstallation-via-conda">Uninstallation via conda</a></li>
<li class="toctree-l3"><a class="reference internal" href="../installing.html#uninstallation-via-pip">Uninstallation via pip</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html#initialization-and-interactive-usage">Initialization and interactive usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html#choosing-the-dimension">Choosing the dimension</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html#configuring-the-appearance-of-the-plot">Configuring the appearance of the plot</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html#controlling-the-update">Controlling the update</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../getting_started.html#automatic-update">Automatic update</a></li>
<li class="toctree-l3"><a class="reference internal" href="../getting_started.html#direct-control-on-formatoption-update">Direct control on formatoption update</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html#creating-and-managing-multiple-plots">Creating and managing multiple plots</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../getting_started.html#creating-multiple-plots">Creating multiple plots</a></li>
<li class="toctree-l3"><a class="reference internal" href="../getting_started.html#slicing-and-filtering-the-project">Slicing and filtering the project</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html#saving-and-loading-your-project">Saving and loading your project</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html#using-presets">Using presets</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html#adding-your-own-script-the-post-formatoption">Adding your own script: The <code class="xref py py-attr docutils literal notranslate"><span class="pre">post</span></code> formatoption</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference external" href="https://psyplot.github.io/examples/">Example Gallery</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration.html">Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../configuration.html#the-rcparams">The <code class="docutils literal notranslate"><span class="pre">rcParams</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../configuration.html#default-formatoptions">Default formatoptions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects.html">Subprojects</a></li>
<li class="toctree-l1"><a class="reference internal" href="../accessors.html">xarray Accessors</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../accessors.html#the-datasetaccessor-dataset-accessor">The <code class="xref py py-class docutils literal notranslate"><span class="pre">DatasetAccessor</span></code> dataset accessor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../accessors.html#the-interactivearray-dataarray-accessor">The <code class="xref py py-class docutils literal notranslate"><span class="pre">InteractiveArray</span></code> dataarray accessor</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../accessors.html#creating-plots-with-the-dataarray-accessor">Creating plots with the dataarray accessor</a></li>
<li class="toctree-l3"><a class="reference internal" href="../accessors.html#updating-plots-and-arrays-with-the-dataarray-accessor">Updating plots and arrays with the dataarray accessor</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../plugins.html">Psyplot plugins</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../plugins.html#existing-plugins">Existing plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugins.html#how-to-exclude-plugins">How to exclude plugins</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../plugins.html#the-psyplot-plugins-environment-variable">The <code class="docutils literal notranslate"><span class="pre">PSYPLOT_PLUGINS</span></code> environment variable</a></li>
<li class="toctree-l3"><a class="reference internal" href="../plugins.html#the-psyplot-plotmethods-environment-variable">The <code class="docutils literal notranslate"><span class="pre">PSYPLOT_PLOTMETHODS</span></code> environment variable</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../command_line.html">Command line usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../command_line.html#positional-arguments">Positional Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="../command_line.html#named-arguments">Named Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="../command_line.html#info-options">Info options</a></li>
<li class="toctree-l2"><a class="reference internal" href="../command_line.html#output-options">Output options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../develop/index.html">Developers guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../develop/framework.html">The psyplot framework</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../develop/framework.html#the-project-function">The <code class="xref py py-func docutils literal notranslate"><span class="pre">project()</span></code> function</a></li>
<li class="toctree-l3"><a class="reference internal" href="../develop/framework.html#the-interactivebase-and-the-plotter-classes">The <code class="xref py py-class docutils literal notranslate"><span class="pre">InteractiveBase</span></code> and the <code class="xref py py-class docutils literal notranslate"><span class="pre">Plotter</span></code> classes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../develop/framework.html#interactive-data-objects">Interactive data objects</a></li>
<li class="toctree-l4"><a class="reference internal" href="../develop/framework.html#visualization-objects">Visualization objects</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../develop/framework.html#formatoptions">Formatoptions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../develop/plugins_guide.html">How to implement your own plotters and plugins</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../develop/plugins_guide.html#creating-plotters">Creating plotters</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../develop/plugins_guide.html#interface-for-the-plotter">Interface for the plotter</a></li>
<li class="toctree-l4"><a class="reference internal" href="../develop/plugins_guide.html#interface-to-the-data">Interface to the data</a></li>
<li class="toctree-l4"><a class="reference internal" href="../develop/plugins_guide.html#interfacing-to-other-formatoptions">Interfacing to other formatoptions</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../develop/plugins_guide.html#creating-new-plugins">Creating new plugins</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../develop/plugins_guide.html#creating-a-package-with-the-psyplot-plugin-template">Creating a package with the psyplot-plugin-template</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../develop/plugins_guide.html#rcparams-handling-in-plugins"><code class="docutils literal notranslate"><span class="pre">rcParams</span></code> handling in plugins</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contribution and development hints</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../contributing.html#code-of-conduct">Code of Conduct</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contributing.html#what-should-i-know-before-i-get-started">What should I know before I get started?</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../contributing.html#the-psyplot-framework">The psyplot framework</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../contributing.html#contributing-in-the-development">Contributing in the development</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contributing.html#helpers">Helpers</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../contributing.html#shortcuts-with-make">Shortcuts with make</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing.html#annotating-licenses">Annotating licenses</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../contributing.html#fixing-the-docs">Fixing the docs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contributing.html#contributing-to-the-code">Contributing to the code</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contributing.html#updating-the-skeleton-for-this-package">Updating the skeleton for this package</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="psyplot.html">psyplot package</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="psyplot.html#psyplot.get_versions"><code class="docutils literal notranslate"><span class="pre">get_versions()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="psyplot.html#psyplot.with_gui"><code class="docutils literal notranslate"><span class="pre">with_gui</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="psyplot.html#subpackages">Subpackages</a><ul>
<li class="toctree-l4"><a class="reference internal" href="psyplot.config.html">psyplot.config package</a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.sphinxext.html">psyplot.sphinxext package</a></li>
</ul>
</li>
<li class="toctree-l3 current"><a class="reference internal" href="psyplot.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l4 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">AbsoluteTimeDecoder</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.AbsoluteTimeEncoder"><code class="docutils literal notranslate"><span class="pre">AbsoluteTimeEncoder</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.ArrayList"><code class="docutils literal notranslate"><span class="pre">ArrayList</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.CFDecoder"><code class="docutils literal notranslate"><span class="pre">CFDecoder</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.DatasetAccessor"><code class="docutils literal notranslate"><span class="pre">DatasetAccessor</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.InteractiveArray"><code class="docutils literal notranslate"><span class="pre">InteractiveArray</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.InteractiveBase"><code class="docutils literal notranslate"><span class="pre">InteractiveBase</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.InteractiveList"><code class="docutils literal notranslate"><span class="pre">InteractiveList</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.Signal"><code class="docutils literal notranslate"><span class="pre">Signal</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.UGridDecoder"><code class="docutils literal notranslate"><span class="pre">UGridDecoder</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.decode_absolute_time"><code class="docutils literal notranslate"><span class="pre">decode_absolute_time()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.encode_absolute_time"><code class="docutils literal notranslate"><span class="pre">encode_absolute_time()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.get_filename_ds"><code class="docutils literal notranslate"><span class="pre">get_filename_ds()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.get_fname_funcs"><code class="docutils literal notranslate"><span class="pre">get_fname_funcs</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.get_index_from_coord"><code class="docutils literal notranslate"><span class="pre">get_index_from_coord()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.get_tdata"><code class="docutils literal notranslate"><span class="pre">get_tdata()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.open_dataset"><code class="docutils literal notranslate"><span class="pre">open_dataset()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.open_mfdataset"><code class="docutils literal notranslate"><span class="pre">open_mfdataset()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.setup_coords"><code class="docutils literal notranslate"><span class="pre">setup_coords()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.t_patterns"><code class="docutils literal notranslate"><span class="pre">t_patterns</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.to_netcdf"><code class="docutils literal notranslate"><span class="pre">to_netcdf()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#psyplot.data.to_slice"><code class="docutils literal notranslate"><span class="pre">to_slice()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.docstring.html"><code class="docutils literal notranslate"><span class="pre">PsyplotDocstringProcessor</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.docstring.html#psyplot.docstring.append_original_doc"><code class="docutils literal notranslate"><span class="pre">append_original_doc()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.docstring.html#psyplot.docstring.dedent"><code class="docutils literal notranslate"><span class="pre">dedent()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.docstring.html#psyplot.docstring.docstrings"><code class="docutils literal notranslate"><span class="pre">docstrings</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.docstring.html#psyplot.docstring.indent"><code class="docutils literal notranslate"><span class="pre">indent()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.gdal_store.html"><code class="docutils literal notranslate"><span class="pre">GdalStore</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.plotter.html"><code class="docutils literal notranslate"><span class="pre">BEFOREPLOTTING</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.plotter.html#psyplot.plotter.DictFormatoption"><code class="docutils literal notranslate"><span class="pre">DictFormatoption</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.plotter.html#psyplot.plotter.END"><code class="docutils literal notranslate"><span class="pre">END</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.plotter.html#psyplot.plotter.Formatoption"><code class="docutils literal notranslate"><span class="pre">Formatoption</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.plotter.html#psyplot.plotter.FormatoptionMeta"><code class="docutils literal notranslate"><span class="pre">FormatoptionMeta</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.plotter.html#psyplot.plotter.Plotter"><code class="docutils literal notranslate"><span class="pre">Plotter</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.plotter.html#psyplot.plotter.PostProcDependencies"><code class="docutils literal notranslate"><span class="pre">PostProcDependencies</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.plotter.html#psyplot.plotter.PostProcessing"><code class="docutils literal notranslate"><span class="pre">PostProcessing</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.plotter.html#psyplot.plotter.PostTiming"><code class="docutils literal notranslate"><span class="pre">PostTiming</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.plotter.html#psyplot.plotter.START"><code class="docutils literal notranslate"><span class="pre">START</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.plotter.html#psyplot.plotter.default_print_func"><code class="docutils literal notranslate"><span class="pre">default_print_func()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.plotter.html#psyplot.plotter.format_time"><code class="docutils literal notranslate"><span class="pre">format_time()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.plotter.html#psyplot.plotter.groups"><code class="docutils literal notranslate"><span class="pre">groups</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.plotter.html#psyplot.plotter.is_data_dependent"><code class="docutils literal notranslate"><span class="pre">is_data_dependent()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html"><code class="docutils literal notranslate"><span class="pre">DataArrayPlotter</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.DataArrayPlotterInterface"><code class="docutils literal notranslate"><span class="pre">DataArrayPlotterInterface</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.DatasetPlotter"><code class="docutils literal notranslate"><span class="pre">DatasetPlotter</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.DatasetPlotterInterface"><code class="docutils literal notranslate"><span class="pre">DatasetPlotterInterface</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.PROJECT_CLS"><code class="docutils literal notranslate"><span class="pre">PROJECT_CLS</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.PlotterInterface"><code class="docutils literal notranslate"><span class="pre">PlotterInterface</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.Project"><code class="docutils literal notranslate"><span class="pre">Project</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.ProjectPlotter"><code class="docutils literal notranslate"><span class="pre">ProjectPlotter</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.close"><code class="docutils literal notranslate"><span class="pre">close()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.gcp"><code class="docutils literal notranslate"><span class="pre">gcp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.get_project_nums"><code class="docutils literal notranslate"><span class="pre">get_project_nums()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.multiple_subplots"><code class="docutils literal notranslate"><span class="pre">multiple_subplots()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.plot"><code class="docutils literal notranslate"><span class="pre">plot</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.project"><code class="docutils literal notranslate"><span class="pre">project()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.register_plotter"><code class="docutils literal notranslate"><span class="pre">register_plotter()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.scp"><code class="docutils literal notranslate"><span class="pre">scp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.project.html#psyplot.project.unregister_plotter"><code class="docutils literal notranslate"><span class="pre">unregister_plotter()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html"><code class="docutils literal notranslate"><span class="pre">Defaultdict</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.check_key"><code class="docutils literal notranslate"><span class="pre">check_key()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.get_default_value"><code class="docutils literal notranslate"><span class="pre">get_default_value()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.hashable"><code class="docutils literal notranslate"><span class="pre">hashable()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.is_iterable"><code class="docutils literal notranslate"><span class="pre">is_iterable()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.is_remote_url"><code class="docutils literal notranslate"><span class="pre">is_remote_url()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.isstring"><code class="docutils literal notranslate"><span class="pre">isstring()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.join_dicts"><code class="docutils literal notranslate"><span class="pre">join_dicts()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.plugin_entrypoints"><code class="docutils literal notranslate"><span class="pre">plugin_entrypoints()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.sort_kwargs"><code class="docutils literal notranslate"><span class="pre">sort_kwargs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.utils.html#psyplot.utils.unique_everseen"><code class="docutils literal notranslate"><span class="pre">unique_everseen()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.warning.html"><code class="docutils literal notranslate"><span class="pre">PsyPlotCritical</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.warning.html#psyplot.warning.PsyPlotRuntimeWarning"><code class="docutils literal notranslate"><span class="pre">PsyPlotRuntimeWarning</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.warning.html#psyplot.warning.PsyPlotWarning"><code class="docutils literal notranslate"><span class="pre">PsyPlotWarning</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.warning.html#psyplot.warning.critical"><code class="docutils literal notranslate"><span class="pre">critical()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.warning.html#psyplot.warning.customwarn"><code class="docutils literal notranslate"><span class="pre">customwarn()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.warning.html#psyplot.warning.disable_warnings"><code class="docutils literal notranslate"><span class="pre">disable_warnings()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.warning.html#psyplot.warning.warn"><code class="docutils literal notranslate"><span class="pre">warn()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../todos.html">ToDos</a></li>
<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-5-1">v1.5.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#added">Added</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-5-0">v1.5.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id2">Added</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-4-3">v1.4.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-4-2">v1.4.2</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id3">Changed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-4-1">v1.4.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id4">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#fixed">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id5">Changed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-4-0">v1.4.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id6">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id7">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id8">Changed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-3-2">v1.3.2</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id9">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-3-1">v1.3.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id10">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-3-0">v1.3.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id11">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id12">Changed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-2-1">v1.2.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-2-0">v1.2.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id13">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#removed">Removed</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id14">Changed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-1-0">v1.1.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id15">Added</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../changelog.html#v1-0-0">v1.0.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id16">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id17">Changed</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">psyplot</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="../api.html">API Reference</a></li>
<li class="breadcrumb-item"><a href="psyplot.html">psyplot package</a></li>
<li class="breadcrumb-item active"><no title></li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/psyplot.data.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<p id="module-psyplot.data">Data management core routines of psyplot.</p>
<p><strong>Classes:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.AbsoluteTimeDecoder" title="psyplot.data.AbsoluteTimeDecoder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AbsoluteTimeDecoder</span></code></a>(array)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.AbsoluteTimeEncoder" title="psyplot.data.AbsoluteTimeEncoder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AbsoluteTimeEncoder</span></code></a>(array)</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.ArrayList" title="psyplot.data.ArrayList"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ArrayList</span></code></a>([iterable, attrs, auto_update, ...])</p></td>
<td><p>Base class for creating a list of interactive arrays from a dataset</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.CFDecoder" title="psyplot.data.CFDecoder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CFDecoder</span></code></a>([ds, x, y, z, t])</p></td>
<td><p>Class that interpretes the coordinates and attributes accordings to cf-conventions</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.DatasetAccessor" title="psyplot.data.DatasetAccessor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DatasetAccessor</span></code></a>(ds)</p></td>
<td><p>A dataset accessor to interface with the psyplot package</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.InteractiveArray" title="psyplot.data.InteractiveArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">InteractiveArray</span></code></a>(xarray_obj, *args, **kwargs)</p></td>
<td><p>Interactive psyplot accessor for the data array</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.InteractiveBase" title="psyplot.data.InteractiveBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">InteractiveBase</span></code></a>([plotter, arr_name, auto_update])</p></td>
<td><p>Class for the communication of a data object with a suitable plotter</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.InteractiveList" title="psyplot.data.InteractiveList"><code class="xref py py-obj docutils literal notranslate"><span class="pre">InteractiveList</span></code></a>(*args, **kwargs)</p></td>
<td><p>List of <a class="reference internal" href="#psyplot.data.InteractiveArray" title="psyplot.data.InteractiveArray"><code class="xref py py-class docutils literal notranslate"><span class="pre">InteractiveArray</span></code></a> instances that can be plotted itself</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.Signal" title="psyplot.data.Signal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Signal</span></code></a>([name, cls_signal])</p></td>
<td><p>Signal to connect functions to a specific event</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.UGridDecoder" title="psyplot.data.UGridDecoder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UGridDecoder</span></code></a>([ds, x, y, z, t])</p></td>
<td><p>Decoder for UGrid data sets</p></td>
</tr>
</tbody>
</table>
<p><strong>Functions:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.decode_absolute_time" title="psyplot.data.decode_absolute_time"><code class="xref py py-obj docutils literal notranslate"><span class="pre">decode_absolute_time</span></code></a>(times)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.encode_absolute_time" title="psyplot.data.encode_absolute_time"><code class="xref py py-obj docutils literal notranslate"><span class="pre">encode_absolute_time</span></code></a>(times)</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.get_filename_ds" title="psyplot.data.get_filename_ds"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_filename_ds</span></code></a>(ds[, dump, paths])</p></td>
<td><p>Return the filename of the corresponding to a dataset</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.get_index_from_coord" title="psyplot.data.get_index_from_coord"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_index_from_coord</span></code></a>(coord, base_index)</p></td>
<td><p>Function to return the coordinate as integer, integer array or slice</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.get_tdata" title="psyplot.data.get_tdata"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_tdata</span></code></a>(t_format, files)</p></td>
<td><p>Get the time information from file names</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.open_dataset" title="psyplot.data.open_dataset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">open_dataset</span></code></a>(filename_or_obj[, decode_cf, ...])</p></td>
<td><p>Open an instance of <a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.6.1.dev0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">xarray.Dataset</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.open_mfdataset" title="psyplot.data.open_mfdataset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">open_mfdataset</span></code></a>(paths[, decode_cf, ...])</p></td>
<td><p>Open multiple files as a single dataset.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.setup_coords" title="psyplot.data.setup_coords"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setup_coords</span></code></a>([arr_names, sort, dims])</p></td>
<td><p>Sets up the arr_names dictionary for the plot</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.to_netcdf" title="psyplot.data.to_netcdf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_netcdf</span></code></a>(ds, *args, **kwargs)</p></td>
<td><p>Store the given dataset as a netCDF file</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.to_slice" title="psyplot.data.to_slice"><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_slice</span></code></a>(arr)</p></td>
<td><p>Test whether <cite>arr</cite> is an integer array that can be replaced by a slice</p></td>
</tr>
</tbody>
</table>
<p><strong>Data:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.get_fname_funcs" title="psyplot.data.get_fname_funcs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_fname_funcs</span></code></a></p></td>
<td><p>functions to use to extract the file name from a data store</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.t_patterns" title="psyplot.data.t_patterns"><code class="xref py py-obj docutils literal notranslate"><span class="pre">t_patterns</span></code></a></p></td>
<td><p>mapping that translates datetime format strings to regex patterns</p></td>
</tr>
</tbody>
</table>
<dl class="py class">
<dt class="sig sig-object py" id="psyplot.data.AbsoluteTimeDecoder">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">psyplot.data.</span></span><span class="sig-name descname"><span class="pre">AbsoluteTimeDecoder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">array</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/data.html#AbsoluteTimeDecoder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.data.AbsoluteTimeDecoder" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">NDArrayMixin</span></code></p>
<p><strong>Attributes:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.AbsoluteTimeDecoder.dtype" title="psyplot.data.AbsoluteTimeDecoder.dtype"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dtype</span></code></a></p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.data.AbsoluteTimeDecoder.dtype">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dtype</span></span><a class="headerlink" href="#psyplot.data.AbsoluteTimeDecoder.dtype" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="psyplot.data.AbsoluteTimeEncoder">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">psyplot.data.</span></span><span class="sig-name descname"><span class="pre">AbsoluteTimeEncoder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">array</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/data.html#AbsoluteTimeEncoder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.data.AbsoluteTimeEncoder" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">NDArrayMixin</span></code></p>
<p><strong>Attributes:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.AbsoluteTimeEncoder.dtype" title="psyplot.data.AbsoluteTimeEncoder.dtype"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dtype</span></code></a></p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.data.AbsoluteTimeEncoder.dtype">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dtype</span></span><a class="headerlink" href="#psyplot.data.AbsoluteTimeEncoder.dtype" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="psyplot.data.ArrayList">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">psyplot.data.</span></span><span class="sig-name descname"><span class="pre">ArrayList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iterable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/data.html#ArrayList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.data.ArrayList" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a></p>
<p>Base class for creating a list of interactive arrays from a dataset</p>
<p>This list contains and manages <a class="reference internal" href="#psyplot.data.InteractiveArray" title="psyplot.data.InteractiveArray"><code class="xref py py-class docutils literal notranslate"><span class="pre">InteractiveArray</span></code></a> instances</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>iterable</strong> (<em>iterable</em>) – The iterable (e.g. another list) defining this list</p></li>
<li><p><strong>attrs</strong> (<em>dict-like</em><em> or </em><em>iterable</em><em>, </em><em>optional</em>) – Global attributes of this list</p></li>
<li><p><strong>auto_update</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Default: None. A boolean indicating whether this list shall
automatically update the contained arrays when calling the
<a class="reference internal" href="#psyplot.data.ArrayList.update" title="psyplot.data.ArrayList.update"><code class="xref py py-meth docutils literal notranslate"><span class="pre">update()</span></code></a> method or not. See also the <a class="reference internal" href="#psyplot.data.ArrayList.no_auto_update" title="psyplot.data.ArrayList.no_auto_update"><code class="xref py py-attr docutils literal notranslate"><span class="pre">no_auto_update</span></code></a>
attribute. If None, the value from the <code class="docutils literal notranslate"><span class="pre">'lists.auto_update'</span></code>
key in the <code class="xref py py-attr docutils literal notranslate"><span class="pre">psyplot.rcParams</span></code> dictionary is used.</p></li>
<li><p><strong>new_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – If False, and the <code class="docutils literal notranslate"><span class="pre">arr_name</span></code> attribute of the new array is
already in the list, a ValueError is raised.
If True and the <code class="docutils literal notranslate"><span class="pre">arr_name</span></code> attribute of the new array is not
already in the list, the name is not changed. Otherwise, if the
array name is already in use, <cite>new_name</cite> is set to ‘arr{0}’.
If not True, this will be used for renaming (if the array name of
<cite>arr</cite> is in use or not). <code class="docutils literal notranslate"><span class="pre">'{0}'</span></code> is replaced by a counter</p></li>
</ul>
</dd>
</dl>
<p><strong>Attributes:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.all_dims" title="psyplot.data.ArrayList.all_dims"><code class="xref py py-obj docutils literal notranslate"><span class="pre">all_dims</span></code></a></p></td>
<td><p>The dimensions for each of the arrays in this list</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.all_names" title="psyplot.data.ArrayList.all_names"><code class="xref py py-obj docutils literal notranslate"><span class="pre">all_names</span></code></a></p></td>
<td><p>The variable names for each of the arrays in this list</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.arr_names" title="psyplot.data.ArrayList.arr_names"><code class="xref py py-obj docutils literal notranslate"><span class="pre">arr_names</span></code></a></p></td>
<td><p>Names of the arrays (!not of the variables!) in this list</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.arrays" title="psyplot.data.ArrayList.arrays"><code class="xref py py-obj docutils literal notranslate"><span class="pre">arrays</span></code></a></p></td>
<td><p>A list of all the <a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.6.1.dev0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">xarray.DataArray</span></code></a> instances in this list</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.coords" title="psyplot.data.ArrayList.coords"><code class="xref py py-obj docutils literal notranslate"><span class="pre">coords</span></code></a></p></td>
<td><p>Names of the coordinates of the arrays in this list</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.coords_intersect" title="psyplot.data.ArrayList.coords_intersect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">coords_intersect</span></code></a></p></td>
<td><p>Coordinates of the arrays in this list that are used in all arrays</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.dims" title="psyplot.data.ArrayList.dims"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dims</span></code></a></p></td>
<td><p>Dimensions of the arrays in this list</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.dims_intersect" title="psyplot.data.ArrayList.dims_intersect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dims_intersect</span></code></a></p></td>
<td><p>Dimensions of the arrays in this list that are used in all arrays</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.is_unstructured" title="psyplot.data.ArrayList.is_unstructured"><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_unstructured</span></code></a></p></td>
<td><p>A boolean for each array whether it is unstructured or not</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.logger" title="psyplot.data.ArrayList.logger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logger</span></code></a></p></td>
<td><p><a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">logging.Logger</span></code></a> of this instance</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.names" title="psyplot.data.ArrayList.names"><code class="xref py py-obj docutils literal notranslate"><span class="pre">names</span></code></a></p></td>
<td><p>Set of the variable in this list</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.no_auto_update" title="psyplot.data.ArrayList.no_auto_update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">no_auto_update</span></code></a></p></td>
<td><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.with_plotter" title="psyplot.data.ArrayList.with_plotter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">with_plotter</span></code></a></p></td>
<td><p>The arrays in this instance that are visualized with a plotter</p></td>
</tr>
</tbody>
</table>
<p><strong>Methods:</strong></p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.append" title="psyplot.data.ArrayList.append"><code class="xref py py-obj docutils literal notranslate"><span class="pre">append</span></code></a>(value[, new_name])</p></td>
<td><p>Append a new array to the list</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.array_info" title="psyplot.data.ArrayList.array_info"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array_info</span></code></a>([dump, paths, attrs, ...])</p></td>
<td><p>Get dimension informations on you arrays</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.copy" title="psyplot.data.ArrayList.copy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">copy</span></code></a>([deep])</p></td>
<td><p>Returns a copy of the list</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.draw" title="psyplot.data.ArrayList.draw"><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw</span></code></a>()</p></td>
<td><p>Draws all the figures in this instance</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.extend" title="psyplot.data.ArrayList.extend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">extend</span></code></a>(iterable[, new_name])</p></td>
<td><p>Add further arrays from an iterable to this list</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.from_dataset" title="psyplot.data.ArrayList.from_dataset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_dataset</span></code></a>(base[, method, default_slice, ...])</p></td>
<td><p>Construct an ArrayList instance from an existing base dataset</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.from_dict" title="psyplot.data.ArrayList.from_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_dict</span></code></a>(d[, alternative_paths, datasets, ...])</p></td>
<td><p>Create a list from the dictionary returned by <a class="reference internal" href="#psyplot.data.ArrayList.array_info" title="psyplot.data.ArrayList.array_info"><code class="xref py py-meth docutils literal notranslate"><span class="pre">array_info()</span></code></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.next_available_name" title="psyplot.data.ArrayList.next_available_name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">next_available_name</span></code></a>([fmt_str, counter])</p></td>
<td><p>Create a new array out of the given format string</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.remove" title="psyplot.data.ArrayList.remove"><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove</span></code></a>(arr)</p></td>
<td><p>Removes an array from the list</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.rename" title="psyplot.data.ArrayList.rename"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rename</span></code></a>(arr[, new_name])</p></td>
<td><p>Rename an array to find a name that isn't already in the list</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.start_update" title="psyplot.data.ArrayList.start_update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">start_update</span></code></a>([draw])</p></td>
<td><p>Conduct the registered plot updates</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.data.ArrayList.update" title="psyplot.data.ArrayList.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>([method, dims, fmt, replot, ...])</p></td>
<td><p>Update the coordinates and the plot</p></td>
</tr>
</tbody>
</table>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.data.ArrayList.all_dims">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">all_dims</span></span><a class="headerlink" href="#psyplot.data.ArrayList.all_dims" title="Link to this definition"></a></dt>
<dd><p>The dimensions for each of the arrays in this list</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.data.ArrayList.all_names">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">all_names</span></span><a class="headerlink" href="#psyplot.data.ArrayList.all_names" title="Link to this definition"></a></dt>
<dd><p>The variable names for each of the arrays in this list</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.data.ArrayList.append">
<span class="sig-name descname"><span class="pre">append</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/data.html#ArrayList.append"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.data.ArrayList.append" title="Link to this definition"></a></dt>
<dd><p>Append a new array to the list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>value</strong> (<a class="reference internal" href="#psyplot.data.InteractiveBase" title="psyplot.data.InteractiveBase"><em>InteractiveBase</em></a>) – The data object to append to this list</p></li>
<li><p><strong>new_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – If False, and the <code class="docutils literal notranslate"><span class="pre">arr_name</span></code> attribute of the new array is
already in the list, a ValueError is raised.
If True and the <code class="docutils literal notranslate"><span class="pre">arr_name</span></code> attribute of the new array is not
already in the list, the name is not changed. Otherwise, if the
array name is already in use, <cite>new_name</cite> is set to ‘arr{0}’.
If not True, this will be used for renaming (if the array name of
<cite>arr</cite> is in use or not). <code class="docutils literal notranslate"><span class="pre">'{0}'</span></code> is replaced by a counter</p></li>
</ul>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.12)"><strong>ValueError</strong></a> – If it was impossible to find a name that isn’t already in the list</p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.12)"><strong>ValueError</strong></a> – If <cite>new_name</cite> is False and the array is already in the list</p></li>
</ul>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><code class="xref py py-obj docutils literal notranslate"><span class="pre">list.append</span></code>, <a class="reference internal" href="#psyplot.data.ArrayList.extend" title="psyplot.data.ArrayList.extend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">extend</span></code></a>, <a class="reference internal" href="#psyplot.data.ArrayList.rename" title="psyplot.data.ArrayList.rename"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rename</span></code></a></p>
</div>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.data.ArrayList.arr_names">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">arr_names</span></span><a class="headerlink" href="#psyplot.data.ArrayList.arr_names" title="Link to this definition"></a></dt>
<dd><p>Names of the arrays (!not of the variables!) in this list</p>
<p>This attribute can be set with an iterable of unique names to change
the array names of the data objects in this list.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.data.ArrayList.array_info">
<span class="sig-name descname"><span class="pre">array_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dump</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">paths</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">standardize_dims</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pwd</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_rel_paths</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alternative_paths</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ds_description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{'fname',</span> <span class="pre">'store'}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">full_ds</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/data.html#ArrayList.array_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.data.ArrayList.array_info" title="Link to this definition"></a></dt>
<dd><p>Get dimension informations on you arrays</p>
<p>This method returns a dictionary containing informations on the
array in this instance</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dump</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – If True and the dataset has not been dumped so far, it is dumped to
a temporary file or the one generated by <cite>paths</cite> is used. If it is
False or both, <cite>dump</cite> and <cite>paths</cite> are None, no data will be stored.
If it is None and <cite>paths</cite> is not None, <cite>dump</cite> is set to True.</p></li>
<li><p><strong>paths</strong> (<em>iterable</em><em> or </em><em>True</em>) – An iterator over filenames to use if a dataset has no filename.
If paths is <code class="docutils literal notranslate"><span class="pre">True</span></code>, an iterator over temporary files will be
created without raising a warning</p></li>
<li><p><strong>attrs</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>, </em><em>optional</em>) – If True (default), the <code class="xref py py-attr docutils literal notranslate"><span class="pre">ArrayList.attrs</span></code> and
<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.attrs.html#xarray.DataArray.attrs" title="(in xarray v2024.6.1.dev0)"><code class="xref py py-attr docutils literal notranslate"><span class="pre">xarray.DataArray.attrs</span></code></a> attributes are included in the
returning dictionary</p></li>
<li><p><strong>standardize_dims</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>, </em><em>optional</em>) – If True (default), the real dimension names in the dataset are
replaced by x, y, z and t to be more general.</p></li>
<li><p><strong>pwd</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Path to the working directory from where the data can be imported.
If None, use the current working directory.</p></li>
<li><p><strong>use_rel_paths</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>, </em><em>optional</em>) – If True (default), paths relative to the current working directory
are used. Otherwise absolute paths to <cite>pwd</cite> are used</p></li>
<li><p><strong>ds_description</strong> (<em>'all'</em><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><em>set</em></a><em> of </em><em>{'fname'</em><em>, </em><em>'ds'</em><em>, </em><em>'num'</em><em>, </em><em>'arr'</em><em>, </em><em>'store'}</em>) – <p>Keys to describe the datasets of the arrays. If all, all keys
are used. The key descriptions are</p>
<dl class="simple">
<dt>fname</dt><dd><p>the file name is inserted in the <code class="docutils literal notranslate"><span class="pre">'fname'</span></code> key</p>
</dd>
<dt>store</dt><dd><p>the data store class and module is inserted in the <code class="docutils literal notranslate"><span class="pre">'store'</span></code>
key</p>
</dd>
<dt>ds</dt><dd><p>the dataset is inserted in the <code class="docutils literal notranslate"><span class="pre">'ds'</span></code> key</p>
</dd>
<dt>num</dt><dd><p>The unique number assigned to the dataset is inserted in the
<code class="docutils literal notranslate"><span class="pre">'num'</span></code> key</p>
</dd>
<dt>arr</dt><dd><p>The array itself is inserted in the <code class="docutils literal notranslate"><span class="pre">'arr'</span></code> key</p>
</dd>
</dl>
</p></li>
<li><p><strong>full_ds</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – If True and <code class="docutils literal notranslate"><span class="pre">'ds'</span></code> is in <cite>ds_description</cite>, the entire dataset is
included. Otherwise, only the DataArray converted to a dataset is
included</p></li>
<li><p><strong>copy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – If True, the arrays and datasets are deep copied</p></li>
<li><p><strong>**kwargs</strong> – Any other keyword for the <a class="reference internal" href="#psyplot.data.to_netcdf" title="psyplot.data.to_netcdf"><code class="xref py py-func docutils literal notranslate"><span class="pre">to_netcdf()</span></code></a> function</p></li>
<li><p><strong>path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>path-like</em><em> or </em><em>file-like</em><em>, </em><em>optional</em>) – Path to which to save this dataset. File-like objects are only
supported by the scipy engine. If no path is provided, this
function returns the resulting netCDF file as bytes; in this case,
we need to use scipy, which does not support netCDF version 4 (the
default format becomes NETCDF3_64BIT).</p></li>
<li><p><strong>mode</strong> (<em>{"w"</em><em>, </em><em>"a"}</em><em>, </em><em>default: "w"</em>) – Write (‘w’) or append (‘a’) mode. If mode=’w’, any existing file at
this location will be overwritten. If mode=’a’, existing variables
will be overwritten.</p></li>
<li><p><strong>format</strong> (<em>{"NETCDF4"</em><em>, </em><em>"NETCDF4_CLASSIC"</em><em>, </em><em>"NETCDF3_64BIT"</em><em>, </em><em>"NETCDF3_CLASSIC"}</em><em>, </em><em>optional</em>) – <p>File format for the resulting netCDF file:</p>
<ul>
<li><p>NETCDF4: Data is stored in an HDF5 file, using netCDF4 API
features.</p></li>
<li><p>NETCDF4_CLASSIC: Data is stored in an HDF5 file, using only
netCDF 3 compatible API features.</p></li>
<li><p>NETCDF3_64BIT: 64-bit offset version of the netCDF 3 file format,
which fully supports 2+ GB files, but is only compatible with
clients linked against netCDF version 3.6.0 or later.</p></li>
<li><p>NETCDF3_CLASSIC: The classic netCDF 3 file format. It does not
handle 2+ GB files very well.</p></li>
</ul>
<p>All formats are supported by the netCDF4-python library.
scipy.io.netcdf only supports the last two formats.</p>
<p>The default format is NETCDF4 if you are saving a file to disk and
have the netCDF4-python library available. Otherwise, xarray falls
back to using scipy to write netCDF files and defaults to the
NETCDF3_64BIT format (scipy does not support netCDF4).</p>
</p></li>
<li><p><strong>group</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>optional</em>) – Path to the netCDF4 group in the given file to open (only works for
format=’NETCDF4’). The group(s) will be created if necessary.</p></li>
<li><p><strong>engine</strong> (<em>{"netcdf4"</em><em>, </em><em>"scipy"</em><em>, </em><em>"h5netcdf"}</em><em>, </em><em>optional</em>) – Engine to use when writing netCDF files. If not provided, the
default engine is chosen based on available dependencies, with a
preference for ‘netcdf4’ if writing to a file on disk.</p></li>
<li><p><strong>encoding</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a><em>, </em><em>optional</em>) – <p>Nested dictionary with variable names as keys and dictionaries of
variable specific encodings as values, e.g.,
<code class="docutils literal notranslate"><span class="pre">{"my_variable":</span> <span class="pre">{"dtype":</span> <span class="pre">"int16",</span> <span class="pre">"scale_factor":</span> <span class="pre">0.1,</span>
<span class="pre">"zlib":</span> <span class="pre">True},</span> <span class="pre">...}</span></code>.
If <code class="docutils literal notranslate"><span class="pre">encoding</span></code> is specified the original encoding of the variables of
the dataset is ignored.</p>
<p>The <cite>h5netcdf</cite> engine supports both the NetCDF4-style compression
encoding parameters <code class="docutils literal notranslate"><span class="pre">{"zlib":</span> <span class="pre">True,</span> <span class="pre">"complevel":</span> <span class="pre">9}</span></code> and the h5py
ones <code class="docutils literal notranslate"><span class="pre">{"compression":</span> <span class="pre">"gzip",</span> <span class="pre">"compression_opts":</span> <span class="pre">9}</span></code>.
This allows using any compression plugin installed in the HDF5
library, e.g. LZF.</p>
</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>An ordered mapping from array names to dimensions and filename
corresponding to the array</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#psyplot.data.ArrayList.from_dict" title="psyplot.data.ArrayList.from_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_dict</span></code></a></p>
</div>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.data.ArrayList.arrays">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">arrays</span></span><a class="headerlink" href="#psyplot.data.ArrayList.arrays" title="Link to this definition"></a></dt>
<dd><p>A list of all the <a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html#xarray.DataArray" title="(in xarray v2024.6.1.dev0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">xarray.DataArray</span></code></a> instances in this list</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.data.ArrayList.coords">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">coords</span></span><a class="headerlink" href="#psyplot.data.ArrayList.coords" title="Link to this definition"></a></dt>
<dd><p>Names of the coordinates of the arrays in this list</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.data.ArrayList.coords_intersect">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">coords_intersect</span></span><a class="headerlink" href="#psyplot.data.ArrayList.coords_intersect" title="Link to this definition"></a></dt>
<dd><p>Coordinates of the arrays in this list that are used in all arrays</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.data.ArrayList.copy">
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/data.html#ArrayList.copy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.data.ArrayList.copy" title="Link to this definition"></a></dt>
<dd><p>Returns a copy of the list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>deep</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – If False (default), only the list is copied and not the contained
arrays, otherwise the contained arrays are deep copied</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.data.ArrayList.dims">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dims</span></span><a class="headerlink" href="#psyplot.data.ArrayList.dims" title="Link to this definition"></a></dt>
<dd><p>Dimensions of the arrays in this list</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.data.ArrayList.dims_intersect">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dims_intersect</span></span><a class="headerlink" href="#psyplot.data.ArrayList.dims_intersect" title="Link to this definition"></a></dt>
<dd><p>Dimensions of the arrays in this list that are used in all arrays</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.data.ArrayList.draw">
<span class="sig-name descname"><span class="pre">draw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/data.html#ArrayList.draw"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.data.ArrayList.draw" title="Link to this definition"></a></dt>
<dd><p>Draws all the figures in this instance</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.data.ArrayList.extend">
<span class="sig-name descname"><span class="pre">extend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">iterable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/data.html#ArrayList.extend"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.data.ArrayList.extend" title="Link to this definition"></a></dt>
<dd><p>Add further arrays from an iterable to this list</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>iterable</strong> – Any iterable that contains <a class="reference internal" href="#psyplot.data.InteractiveBase" title="psyplot.data.InteractiveBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">InteractiveBase</span></code></a> instances</p></li>
<li><p><strong>new_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – If False, and the <code class="docutils literal notranslate"><span class="pre">arr_name</span></code> attribute of the new array is
already in the list, a ValueError is raised.
If True and the <code class="docutils literal notranslate"><span class="pre">arr_name</span></code> attribute of the new array is not
already in the list, the name is not changed. Otherwise, if the
array name is already in use, <cite>new_name</cite> is set to ‘arr{0}’.
If not True, this will be used for renaming (if the array name of
<cite>arr</cite> is in use or not). <code class="docutils literal notranslate"><span class="pre">'{0}'</span></code> is replaced by a counter</p></li>
</ul>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.12)"><strong>ValueError</strong></a> – If it was impossible to find a name that isn’t already in the list</p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.12)"><strong>ValueError</strong></a> – If <cite>new_name</cite> is False and the array is already in the list</p></li>
</ul>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><code class="xref py py-obj docutils literal notranslate"><span class="pre">list.extend</span></code>, <a class="reference internal" href="#psyplot.data.ArrayList.append" title="psyplot.data.ArrayList.append"><code class="xref py py-obj docutils literal notranslate"><span class="pre">append</span></code></a>, <a class="reference internal" href="#psyplot.data.ArrayList.rename" title="psyplot.data.ArrayList.rename"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rename</span></code></a></p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.data.ArrayList.from_dataset">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dataset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'isel'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_slice</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decoder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_update</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefer_list</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">squeeze</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attrs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">load</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/data.html#ArrayList.from_dataset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.data.ArrayList.from_dataset" title="Link to this definition"></a></dt>
<dd><p>Construct an ArrayList instance from an existing base dataset</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>base</strong> (<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.6.1.dev0)"><em>xarray.Dataset</em></a>) – Dataset instance that is used as reference</p></li>
<li><p><strong>method</strong> (<em>{'isel'</em><em>, </em><em>None</em><em>, </em><em>'nearest'</em><em>, </em><em>...</em><em>}</em>) – Selection method of the xarray.Dataset to be used for setting the
variables from the informations in <cite>dims</cite>.
If <cite>method</cite> is ‘isel’, the <a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.isel.html#xarray.Dataset.isel" title="(in xarray v2024.6.1.dev0)"><code class="xref py py-meth docutils literal notranslate"><span class="pre">xarray.Dataset.isel()</span></code></a> method is
used. Otherwise it sets the <cite>method</cite> parameter for the
<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.sel.html#xarray.Dataset.sel" title="(in xarray v2024.6.1.dev0)"><code class="xref py py-meth docutils literal notranslate"><span class="pre">xarray.Dataset.sel()</span></code></a> method.</p></li>
<li><p><strong>auto_update</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Default: None. A boolean indicating whether this list shall
automatically update the contained arrays when calling the
<a class="reference internal" href="#psyplot.data.ArrayList.update" title="psyplot.data.ArrayList.update"><code class="xref py py-meth docutils literal notranslate"><span class="pre">update()</span></code></a> method or not. See also the <a class="reference internal" href="#psyplot.data.ArrayList.no_auto_update" title="psyplot.data.ArrayList.no_auto_update"><code class="xref py py-attr docutils literal notranslate"><span class="pre">no_auto_update</span></code></a>
attribute. If None, the value from the <code class="docutils literal notranslate"><span class="pre">'lists.auto_update'</span></code>
key in the <code class="xref py py-attr docutils literal notranslate"><span class="pre">psyplot.rcParams</span></code> dictionary is used.</p></li>
<li><p><strong>prefer_list</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – If True and multiple variable names pher array are found, the
<a class="reference internal" href="#psyplot.data.InteractiveList" title="psyplot.data.InteractiveList"><code class="xref py py-class docutils literal notranslate"><span class="pre">InteractiveList</span></code></a> class is used. Otherwise the arrays are
put together into one <a class="reference internal" href="#psyplot.data.InteractiveArray" title="psyplot.data.InteractiveArray"><code class="xref py py-class docutils literal notranslate"><span class="pre">InteractiveArray</span></code></a>.</p></li>
<li><p><strong>default_slice</strong> (<em>indexer</em>) – Index (e.g. 0 if <cite>method</cite> is ‘isel’) that shall be used for
dimensions not covered by <cite>dims</cite> and <cite>furtherdims</cite>. If None, the
whole slice will be used. Note that the <cite>default_slice</cite> is always
based on the <cite>isel</cite> method.</p></li>
<li><p><strong>decoder</strong> (<a class="reference internal" href="#psyplot.data.CFDecoder" title="psyplot.data.CFDecoder"><em>CFDecoder</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a>) – <p>Arguments for the decoder. This can be one of</p>
<ul>
<li><p>an instance of <a class="reference internal" href="#psyplot.data.CFDecoder" title="psyplot.data.CFDecoder"><code class="xref py py-class docutils literal notranslate"><span class="pre">CFDecoder</span></code></a></p></li>
<li><p>a subclass of <a class="reference internal" href="#psyplot.data.CFDecoder" title="psyplot.data.CFDecoder"><code class="xref py py-class docutils literal notranslate"><span class="pre">CFDecoder</span></code></a></p></li>
<li><p>a dictionary with keyword-arguments to the automatically
determined decoder class</p></li>
<li><p>None to automatically set the decoder</p></li>
</ul>
</p></li>
<li><p><strong>squeeze</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>, </em><em>optional</em>) – Default True. If True, and the created arrays have a an axes with
length 1, it is removed from the dimension list (e.g. an array
with shape (3, 4, 1, 5) will be squeezed to shape (3, 4, 5))</p></li>
<li><p><strong>attrs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a><em>, </em><em>optional</em>) – Meta attributes that shall be assigned to the selected data arrays
(additional to those stored in the <cite>base</cite> dataset)</p></li>
<li><p><strong>load</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a>) – If True, load the data from the dataset using the
<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.DataArray.load.html#xarray.DataArray.load" title="(in xarray v2024.6.1.dev0)"><code class="xref py py-meth docutils literal notranslate"><span class="pre">xarray.DataArray.load()</span></code></a> method. If <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>, those will
be given to the above mentioned <code class="docutils literal notranslate"><span class="pre">load</span></code> method</p></li>
<li><p><strong>arr_names</strong> (<em>string</em><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em> of </em><em>strings</em><em> or </em><em>dictionary</em>) – <p>Set the unique array names of the resulting arrays and (optionally)
dimensions.</p>
<ul>
<li><p>if string: same as list of strings (see below). Strings may
include {0} which will be replaced by a counter.</p></li>
<li><p>list of strings: those will be used for the array names. The final
number of dictionaries in the return depend in this case on the
<cite>dims</cite> and <code class="docutils literal notranslate"><span class="pre">**furtherdims</span></code></p></li>
<li><p>dictionary:
Then nothing happens and an <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> version of
<cite>arr_names</cite> is returned.</p></li>
</ul>
</p></li>
<li><p><strong>sort</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em> of </em><em>strings</em>) – This parameter defines how the dictionaries are ordered. It has no
effect if <cite>arr_names</cite> is a dictionary (use a
<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> for that). It can be a list of
dimension strings matching to the dimensions in <cite>dims</cite> for the
variable.</p></li>
<li><p><strong>dims</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a>) – Keys must be variable names of dimensions (e.g. time, level, lat or
lon) or ‘name’ for the variable name you want to choose.
Values must be values of that dimension or iterables of the values
(e.g. lists). Note that strings will be put into a list.
For example dims = {‘name’: ‘t2m’, ‘time’: 0} will result in one plot
for the first time step, whereas dims = {‘name’: ‘t2m’, ‘time’: [0, 1]}
will result in two plots, one for the first (time == 0) and one for the
second (time == 1) time step.</p></li>
<li><p><strong>**kwargs</strong> – The same as <cite>dims</cite> (those will update what is specified in <cite>dims</cite>)</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The list with the specified <a class="reference internal" href="#psyplot.data.InteractiveArray" title="psyplot.data.InteractiveArray"><code class="xref py py-class docutils literal notranslate"><span class="pre">InteractiveArray</span></code></a> instances
that hold a reference to the given <cite>base</cite></p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#psyplot.data.ArrayList" title="psyplot.data.ArrayList">ArrayList</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.data.ArrayList.from_dict">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">d</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alternative_paths</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datasets</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pwd</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_keys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">['attrs',</span> <span class="pre">'plotter',</span> <span class="pre">'ds']</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/data.html#ArrayList.from_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.data.ArrayList.from_dict" title="Link to this definition"></a></dt>
<dd><p>Create a list from the dictionary returned by <a class="reference internal" href="#psyplot.data.ArrayList.array_info" title="psyplot.data.ArrayList.array_info"><code class="xref py py-meth docutils literal notranslate"><span class="pre">array_info()</span></code></a></p>
<p>This classmethod creates an <a class="reference internal" href="#psyplot.data.ArrayList" title="psyplot.data.ArrayList"><code class="xref py py-class docutils literal notranslate"><span class="pre">ArrayList</span></code></a> instance
from a dictionary containing filename, dimension infos and array names</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>d</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a>) – The dictionary holding the data</p></li>
<li><p><strong>alternative_paths</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – A mapping from original filenames as used in <cite>d</cite> to filenames that
shall be used instead. If <cite>alternative_paths</cite> is not None,
datasets must be None. Paths must be accessible from the current
working directory.
If <cite>alternative_paths</cite> is a list (or any other iterable) is
provided, the file names will be replaced as they appear in <cite>d</cite>
(note that this is very unsafe if <cite>d</cite> is not and dict)</p></li>
<li><p><strong>datasets</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em> or </em><em>None</em>) – A mapping from original filenames in <cite>d</cite> to the instances of
<a class="reference external" href="https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html#xarray.Dataset" title="(in xarray v2024.6.1.dev0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">xarray.Dataset</span></code></a> to use. If it is an iterable, the same
holds as for the <cite>alternative_paths</cite> parameter</p></li>
<li><p><strong>pwd</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Path to the working directory from where the data can be imported.
If None, use the current working directory.</p></li>
<li><p><strong>ignore_keys</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em> of </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Keys specified in this list are ignored and not seen as array
information (note that <code class="docutils literal notranslate"><span class="pre">attrs</span></code> are used anyway)</p></li>
<li><p><strong>only</strong> (<em>string</em><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em> or </em><em>callable</em>) – <p>Can be one of the following three things:</p>
<ul>
<li><p>a string that represents a pattern to match the array names
that shall be included</p></li>
<li><p>a list of array names to include</p></li>
<li><p>a callable with two arguments, a string and a dict such as</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">filter_func</span><span class="p">(</span><span class="n">arr_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">info</span><span class="p">:</span> <span class="nb">dict</span><span class="p">):</span> <span class="o">-></span> <span class="nb">bool</span>
<span class="w"> </span><span class="sd">'''</span>
<span class="sd"> Filter the array names</span>
<span class="sd"> This function should return True if the array shall be</span>
<span class="sd"> included, else False</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> arr_name: str</span>
<span class="sd"> The array name (i.e. the ``arr_name`` attribute)</span>
<span class="sd"> info: dict</span>
<span class="sd"> The dictionary with the array informations. Common</span>
<span class="sd"> keys are ``'name'`` that points to the variable name</span>
<span class="sd"> and ``'dims'`` that points to the dimensions and</span>
<span class="sd"> ``'fname'`` that points to the file name</span>
<span class="sd"> '''</span>
<span class="k">return</span> <span class="kc">True</span> <span class="ow">or</span> <span class="kc">False</span>
</pre></div>
</div>
<p>The function should return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the array shall be
included, else <code class="docutils literal notranslate"><span class="pre">False</span></code>. This function will also be given to
subsequents instances of <a class="reference internal" href="#psyplot.data.InteractiveList" title="psyplot.data.InteractiveList"><code class="xref py py-class docutils literal notranslate"><span class="pre">InteractiveList</span></code></a> objects that
are contained in the returned value</p>
</li>
</ul>
</p></li>
<li><p><strong>chname</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a>) – A mapping from variable names in the project to variable names
that should be used instead</p></li>
<li><p><strong>**kwargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a>) – Any other parameter from the <cite>psyplot.data.open_dataset</cite> function</p></li>
<li><p><strong>filename_or_obj</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>Path</em><em>, </em><em>file-like</em><em> or </em><em>DataStore</em>) – Strings and Path objects are interpreted as a path to a netCDF file
or an OpenDAP URL and opened with python-netCDF4, unless the filename
ends with .gz, in which case the file is gunzipped and opened with
scipy.io.netcdf (only netCDF3 supported). Byte-strings or file-like
objects are opened by scipy.io.netcdf (netCDF3) or h5py (netCDF4/HDF).</p></li>
<li><p><strong>chunks</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a><em>, </em><em>'auto'</em><em> or </em><em>None</em><em>, </em><em>optional</em>) – If chunks is provided, it is used to load the new dataset into dask
arrays. <code class="docutils literal notranslate"><span class="pre">chunks=-1</span></code> loads the dataset with dask using a single
chunk for all arrays. <code class="docutils literal notranslate"><span class="pre">chunks={}</span></code> loads the dataset with dask using
engine preferred chunks if exposed by the backend, otherwise with
a single chunk for all arrays. In order to reproduce the default behavior
of <code class="docutils literal notranslate"><span class="pre">xr.open_zarr(...)</span></code> use <code class="docutils literal notranslate"><span class="pre">xr.open_dataset(...,</span> <span class="pre">engine='zarr',</span> <span class="pre">chunks={})</span></code>.
<code class="docutils literal notranslate"><span class="pre">chunks='auto'</span></code> will use dask <code class="docutils literal notranslate"><span class="pre">auto</span></code> chunking taking into account the
engine preferred chunks. See dask chunking for more details.</p></li>
<li><p><strong>cache</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>, </em><em>optional</em>) – If True, cache data loaded from the underlying datastore in memory as
NumPy arrays when accessed to avoid reading from the underlying data-
store multiple times. Defaults to True unless you specify the <cite>chunks</cite>
argument to use dask, in which case it defaults to False. Does not
change the behavior of coordinates corresponding to dimensions, which
always load their data from disk into a <code class="docutils literal notranslate"><span class="pre">pandas.Index</span></code>.</p></li>
<li><p><strong>decode_cf</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>, </em><em>optional</em>) – Whether to decode these variables, assuming they were saved according
to CF conventions.</p></li>
<li><p><strong>mask_and_scale</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>, </em><em>optional</em>) – If True, replace array values equal to <cite>_FillValue</cite> with NA and scale
values according to the formula <cite>original_values * scale_factor +
add_offset</cite>, where <cite>_FillValue</cite>, <cite>scale_factor</cite> and <cite>add_offset</cite> are
taken from variable attributes (if they exist). If the <cite>_FillValue</cite> or
<cite>missing_value</cite> attribute contains multiple values a warning will be
issued and all array values matching one of the multiple values will
be replaced by NA. This keyword may not be supported by all the backends.</p></li>
<li><p><strong>decode_times</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>, </em><em>optional</em>) – If True, decode times encoded in the standard NetCDF datetime format
into datetime objects. Otherwise, leave them encoded as numbers.
This keyword may not be supported by all the backends.</p></li>