-
Notifications
You must be signed in to change notification settings - Fork 15
Expand file tree
/
Copy pathpsyplot.config.rcsetup.html
More file actions
1302 lines (1226 loc) · 136 KB
/
Copy pathpsyplot.config.rcsetup.html
File metadata and controls
1302 lines (1226 loc) · 136 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="psyplot.sphinxext package" href="psyplot.sphinxext.html" />
<link rel="prev" title="<no title>" href="psyplot.config.logsetup.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 current"><a class="reference internal" href="psyplot.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l4 current"><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"><a class="reference internal" href="psyplot.html#submodules">Submodules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html"><code class="docutils literal notranslate"><span class="pre">AbsoluteTimeDecoder</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="psyplot.data.html#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.html#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.html#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.html#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.html#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.html#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.html#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.html#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.html#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.html#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.html#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.html#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.html#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.html#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.html#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.html#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.html#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.html#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.html#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.html#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.html#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"><a href="psyplot.config.html">psyplot.config package</a></li>
<li class="breadcrumb-item active"><no title></li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/psyplot.config.rcsetup.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.config.rcsetup">Default management of the psyplot package</p>
<p>This module defines the necessary classes, data and functions for the default
configuration of the module.
The structure is motivated and to larger parts taken from the <a class="reference external" href="http://matplotlib.org/api/">matplotlib</a>
package.</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.config.rcsetup.RcParams" title="psyplot.config.rcsetup.RcParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RcParams</span></code></a>(*args, **kwargs)</p></td>
<td><p>A dictionary object including validation</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.SubDict" title="psyplot.config.rcsetup.SubDict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SubDict</span></code></a>(base, base_str[, pattern, ...])</p></td>
<td><p>Class that keeps week reference to the base dictionary</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.config.rcsetup.defaultParams" title="psyplot.config.rcsetup.defaultParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">defaultParams</span></code></a></p></td>
<td><p><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> with default values and validation functions</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.rcParams" title="psyplot.config.rcsetup.rcParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rcParams</span></code></a></p></td>
<td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams" title="psyplot.config.rcsetup.RcParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">RcParams</span></code></a> instance that stores default formatoptions and configuration settings.</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.config.rcsetup.get_configdir" title="psyplot.config.rcsetup.get_configdir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_configdir</span></code></a>([name, env_key])</p></td>
<td><p>Return the string representing the configuration directory.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.psyplot_fname" title="psyplot.config.rcsetup.psyplot_fname"><code class="xref py py-obj docutils literal notranslate"><span class="pre">psyplot_fname</span></code></a>([env_key, fname, if_exists])</p></td>
<td><p>Get the location of the config file.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.safe_list" title="psyplot.config.rcsetup.safe_list"><code class="xref py py-obj docutils literal notranslate"><span class="pre">safe_list</span></code></a>(iterable)</p></td>
<td><p>Function to create a list</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.validate_bool" title="psyplot.config.rcsetup.validate_bool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">validate_bool</span></code></a>(b)</p></td>
<td><p>Convert b to a boolean or raise</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.validate_bool_maybe_none" title="psyplot.config.rcsetup.validate_bool_maybe_none"><code class="xref py py-obj docutils literal notranslate"><span class="pre">validate_bool_maybe_none</span></code></a>(b)</p></td>
<td><p>Convert b to a boolean or raise</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.validate_dict" title="psyplot.config.rcsetup.validate_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">validate_dict</span></code></a>(d)</p></td>
<td><p>Validate a dictionary</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.validate_files_exist" title="psyplot.config.rcsetup.validate_files_exist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">validate_files_exist</span></code></a>(files)</p></td>
<td><p>Validate if all pathnames in a given list exists</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.validate_path_exists" title="psyplot.config.rcsetup.validate_path_exists"><code class="xref py py-obj docutils literal notranslate"><span class="pre">validate_path_exists</span></code></a>(s)</p></td>
<td><p>If s is a path, return s, else False</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.validate_str" title="psyplot.config.rcsetup.validate_str"><code class="xref py py-obj docutils literal notranslate"><span class="pre">validate_str</span></code></a>(s)</p></td>
<td><p>Validate a string</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.validate_stringlist" title="psyplot.config.rcsetup.validate_stringlist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">validate_stringlist</span></code></a>(s)</p></td>
<td><p>Validate a list of strings</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.validate_stringset" title="psyplot.config.rcsetup.validate_stringset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">validate_stringset</span></code></a>(*args, **kwargs)</p></td>
<td><p>Validate a set of strings</p></td>
</tr>
</tbody>
</table>
<dl class="py class">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">psyplot.config.rcsetup.</span></span><span class="sig-name descname"><span class="pre">RcParams</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</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/config/rcsetup.html#RcParams"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.RcParams" title="Link to this definition"></a></dt>
<dd><p>Bases: <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></p>
<p>A dictionary object including validation</p>
<p>validating functions are defined and associated with rc parameters in
<a class="reference internal" href="#psyplot.config.rcsetup.defaultParams" title="psyplot.config.rcsetup.defaultParams"><code class="xref py py-data docutils literal notranslate"><span class="pre">defaultParams</span></code></a></p>
<p>This class is essentially the same as in maplotlibs
<a class="reference external" href="https://matplotlib.org/stable/api/matplotlib_configuration_api.html#matplotlib.RcParams" title="(in Matplotlib v3.9.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">RcParams</span></code></a> but has the additional
<a class="reference internal" href="#psyplot.config.rcsetup.RcParams.find_and_replace" title="psyplot.config.rcsetup.RcParams.find_and_replace"><code class="xref py py-meth docutils literal notranslate"><span class="pre">find_and_replace()</span></code></a> method.</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>defaultParams</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 defaultParams to use (see the <a class="reference internal" href="#psyplot.config.rcsetup.defaultParams" title="psyplot.config.rcsetup.defaultParams"><code class="xref py py-attr docutils literal notranslate"><span class="pre">defaultParams</span></code></a> attribute).
By default, the <a class="reference internal" href="#psyplot.config.rcsetup.defaultParams" title="psyplot.config.rcsetup.defaultParams"><code class="xref py py-attr docutils literal notranslate"><span class="pre">psyplot.config.rcsetup.defaultParams</span></code></a>
dictionary is used</p></li>
<li><p><strong>*args</strong> – Any key-value pair for the initialization of the dictionary</p></li>
<li><p><strong>**kwargs</strong> – Any key-value pair for the initialization of the dictionary</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.config.rcsetup.RcParams.HEADER" title="psyplot.config.rcsetup.RcParams.HEADER"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HEADER</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.defaultParams" title="psyplot.config.rcsetup.RcParams.defaultParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">defaultParams</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.descriptions" title="psyplot.config.rcsetup.RcParams.descriptions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">descriptions</span></code></a></p></td>
<td><p>The description of each keyword in the rcParams dictionary</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.msg_depr" title="psyplot.config.rcsetup.RcParams.msg_depr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">msg_depr</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.msg_depr_ignore" title="psyplot.config.rcsetup.RcParams.msg_depr_ignore"><code class="xref py py-obj docutils literal notranslate"><span class="pre">msg_depr_ignore</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.validate" title="psyplot.config.rcsetup.RcParams.validate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">validate</span></code></a></p></td>
<td><p>Dictionary with validation methods as values</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.config.rcsetup.RcParams.catch" title="psyplot.config.rcsetup.RcParams.catch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">catch</span></code></a>()</p></td>
<td><p>Context manager to reset the rcParams afterwards</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.connect" title="psyplot.config.rcsetup.RcParams.connect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">connect</span></code></a>(key, func)</p></td>
<td><p>Connect a function to the given formatoption</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.copy" title="psyplot.config.rcsetup.RcParams.copy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">copy</span></code></a>()</p></td>
<td><p>Make sure, the right class is retained</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.disconnect" title="psyplot.config.rcsetup.RcParams.disconnect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">disconnect</span></code></a>([key, func])</p></td>
<td><p>Disconnect the connections to the an rcParams key</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.dump" title="psyplot.config.rcsetup.RcParams.dump"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dump</span></code></a>([fname, overwrite, include_keys, ...])</p></td>
<td><p>Dump this instance to a yaml file</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.find_all" title="psyplot.config.rcsetup.RcParams.find_all"><code class="xref py py-obj docutils literal notranslate"><span class="pre">find_all</span></code></a>(pattern)</p></td>
<td><p>Return the subset of this RcParams dictionary whose keys match, using <a class="reference external" href="https://docs.python.org/3/library/re.html#re.search" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">re.search()</span></code></a>, the given <code class="docutils literal notranslate"><span class="pre">pattern</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.find_and_replace" title="psyplot.config.rcsetup.RcParams.find_and_replace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">find_and_replace</span></code></a>(*args, **kwargs)</p></td>
<td><p>Like <a class="reference internal" href="#psyplot.config.rcsetup.RcParams.find_all" title="psyplot.config.rcsetup.RcParams.find_all"><code class="xref py py-meth docutils literal notranslate"><span class="pre">find_all()</span></code></a> but the given strings are replaced</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.keys" title="psyplot.config.rcsetup.RcParams.keys"><code class="xref py py-obj docutils literal notranslate"><span class="pre">keys</span></code></a>()</p></td>
<td><p>Return sorted list of keys.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.load_from_file" title="psyplot.config.rcsetup.RcParams.load_from_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">load_from_file</span></code></a>([fname])</p></td>
<td><p>Update rcParams from user-defined settings</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.load_plugins" title="psyplot.config.rcsetup.RcParams.load_plugins"><code class="xref py py-obj docutils literal notranslate"><span class="pre">load_plugins</span></code></a>([raise_error])</p></td>
<td><p>Load the plotters and defaultParams from the plugins</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.remove" title="psyplot.config.rcsetup.RcParams.remove"><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove</span></code></a>(key, func)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.update" title="psyplot.config.rcsetup.RcParams.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>([E, ]**F)</p></td>
<td><p>If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.update_from_defaultParams" title="psyplot.config.rcsetup.RcParams.update_from_defaultParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update_from_defaultParams</span></code></a>([defaultParams, ...])</p></td>
<td><p>Update from the a dictionary like the <a class="reference internal" href="#psyplot.config.rcsetup.defaultParams" title="psyplot.config.rcsetup.defaultParams"><code class="xref py py-attr docutils literal notranslate"><span class="pre">defaultParams</span></code></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.values" title="psyplot.config.rcsetup.RcParams.values"><code class="xref py py-obj docutils literal notranslate"><span class="pre">values</span></code></a>()</p></td>
<td><p>Return values in order of sorted keys.</p></td>
</tr>
</tbody>
</table>
<dl class="py attribute">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.HEADER">
<span class="sig-name descname"><span class="pre">HEADER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Configuration</span> <span class="pre">parameters</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">psyplot</span> <span class="pre">module\n\nYou</span> <span class="pre">can</span> <span class="pre">copy</span> <span class="pre">this</span> <span class="pre">file</span> <span class="pre">(or</span> <span class="pre">parts</span> <span class="pre">of</span> <span class="pre">it)</span> <span class="pre">to</span> <span class="pre">another</span> <span class="pre">path</span> <span class="pre">and</span> <span class="pre">save</span> <span class="pre">it</span> <span class="pre">as\npsyplotrc.yml.</span> <span class="pre">The</span> <span class="pre">directory</span> <span class="pre">should</span> <span class="pre">then</span> <span class="pre">be</span> <span class="pre">stored</span> <span class="pre">in</span> <span class="pre">the</span> <span class="pre">PSYPLOTCONFIGDIR\nenvironment</span> <span class="pre">variable.'</span></em><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.HEADER" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.catch">
<span class="sig-name descname"><span class="pre">catch</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/config/rcsetup.html#RcParams.catch"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.catch" title="Link to this definition"></a></dt>
<dd><p>Context manager to reset the rcParams afterwards</p>
<p>Usage:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'some_key'</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">with</span> <span class="n">rcParams</span><span class="o">.</span><span class="n">catch</span><span class="p">():</span>
<span class="n">rcParams</span><span class="p">[</span><span class="s1">'some_key'</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">assert</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'some_key'</span><span class="p">]</span> <span class="o">==</span> <span class="mi">1</span>
<span class="k">assert</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'some_key'</span><span class="p">]</span> <span class="o">==</span> <span class="mi">0</span>
</pre></div>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.connect">
<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/config/rcsetup.html#RcParams.connect"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.connect" title="Link to this definition"></a></dt>
<dd><p>Connect a function to the given formatoption</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>key</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The rcParams key</p></li>
<li><p><strong>func</strong> (<em>function</em>) – The function that shall be called when the rcParams key changes.
It must accept a single value that is the new value of the
key.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.copy">
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/config/rcsetup.html#RcParams.copy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.copy" title="Link to this definition"></a></dt>
<dd><p>Make sure, the right class is retained</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.defaultParams">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">defaultParams</span></span><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.defaultParams" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.descriptions">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">descriptions</span></span><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.descriptions" title="Link to this definition"></a></dt>
<dd><p>The description of each keyword in the rcParams dictionary</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.disconnect">
<span class="sig-name descname"><span class="pre">disconnect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</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">func</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/config/rcsetup.html#RcParams.disconnect"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.disconnect" title="Link to this definition"></a></dt>
<dd><p>Disconnect the connections to the an rcParams key</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>key</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The rcParams key. If None, all keys are used</p></li>
<li><p><strong>func</strong> (<em>function</em>) – The function that is connected. If None, all functions are
connected</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.dump">
<span class="sig-name descname"><span class="pre">dump</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fname</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">overwrite</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">include_keys</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">exclude_keys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">['project.plotters']</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_descriptions</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="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/config/rcsetup.html#RcParams.dump"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.dump" title="Link to this definition"></a></dt>
<dd><p>Dump this instance to a yaml file</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>fname</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> or </em><em>None</em>) – file name to write to. If None, the string that would be written
to a file is returned</p></li>
<li><p><strong>overwrite</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 <cite>fname</cite> already exists, it will be overwritten</p></li>
<li><p><strong>include_keys</strong> (<em>None</em><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> 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 in the dictionary to be included. If None, all keys are
included</p></li>
<li><p><strong>exclude_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 from the <a class="reference internal" href="#psyplot.config.rcsetup.RcParams" title="psyplot.config.rcsetup.RcParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">RcParams</span></code></a> instance to be excluded</p></li>
<li><p><strong>**kwargs</strong> – Any other parameter for the <code class="xref py py-func docutils literal notranslate"><span class="pre">yaml.dump()</span></code> function</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>if fname is <code class="docutils literal notranslate"><span class="pre">None</span></code>, the string is returned. Otherwise, <code class="docutils literal notranslate"><span class="pre">None</span></code>
is returned</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#str" title="(in Python v3.12)">str</a> or None</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#IOError" title="(in Python v3.12)"><strong>IOError</strong></a> – If <cite>fname</cite> already exists and <cite>overwrite</cite> is False</p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.load_from_file" title="psyplot.config.rcsetup.RcParams.load_from_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">load_from_file</span></code></a></p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.find_all">
<span class="sig-name descname"><span class="pre">find_all</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pattern</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/config/rcsetup.html#RcParams.find_all"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.find_all" title="Link to this definition"></a></dt>
<dd><p>Return the subset of this RcParams dictionary whose keys match,
using <a class="reference external" href="https://docs.python.org/3/library/re.html#re.search" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">re.search()</span></code></a>, the given <code class="docutils literal notranslate"><span class="pre">pattern</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>pattern</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – pattern as suitable for re.compile</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>RcParams instance with entries that match the given <cite>pattern</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.config.rcsetup.RcParams" title="psyplot.config.rcsetup.RcParams">RcParams</a></p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>Changes to the returned dictionary are (different from
<a class="reference internal" href="#psyplot.config.rcsetup.RcParams.find_and_replace" title="psyplot.config.rcsetup.RcParams.find_and_replace"><code class="xref py py-meth docutils literal notranslate"><span class="pre">find_and_replace()</span></code></a> are <em>not</em> propagated to the parent RcParams
dictionary.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.find_and_replace" title="psyplot.config.rcsetup.RcParams.find_and_replace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">find_and_replace</span></code></a></p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.find_and_replace">
<span class="sig-name descname"><span class="pre">find_and_replace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</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/config/rcsetup.html#RcParams.find_and_replace"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.find_and_replace" title="Link to this definition"></a></dt>
<dd><p>Like <a class="reference internal" href="#psyplot.config.rcsetup.RcParams.find_all" title="psyplot.config.rcsetup.RcParams.find_all"><code class="xref py py-meth docutils literal notranslate"><span class="pre">find_all()</span></code></a> but the given strings are replaced</p>
<p>This method returns a dictionary-like object that keeps weak reference
to this rcParams instance. The resulting <cite>SubDict</cite> instance takes the
keys from this rcParams instance but leaves away what is found in
<cite>base_str</cite>.</p>
<p><code class="docutils literal notranslate"><span class="pre">*args</span></code> and <code class="docutils literal notranslate"><span class="pre">**kwargs</span></code> are determined by the <a class="reference internal" href="#psyplot.config.rcsetup.SubDict" title="psyplot.config.rcsetup.SubDict"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubDict</span></code></a>
class, where the <cite>base</cite> dictionary is this one.</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_str</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> 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> 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>) – Strings that are used as to look for keys to get and set keys in
the <code class="xref py py-attr docutils literal notranslate"><span class="pre">base</span></code> dictionary. If a string does not contain
<code class="docutils literal notranslate"><span class="pre">'%(key)s'</span></code>, it will be appended at the end. <code class="docutils literal notranslate"><span class="pre">'%(key)s'</span></code> will
be replaced by the specific key for getting and setting an item.</p></li>
<li><p><strong>pattern</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Default: <code class="docutils literal notranslate"><span class="pre">'.+'</span></code>. This is the pattern that is inserted for
<code class="docutils literal notranslate"><span class="pre">%(key)s</span></code> in a base string to look for matches (using the
<a class="reference external" href="https://docs.python.org/3/library/re.html#module-re" title="(in Python v3.12)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">re</span></code></a> module) in the <cite>base</cite> dictionary. The default <cite>pattern</cite>
matches everything without white spaces.</p></li>
<li><p><strong>pattern_base</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> 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>) – If None, the whatever is given in the <cite>base_str</cite> is used.
Those strings will be used for generating the final search
patterns. You can specify this parameter by yourself to avoid the
misinterpretation of patterns. For example for a <cite>base_str</cite> like
<code class="docutils literal notranslate"><span class="pre">'my.str'</span></code> it is recommended to additionally provide the
<cite>pattern_base</cite> keyword with <code class="docutils literal notranslate"><span class="pre">'my\.str'</span></code>.
Like for <cite>base_str</cite>, the <code class="docutils literal notranslate"><span class="pre">%(key)s</span></code> is appended if not already in
the string.</p></li>
<li><p><strong>trace</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: False. If True, changes in the SubDict are traced back to
the <cite>base</cite> dictionary. You can change this behaviour also
afterwards by changing the <code class="xref py py-attr docutils literal notranslate"><span class="pre">trace</span></code> attribute</p></li>
<li><p><strong>replace</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: True. If True, everything but the ‘%(key)s’ part in a
base string is replaced (see examples below)</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>SubDict with this rcParams instance as reference.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#psyplot.config.rcsetup.SubDict" title="psyplot.config.rcsetup.SubDict">SubDict</a></p>
</dd>
</dl>
<div class="admonition-examples admonition">
<p class="admonition-title">Examples</p>
<p>The syntax is the same as for the initialization of the
<a class="reference internal" href="#psyplot.config.rcsetup.SubDict" title="psyplot.config.rcsetup.SubDict"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubDict</span></code></a> class:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">psyplot</span> <span class="kn">import</span> <span class="n">rcParams</span>
<span class="gp">>>> </span><span class="n">d</span> <span class="o">=</span> <span class="n">rcParams</span><span class="o">.</span><span class="n">find_and_replace</span><span class="p">([</span><span class="s1">'plotter.baseplotter.'</span><span class="p">,</span>
<span class="gp">... </span> <span class="s1">'plotter.vector.'</span><span class="p">])</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">d</span><span class="p">[</span><span class="s1">'title'</span><span class="p">])</span>
<span class="go">None</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">d</span><span class="p">[</span><span class="s1">'arrowsize'</span><span class="p">])</span>
<span class="go">1.0</span>
</pre></div>
</div>
</div>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.find_all" title="psyplot.config.rcsetup.RcParams.find_all"><code class="xref py py-obj docutils literal notranslate"><span class="pre">find_all</span></code></a>, <a class="reference internal" href="#psyplot.config.rcsetup.SubDict" title="psyplot.config.rcsetup.SubDict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SubDict</span></code></a></p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.keys">
<span class="sig-name descname"><span class="pre">keys</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/config/rcsetup.html#RcParams.keys"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.keys" title="Link to this definition"></a></dt>
<dd><p>Return sorted list of keys.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.load_from_file">
<span class="sig-name descname"><span class="pre">load_from_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/config/rcsetup.html#RcParams.load_from_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.load_from_file" title="Link to this definition"></a></dt>
<dd><p>Update rcParams from user-defined settings</p>
<p>This function updates the instance with what is found in <cite>fname</cite></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>fname</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 yaml configuration file. Possible keys of the
dictionary are defined by <code class="xref py py-data docutils literal notranslate"><span class="pre">config.rcsetup.defaultParams</span></code>.
If None, the <code class="xref py py-func docutils literal notranslate"><span class="pre">config.rcsetup.psyplot_fname()</span></code> function is used.</p>
</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">dump_to_file</span></code>, <a class="reference internal" href="#psyplot.config.rcsetup.psyplot_fname" title="psyplot.config.rcsetup.psyplot_fname"><code class="xref py py-obj docutils literal notranslate"><span class="pre">psyplot_fname</span></code></a></p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.load_plugins">
<span class="sig-name descname"><span class="pre">load_plugins</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raise_error</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/config/rcsetup.html#RcParams.load_plugins"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.load_plugins" title="Link to this definition"></a></dt>
<dd><p>Load the plotters and defaultParams from the plugins</p>
<p>This method loads the <cite>plotters</cite> attribute and <cite>defaultParams</cite>
attribute from the plugins that use the entry point specified by
<cite>group</cite>. Entry points must be objects (or modules) that have a
<cite>defaultParams</cite> and a <cite>plotters</cite> attribute.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>raise_error</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, an error is raised when multiple plugins define the same
plotter or rcParams key. Otherwise only a warning is raised</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.msg_depr">
<span class="sig-name descname"><span class="pre">msg_depr</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'%s</span> <span class="pre">is</span> <span class="pre">deprecated</span> <span class="pre">and</span> <span class="pre">replaced</span> <span class="pre">with</span> <span class="pre">%s;</span> <span class="pre">please</span> <span class="pre">use</span> <span class="pre">the</span> <span class="pre">latter.'</span></em><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.msg_depr" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.msg_depr_ignore">
<span class="sig-name descname"><span class="pre">msg_depr_ignore</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'%s</span> <span class="pre">is</span> <span class="pre">deprecated</span> <span class="pre">and</span> <span class="pre">ignored.</span> <span class="pre">Use</span> <span class="pre">%s'</span></em><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.msg_depr_ignore" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.remove">
<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/config/rcsetup.html#RcParams.remove"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.remove" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">E</span></span></em>, <span class="optional">]</span><em class="sig-param"><span class="n"><span class="pre">**F</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None.</span>  <span class="pre">Update</span> <span class="pre">D</span> <span class="pre">from</span> <span class="pre">dict/iterable</span> <span class="pre">E</span> <span class="pre">and</span> <span class="pre">F.</span></span></span><a class="reference internal" href="../_modules/psyplot/config/rcsetup.html#RcParams.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.update" title="Link to this definition"></a></dt>
<dd><p>If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
In either case, this is followed by: for k in F: D[k] = F[k]</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.update_from_defaultParams">
<span class="sig-name descname"><span class="pre">update_from_defaultParams</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">defaultParams</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">plotters</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/config/rcsetup.html#RcParams.update_from_defaultParams"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.update_from_defaultParams" title="Link to this definition"></a></dt>
<dd><p>Update from the a dictionary like the <a class="reference internal" href="#psyplot.config.rcsetup.defaultParams" title="psyplot.config.rcsetup.defaultParams"><code class="xref py py-attr docutils literal notranslate"><span class="pre">defaultParams</span></code></a></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>defaultParams</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 <a class="reference internal" href="#psyplot.config.rcsetup.defaultParams" title="psyplot.config.rcsetup.defaultParams"><code class="xref py py-attr docutils literal notranslate"><span class="pre">defaultParams</span></code></a> like dictionary. If None, the
<a class="reference internal" href="#psyplot.config.rcsetup.defaultParams" title="psyplot.config.rcsetup.defaultParams"><code class="xref py py-attr docutils literal notranslate"><span class="pre">defaultParams</span></code></a> attribute will be updated</p></li>
<li><p><strong>plotters</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, <code class="docutils literal notranslate"><span class="pre">'project.plotters'</span></code> will be updated too</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.validate">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate</span></span><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.validate" title="Link to this definition"></a></dt>
<dd><p>Dictionary with validation methods as values</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.RcParams.values">
<span class="sig-name descname"><span class="pre">values</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/config/rcsetup.html#RcParams.values"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.RcParams.values" title="Link to this definition"></a></dt>
<dd><p>Return values in order of sorted keys.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.SubDict">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">psyplot.config.rcsetup.</span></span><span class="sig-name descname"><span class="pre">SubDict</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">base_str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pattern</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">pattern_base</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">trace</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">replace</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/config/rcsetup.html#SubDict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.SubDict" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/collections.html#collections.UserDict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">UserDict</span></code></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></p>
<p>Class that keeps week reference to the base dictionary</p>
<p>This class is used by the <a class="reference internal" href="#psyplot.config.rcsetup.RcParams.find_and_replace" title="psyplot.config.rcsetup.RcParams.find_and_replace"><code class="xref py py-meth docutils literal notranslate"><span class="pre">RcParams.find_and_replace()</span></code></a> method
to provide an easy handable instance that keeps reference to the
base rcParams dictionary.</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.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a>) – base dictionary</p></li>
<li><p><strong>base_str</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> 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> 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>) – Strings that are used as to look for keys to get and set keys in
the <a class="reference internal" href="#psyplot.config.rcsetup.SubDict.base" title="psyplot.config.rcsetup.SubDict.base"><code class="xref py py-attr docutils literal notranslate"><span class="pre">base</span></code></a> dictionary. If a string does not contain
<code class="docutils literal notranslate"><span class="pre">'%(key)s'</span></code>, it will be appended at the end. <code class="docutils literal notranslate"><span class="pre">'%(key)s'</span></code> will
be replaced by the specific key for getting and setting an item.</p></li>
<li><p><strong>pattern</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Default: <code class="docutils literal notranslate"><span class="pre">'.+'</span></code>. This is the pattern that is inserted for
<code class="docutils literal notranslate"><span class="pre">%(key)s</span></code> in a base string to look for matches (using the
<a class="reference external" href="https://docs.python.org/3/library/re.html#module-re" title="(in Python v3.12)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">re</span></code></a> module) in the <cite>base</cite> dictionary. The default <cite>pattern</cite>
matches everything without white spaces.</p></li>
<li><p><strong>pattern_base</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> 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>) – If None, the whatever is given in the <cite>base_str</cite> is used.
Those strings will be used for generating the final search
patterns. You can specify this parameter by yourself to avoid the
misinterpretation of patterns. For example for a <cite>base_str</cite> like
<code class="docutils literal notranslate"><span class="pre">'my.str'</span></code> it is recommended to additionally provide the
<cite>pattern_base</cite> keyword with <code class="docutils literal notranslate"><span class="pre">'my\.str'</span></code>.
Like for <cite>base_str</cite>, the <code class="docutils literal notranslate"><span class="pre">%(key)s</span></code> is appended if not already in
the string.</p></li>
<li><p><strong>trace</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: False. If True, changes in the SubDict are traced back to
the <cite>base</cite> dictionary. You can change this behaviour also
afterwards by changing the <a class="reference internal" href="#psyplot.config.rcsetup.SubDict.trace" title="psyplot.config.rcsetup.SubDict.trace"><code class="xref py py-attr docutils literal notranslate"><span class="pre">trace</span></code></a> attribute</p></li>
<li><p><strong>replace</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: True. If True, everything but the ‘%(key)s’ part in a
base string is replaced (see examples below)</p></li>
</ul>
</dd>
</dl>
<p class="rubric">Notes</p>
<ul class="simple">
<li><p>If a key of matches multiple strings in <cite>base_str</cite>, the first
matching one is used.</p></li>
<li><p>the SubDict class is (of course) not that efficient as the
<a class="reference internal" href="#psyplot.config.rcsetup.SubDict.base" title="psyplot.config.rcsetup.SubDict.base"><code class="xref py py-attr docutils literal notranslate"><span class="pre">base</span></code></a> dictionary, since we loop multiple times through it’s
keys</p></li>
</ul>
<div class="admonition-examples admonition">
<p class="admonition-title">Examples</p>
<p>Initialization example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">psyplot</span> <span class="kn">import</span> <span class="n">rcParams</span>
<span class="gp">>>> </span><span class="n">d</span> <span class="o">=</span> <span class="n">rcParams</span><span class="o">.</span><span class="n">find_and_replace</span><span class="p">([</span><span class="s1">'plotter.baseplotter.'</span><span class="p">,</span>
<span class="gp">... </span> <span class="s1">'plotter.vector.'</span><span class="p">])</span>
<span class="gp">>>> </span><span class="nb">print</span> <span class="n">d</span><span class="p">[</span><span class="s1">'title'</span><span class="p">]</span>
<span class="gp">>>> </span><span class="nb">print</span> <span class="n">d</span><span class="p">[</span><span class="s1">'arrowsize'</span><span class="p">]</span>
<span class="go">1.0</span>
</pre></div>
</div>
<p>To convert it to a usual dictionary, simply use the <a class="reference internal" href="#psyplot.config.rcsetup.SubDict.data" title="psyplot.config.rcsetup.SubDict.data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">data</span></code></a>
attribute:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">data</span>
<span class="go">{'title': None, 'arrowsize': 1.0, ...}</span>
</pre></div>
</div>
<p>Note that changing one keyword of your <a class="reference internal" href="#psyplot.config.rcsetup.SubDict" title="psyplot.config.rcsetup.SubDict"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubDict</span></code></a> will not change
the <a class="reference internal" href="#psyplot.config.rcsetup.SubDict.base" title="psyplot.config.rcsetup.SubDict.base"><code class="xref py py-attr docutils literal notranslate"><span class="pre">base</span></code></a> dictionary, unless you set the <a class="reference internal" href="#psyplot.config.rcsetup.SubDict.trace" title="psyplot.config.rcsetup.SubDict.trace"><code class="xref py py-attr docutils literal notranslate"><span class="pre">trace</span></code></a> attribute
to <code class="docutils literal notranslate"><span class="pre">True</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">d</span><span class="p">[</span><span class="s1">'title'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'my title'</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">d</span><span class="p">[</span><span class="s1">'title'</span><span class="p">])</span>
<span class="go">my title</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'plotter.baseplotter.title'</span><span class="p">])</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">trace</span> <span class="o">=</span> <span class="kc">True</span>
<span class="gp">>>> </span><span class="n">d</span><span class="p">[</span><span class="s1">'title'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'my second title'</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">d</span><span class="p">[</span><span class="s1">'title'</span><span class="p">])</span>
<span class="go">my second title</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'plotter.baseplotter.title'</span><span class="p">])</span>
<span class="go">my second title</span>
</pre></div>
</div>
<p>Furthermore, changing the <a class="reference internal" href="#psyplot.config.rcsetup.SubDict.replace" title="psyplot.config.rcsetup.SubDict.replace"><code class="xref py py-attr docutils literal notranslate"><span class="pre">replace</span></code></a> attribute will change how you
can access the keys:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">replace</span> <span class="o">=</span> <span class="kc">False</span>
<span class="go"># now setting d['title'] = 'anything' would raise an error (since</span>
<span class="go"># d.trace is set to True and 'title' is not a key in the rcParams</span>
<span class="go"># dictionary. Instead we need</span>
<span class="gp">>>> </span><span class="n">d</span><span class="p">[</span><span class="s1">'plotter.baseplotter.title'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'anything'</span>
</pre></div>
</div>
</div>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#psyplot.config.rcsetup.RcParams.find_and_replace" title="psyplot.config.rcsetup.RcParams.find_and_replace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RcParams.find_and_replace</span></code></a></p>
</div>
<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.config.rcsetup.SubDict.add_base_str" title="psyplot.config.rcsetup.SubDict.add_base_str"><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_base_str</span></code></a>(base_str[, pattern, ...])</p></td>
<td><p>Add further base string to this instance</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.SubDict.iteritems" title="psyplot.config.rcsetup.SubDict.iteritems"><code class="xref py py-obj docutils literal notranslate"><span class="pre">iteritems</span></code></a>()</p></td>
<td><p>Unsorted iterator over items</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.SubDict.iterkeys" title="psyplot.config.rcsetup.SubDict.iterkeys"><code class="xref py py-obj docutils literal notranslate"><span class="pre">iterkeys</span></code></a>()</p></td>
<td><p>Unsorted iterator over keys</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.SubDict.itervalues" title="psyplot.config.rcsetup.SubDict.itervalues"><code class="xref py py-obj docutils literal notranslate"><span class="pre">itervalues</span></code></a>()</p></td>
<td><p>Unsorted iterator over values</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.SubDict.update" title="psyplot.config.rcsetup.SubDict.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>(*args, **kwargs)</p></td>
<td><p>Update the dictionary</p></td>
</tr>
</tbody>
</table>
<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.config.rcsetup.SubDict.base" title="psyplot.config.rcsetup.SubDict.base"><code class="xref py py-obj docutils literal notranslate"><span class="pre">base</span></code></a></p></td>
<td><p><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>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.SubDict.base_str" title="psyplot.config.rcsetup.SubDict.base_str"><code class="xref py py-obj docutils literal notranslate"><span class="pre">base_str</span></code></a></p></td>
<td><p>list of strings.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.SubDict.data" title="psyplot.config.rcsetup.SubDict.data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">data</span></code></a></p></td>
<td><p>Dictionary representing this <a class="reference internal" href="#psyplot.config.rcsetup.SubDict" title="psyplot.config.rcsetup.SubDict"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubDict</span></code></a> instance</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.SubDict.patterns" title="psyplot.config.rcsetup.SubDict.patterns"><code class="xref py py-obj docutils literal notranslate"><span class="pre">patterns</span></code></a></p></td>
<td><p>list of compiled patterns from the <a class="reference internal" href="#psyplot.config.rcsetup.SubDict.base_str" title="psyplot.config.rcsetup.SubDict.base_str"><code class="xref py py-attr docutils literal notranslate"><span class="pre">base_str</span></code></a> attribute, that are used to look for the matching keys in <a class="reference internal" href="#psyplot.config.rcsetup.SubDict.base" title="psyplot.config.rcsetup.SubDict.base"><code class="xref py py-attr docutils literal notranslate"><span class="pre">base</span></code></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.SubDict.replace" title="psyplot.config.rcsetup.SubDict.replace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">replace</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-even"><td><p><a class="reference internal" href="#psyplot.config.rcsetup.SubDict.trace" title="psyplot.config.rcsetup.SubDict.trace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trace</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>
</tbody>
</table>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.SubDict.add_base_str">
<span class="sig-name descname"><span class="pre">add_base_str</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pattern</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">pattern_base</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">append</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/config/rcsetup.html#SubDict.add_base_str"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.SubDict.add_base_str" title="Link to this definition"></a></dt>
<dd><p>Add further base string to 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>base_str</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> 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> 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>) – Strings that are used as to look for keys to get and set keys in
the <a class="reference internal" href="#psyplot.config.rcsetup.SubDict.base" title="psyplot.config.rcsetup.SubDict.base"><code class="xref py py-attr docutils literal notranslate"><span class="pre">base</span></code></a> dictionary. If a string does not contain
<code class="docutils literal notranslate"><span class="pre">'%(key)s'</span></code>, it will be appended at the end. <code class="docutils literal notranslate"><span class="pre">'%(key)s'</span></code> will
be replaced by the specific key for getting and setting an item.</p></li>
<li><p><strong>pattern</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Default: <code class="docutils literal notranslate"><span class="pre">'.+'</span></code>. This is the pattern that is inserted for
<code class="docutils literal notranslate"><span class="pre">%(key)s</span></code> in a base string to look for matches (using the
<a class="reference external" href="https://docs.python.org/3/library/re.html#module-re" title="(in Python v3.12)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">re</span></code></a> module) in the <cite>base</cite> dictionary. The default <cite>pattern</cite>
matches everything without white spaces.</p></li>
<li><p><strong>pattern_base</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> 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>) – If None, the whatever is given in the <cite>base_str</cite> is used.
Those strings will be used for generating the final search
patterns. You can specify this parameter by yourself to avoid the
misinterpretation of patterns. For example for a <cite>base_str</cite> like
<code class="docutils literal notranslate"><span class="pre">'my.str'</span></code> it is recommended to additionally provide the
<cite>pattern_base</cite> keyword with <code class="docutils literal notranslate"><span class="pre">'my\.str'</span></code>.
Like for <cite>base_str</cite>, the <code class="docutils literal notranslate"><span class="pre">%(key)s</span></code> is appended if not already in
the string.</p></li>
<li><p><strong>append</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 given <cite>base_str</cite> are appended (i.e. it is first
looked for them in the <a class="reference internal" href="#psyplot.config.rcsetup.SubDict.base" title="psyplot.config.rcsetup.SubDict.base"><code class="xref py py-attr docutils literal notranslate"><span class="pre">base</span></code></a> dictionary), otherwise they are
put at the beginning</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.SubDict.base">
<span class="sig-name descname"><span class="pre">base</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#psyplot.config.rcsetup.SubDict.base" title="Link to this definition"></a></dt>
<dd><p><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>. Reference dictionary</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.SubDict.base_str">
<span class="sig-name descname"><span class="pre">base_str</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#psyplot.config.rcsetup.SubDict.base_str" title="Link to this definition"></a></dt>
<dd><p>list of strings. The strings that are used to set and get a specific key
from the <a class="reference internal" href="#psyplot.config.rcsetup.SubDict.base" title="psyplot.config.rcsetup.SubDict.base"><code class="xref py py-attr docutils literal notranslate"><span class="pre">base</span></code></a> dictionary</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.SubDict.data">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data</span></span><a class="headerlink" href="#psyplot.config.rcsetup.SubDict.data" title="Link to this definition"></a></dt>
<dd><p>Dictionary representing this <a class="reference internal" href="#psyplot.config.rcsetup.SubDict" title="psyplot.config.rcsetup.SubDict"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubDict</span></code></a> instance</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#psyplot.config.rcsetup.SubDict.iteritems" title="psyplot.config.rcsetup.SubDict.iteritems"><code class="xref py py-obj docutils literal notranslate"><span class="pre">iteritems</span></code></a></p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.SubDict.iteritems">
<span class="sig-name descname"><span class="pre">iteritems</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/psyplot/config/rcsetup.html#SubDict.iteritems"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#psyplot.config.rcsetup.SubDict.iteritems" title="Link to this definition"></a></dt>
<dd><p>Unsorted iterator over items</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="psyplot.config.rcsetup.SubDict.iterkeys">