-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathdevelopment_setup.html
More file actions
954 lines (753 loc) · 58.7 KB
/
development_setup.html
File metadata and controls
954 lines (753 loc) · 58.7 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
<!DOCTYPE html>
<html lang="en" data-content_root="../" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Setting up Matplotlib for development — Matplotlib 3.11.0.dev1907+gd5f597d3d documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../_static/css/style.css?v=522e7f4d" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="../_static/mpl.css?v=5a7e13c8" />
<!-- So that users can add custom icons -->
<script src="../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
<script src="../_static/documentation_options.js?v=66a236c0"></script>
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=ccdb6887"></script>
<script src="../_static/design-tabs.js?v=f930bc37"></script>
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'devel/development_setup';</script>
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://matplotlib.org/devdocs/_static/switcher.json?v3.10.8-1907-gd5f597d3d';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = 'dev';
DOCUMENTATION_OPTIONS.show_version_warning_banner =
true;
</script>
<link rel="canonical" href="https://matplotlib.org/stable/devel/development_setup.html" />
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.11.0.dev1907+gd5f597d3d documentation"
href="../_static/opensearch.xml"/>
<link rel="icon" href="../_static/favicon.ico"/>
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Development workflow" href="development_workflow.html" />
<link rel="prev" title="Contributing guide" href="contribute.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="3.11.0.dev1907+gd5f597d3d" />
<meta name="docbuild:last-update" content="Nov 13, 2025"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="../search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="https://matplotlib.org/stable/">
<img src="../_static/logo_light.svg" class="logo__image only-light" alt="Matplotlib 3.11.0.dev1907+gd5f597d3d documentation - Home"/>
<img src="../_static/logo_dark.svg" class="logo__image only-dark pst-js-only" alt="Matplotlib 3.11.0.dev1907+gd5f597d3d documentation - Home"/>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/index.html">User guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../api/index.html">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="index.html">Contribute</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/release_notes.html">Releases</a>
</li>
</ul></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
</div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item">
<div class="version-switcher__container dropdown pst-js-only">
<button id="pst-version-switcher-button-2"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-2"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-2"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-2">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://gitter.im/matplotlib/matplotlib" title="Gitter" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-gitter fa-lg" aria-hidden="true"></i>
<span class="sr-only">Gitter</span></a>
</li>
<li class="nav-item">
<a href="https://discourse.matplotlib.org" title="Discourse" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-discourse fa-lg" aria-hidden="true"></i>
<span class="sr-only">Discourse</span></a>
</li>
<li class="nav-item">
<a href="https://github.com/matplotlib/matplotlib" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/index.html">User guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../api/index.html">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="index.html">Contribute</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/release_notes.html">Releases</a>
</li>
</ul></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item">
<div class="version-switcher__container dropdown pst-js-only">
<button id="pst-version-switcher-button-3"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-3"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-3"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-3">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://gitter.im/matplotlib/matplotlib" title="Gitter" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-gitter fa-lg" aria-hidden="true"></i>
<span class="sr-only">Gitter</span></a>
</li>
<li class="nav-item">
<a href="https://discourse.matplotlib.org" title="Discourse" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-discourse fa-lg" aria-hidden="true"></i>
<span class="sr-only">Discourse</span></a>
</li>
<li class="nav-item">
<a href="https://github.com/matplotlib/matplotlib" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contributing guide</a></li>
</ul>
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Setting up Matplotlib for development</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="development_workflow.html">Development workflow</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="coding_guide.html">Coding guidelines</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="license.html">Licenses for contributed code</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes.html">API guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="document.html">Write documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="style_guide.html">Documentation style guide</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="tag_guidelines.html">Tagging guidelines</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="tag_glossary.html">Tag Glossary</a></li>
</ul>
</details></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="triage.html">Bug triaging and issue curation</a></li>
<li class="toctree-l1"><a class="reference internal" href="pr_guide.html">Pull request guidelines</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="release_guide.html">Release guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="communication_guide.html">Community management guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="min_dep_policy.html">Dependency version policy</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="MEP/index.html">Matplotlib Enhancement Proposals</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="MEP/template.html">MEP Template</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP08.html">MEP8: PEP8</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP09.html">MEP9: Global interaction manager</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP10.html">MEP10: Docstring consistency</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP11.html">MEP11: Third-party dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP12.html">MEP12: Improve Gallery and Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP13.html">MEP13: Use properties for Artists</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP14.html">MEP14: Text handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP15.html">MEP15: Fix axis autoscaling when limits are specified for one axis only</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP19.html">MEP19: Continuous Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP21.html">MEP21: color and cm refactor</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP22.html">MEP22: Toolbar rewrite</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP23.html">MEP23: Multiple Figures per GUI window</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP24.html">MEP24: Negative radius in polar plots</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP25.html">MEP25: Serialization</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP26.html">MEP26: Artist styling</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP27.html">MEP27: Decouple pyplot from backends</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP28.html">MEP28: Remove Complexity from Axes.boxplot</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP29.html">MEP29: Text light markup</a></li>
</ul>
</details></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="../index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item"><a href="index.html" class="nav-link">Contribute</a></li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Setting up Matplotlib for development</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="setting-up-matplotlib-for-development">
<span id="installing-for-devs"></span><h1>Setting up Matplotlib for development<a class="headerlink" href="#setting-up-matplotlib-for-development" title="Link to this heading">#</a></h1>
<p>To set up Matplotlib for development follow these steps:</p>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#fork-the-matplotlib-repository" id="id1">Fork the Matplotlib repository</a></p></li>
<li><p><a class="reference internal" href="#set-up-development-environment" id="id2">Set up development environment</a></p>
<ul>
<li><p><a class="reference internal" href="#create-local-environment" id="id3">Create local environment</a></p>
<ul>
<li><p><a class="reference internal" href="#get-most-recent-code" id="id4">Get most recent code</a></p></li>
<li><p><a class="reference internal" href="#create-a-dedicated-environment" id="id5">Create a dedicated environment</a></p></li>
<li><p><a class="reference internal" href="#install-external-dependencies" id="id6">Install external dependencies</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#create-github-codespace-svg-version-1-1-width-1-0em-height-1-0em-class-sd-octicon-sd-octicon-codespaces-viewbox-0-0-16-16-aria-hidden-true-path-d-m0-11-25c0-966-784-1-75-1-75-1-75h12-5c-966-0-1-75-784-1-75-1-75v3a1-75-1-75-0-0-1-14-25-16h1-75a1-75-1-75-0-0-1-0-14-25zm2-9-5c2-784-2-784-0-3-75-0h8-5c13-216-0-14-784-14-1-75v5a1-75-1-75-0-0-1-1-75-1-75h-8-5a1-75-1-75-0-0-1-2-6-75zm1-75-25a-25-25-0-0-0-25-25v5c0-138-112-25-25-25h8-5a-25-25-0-0-0-25-25v-5a-25-25-0-0-0-25-25zm-2-9-5a-25-25-0-0-0-25-25v3c0-138-112-25-25-25h12-5a-25-25-0-0-0-25-25v-3a-25-25-0-0-0-25-25z-path-path-d-m7-12-75a-75-75-0-0-1-75-75h4-5a-75-75-0-0-1-0-1-5h-4-5a-75-75-0-0-1-75-75zm-4-0a-75-75-0-0-1-75-75h-5a-75-75-0-0-1-0-1-5h-5a-75-75-0-0-1-75-75z-path-svg" id="id7">Create GitHub Codespace <svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-codespaces" viewBox="0 0 16 16" aria-hidden="true"><path d="M0 11.25c0-.966.784-1.75 1.75-1.75h12.5c.966 0 1.75.784 1.75 1.75v3A1.75 1.75 0 0 1 14.25 16H1.75A1.75 1.75 0 0 1 0 14.25Zm2-9.5C2 .784 2.784 0 3.75 0h8.5C13.216 0 14 .784 14 1.75v5a1.75 1.75 0 0 1-1.75 1.75h-8.5A1.75 1.75 0 0 1 2 6.75Zm1.75-.25a.25.25 0 0 0-.25.25v5c0 .138.112.25.25.25h8.5a.25.25 0 0 0 .25-.25v-5a.25.25 0 0 0-.25-.25Zm-2 9.5a.25.25 0 0 0-.25.25v3c0 .138.112.25.25.25h12.5a.25.25 0 0 0 .25-.25v-3a.25.25 0 0 0-.25-.25Z"></path><path d="M7 12.75a.75.75 0 0 1 .75-.75h4.5a.75.75 0 0 1 0 1.5h-4.5a.75.75 0 0 1-.75-.75Zm-4 0a.75.75 0 0 1 .75-.75h.5a.75.75 0 0 1 0 1.5h-.5a.75.75 0 0 1-.75-.75Z"></path></svg></a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#install-matplotlib-in-editable-mode" id="id8">Install Matplotlib in editable mode</a></p>
<ul>
<li><p><a class="reference internal" href="#build-options" id="id9">Build options</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#verify-the-installation" id="id10">Verify the Installation</a></p></li>
<li><p><a class="reference internal" href="#install-pre-commit-hooks" id="id11">Install pre-commit hooks</a></p></li>
</ul>
</nav>
<section id="fork-the-matplotlib-repository">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Fork the Matplotlib repository</a><a class="headerlink" href="#fork-the-matplotlib-repository" title="Link to this heading">#</a></h2>
<p>Matplotlib is hosted at <a class="github reference external" href="https://github.com/matplotlib/matplotlib.git">matplotlib/matplotlib.git</a>. If you
plan on solving issues or submitting pull requests to the main Matplotlib
repository, you should first fork this repository by <em>clicking</em> the
<svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-repo-forked" viewBox="0 0 16 16" aria-hidden="true"><path d="M5 5.372v.878c0 .414.336.75.75.75h4.5a.75.75 0 0 0 .75-.75v-.878a2.25 2.25 0 1 1 1.5 0v.878a2.25 2.25 0 0 1-2.25 2.25h-1.5v2.128a2.251 2.251 0 1 1-1.5 0V8.5h-1.5A2.25 2.25 0 0 1 3.5 6.25v-.878a2.25 2.25 0 1 1 1.5 0ZM5 3.25a.75.75 0 1 0-1.5 0 .75.75 0 0 0 1.5 0Zm6.75.75a.75.75 0 1 0 0-1.5.75.75 0 0 0 0 1.5Zm-3 8.75a.75.75 0 1 0-1.5 0 .75.75 0 0 0 1.5 0Z"></path></svg> <strong>Fork</strong> button near the top of the <a class="reference external" href="https://github.com/matplotlib/matplotlib">project repository</a> page.</p>
<p>This creates a copy of the code under your account on the GitHub server. See <a class="reference external" href="https://docs.github.com/get-started/quickstart/fork-a-repo">the GitHub
documentation</a> for more details.</p>
</section>
<section id="set-up-development-environment">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Set up development environment</a><a class="headerlink" href="#set-up-development-environment" title="Link to this heading">#</a></h2>
<p>You can either work locally on your machine, or online in
<a class="reference external" href="https://docs.github.com/codespaces">GitHub Codespaces</a>, a cloud-based in-browser development
environment.</p>
<dl class="field-list simple">
<dt class="field-odd">local<span class="colon">:</span></dt>
<dd class="field-odd"><p>If you are making extensive or frequent contributions to Matplotlib then it
is probably worth taking the time to set up on your local machine: As well as
having the convenience of your local familiar tools, you will not need to worry
about Codespace's monthly usage limits.</p>
</dd>
<dt class="field-even">codespaces<span class="colon">:</span></dt>
<dd class="field-even"><p>If you are making a one-off, relatively simple, change then working in
GitHub Codespaces can be a good option because most of the setting
up is done for you and you can skip the next few sections.</p>
</dd>
</dl>
<p>If you want to use Codespaces, skip to <a class="reference internal" href="#development-codespaces"><span class="std std-ref">Create GitHub Codespace </span></a>,
otherwise, continue with the next section.</p>
<section id="create-local-environment">
<h3><a class="toc-backref" href="#id3" role="doc-backlink">Create local environment</a><a class="headerlink" href="#create-local-environment" title="Link to this heading">#</a></h3>
<section id="get-most-recent-code">
<h4><a class="toc-backref" href="#id4" role="doc-backlink">Get most recent code</a><a class="headerlink" href="#get-most-recent-code" title="Link to this heading">#</a></h4>
<p>Now that your fork of the repository lives under your GitHub username, you can
retrieve the most recent version of the source code with one of the following
commands (replace <code class="docutils literal notranslate"><span class="pre"><your-username></span></code> with your GitHub username):</p>
<div class="sd-tab-set docutils">
<input checked="checked" id="sd-tab-item-0" name="sd-tab-set-0" type="radio">
<label class="sd-tab-label" for="sd-tab-item-0">
https</label><div class="sd-tab-content docutils">
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/<your-username>/matplotlib.git
</pre></div>
</div>
</div>
<input id="sd-tab-item-1" name="sd-tab-set-0" type="radio">
<label class="sd-tab-label" for="sd-tab-item-1">
ssh</label><div class="sd-tab-content docutils">
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>git@github.com:<your-username>/matplotlib.git
</pre></div>
</div>
<p>This requires you to setup an <a class="reference external" href="https://docs.github.com/en/authentication/connecting-to-github-with-ssh">SSH key</a> in advance, but saves you from
typing your password at every connection.</p>
</div>
</div>
<p>This will place the sources in a directory <code class="file docutils literal notranslate"><span class="pre">matplotlib</span></code> below your
current working directory and set the remote name <code class="docutils literal notranslate"><span class="pre">origin</span></code> to point to your
fork. Change into this directory before continuing:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>matplotlib
</pre></div>
</div>
<p>Now set the remote name <code class="docutils literal notranslate"><span class="pre">upstream</span></code> to point to the Matplotlib main repository:</p>
<div class="sd-tab-set docutils">
<input checked="checked" id="sd-tab-item-2" name="sd-tab-set-1" type="radio">
<label class="sd-tab-label" for="sd-tab-item-2">
https</label><div class="sd-tab-content docutils">
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>remote<span class="w"> </span>add<span class="w"> </span>upstream<span class="w"> </span>https://github.com/matplotlib/matplotlib.git
</pre></div>
</div>
</div>
<input id="sd-tab-item-3" name="sd-tab-set-1" type="radio">
<label class="sd-tab-label" for="sd-tab-item-3">
ssh</label><div class="sd-tab-content docutils">
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>remote<span class="w"> </span>add<span class="w"> </span>upstream<span class="w"> </span>git@github.com:matplotlib/matplotlib.git
</pre></div>
</div>
</div>
</div>
<p>You can now use <code class="docutils literal notranslate"><span class="pre">upstream</span></code> to retrieve the most current snapshot of the source
code, as described in <a class="reference internal" href="development_workflow.html#development-workflow"><span class="std std-ref">Development workflow</span></a>.</p>
<details class="sd-sphinx-override sd-dropdown sd-card sd-mb-3" open="open">
<summary class="sd-summary-title sd-card-header sd-bg-info sd-bg-text-info">
<span class="sd-summary-text">Additional <code class="docutils literal notranslate"><span class="pre">git</span></code> and <code class="docutils literal notranslate"><span class="pre">GitHub</span></code> resources</span><span class="sd-summary-state-marker sd-summary-chevron-right"><svg version="1.1" width="1.5em" height="1.5em" class="sd-octicon sd-octicon-chevron-right" viewBox="0 0 24 24" aria-hidden="true"><path d="M8.72 18.78a.75.75 0 0 1 0-1.06L14.44 12 8.72 6.28a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018l6.25 6.25a.75.75 0 0 1 0 1.06l-6.25 6.25a.75.75 0 0 1-1.06 0Z"></path></svg></span></summary><div class="sd-summary-content sd-card-body docutils">
<p class="sd-card-text">For more information on <code class="docutils literal notranslate"><span class="pre">git</span></code> and <code class="docutils literal notranslate"><span class="pre">GitHub</span></code>, see:</p>
<ul class="simple">
<li><p class="sd-card-text"><a class="reference external" href="https://git-scm.com/doc">Git documentation</a></p></li>
<li><p class="sd-card-text"><a class="reference external" href="https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project">GitHub-Contributing to a Project</a></p></li>
<li><p class="sd-card-text"><a class="reference external" href="https://skills.github.com/">GitHub Skills</a></p></li>
<li><p class="sd-card-text"><a class="reference external" href="https://docs.scipy.org/doc/scipy/dev/gitwash/gitwash.html#using-git" title="(in SciPy v1.17.0)"><span>Git for development</span></a></p></li>
<li><p class="sd-card-text"><a class="reference external" href="https://docs.scipy.org/doc/scipy/dev/gitwash/git_resources.html#git-resources" title="(in SciPy v1.17.0)"><span>Additional Git Resources</span></a></p></li>
<li><p class="sd-card-text"><a class="reference external" href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git">Installing git</a></p></li>
<li><p class="sd-card-text"><a class="reference external" href="https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories">Managing remote repositories</a></p></li>
<li><p class="sd-card-text"><a class="reference external" href="https://tacaswell.github.io/think-like-git.html">https://tacaswell.github.io/think-like-git.html</a></p></li>
<li><p class="sd-card-text"><a class="reference external" href="https://tom.preston-werner.com/2009/05/19/the-git-parable.html">https://tom.preston-werner.com/2009/05/19/the-git-parable.html</a></p></li>
</ul>
</div>
</details></section>
<section id="create-a-dedicated-environment">
<span id="dev-environment"></span><h4><a class="toc-backref" href="#id5" role="doc-backlink">Create a dedicated environment</a><a class="headerlink" href="#create-a-dedicated-environment" title="Link to this heading">#</a></h4>
<p>You should set up a dedicated environment to decouple your Matplotlib
development from other Python and Matplotlib installations on your system.</p>
<p>We recommend using one of the following options for a dedicated development environment
because these options are configured to install the Python dependencies as part of their
setup.</p>
<div class="sd-tab-set docutils">
<input checked="checked" id="sd-tab-item-4" name="sd-tab-set-2" type="radio">
<label class="sd-tab-label" for="sd-tab-item-4">
venv environment</label><div class="sd-tab-content docutils">
<p>Create a new <a class="reference external" href="https://docs.python.org/3/library/venv.html">venv</a> environment with</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span><file<span class="w"> </span>folder<span class="w"> </span>location>
</pre></div>
</div>
<p>and activate it with one of the following :</p>
<div class="sd-tab-set docutils">
<input checked="checked" id="sd-tab-item-6" name="sd-tab-set-3" type="radio">
<label class="sd-tab-label" for="sd-tab-item-6">
Linux and macOS</label><div class="sd-tab-content docutils">
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">source</span><span class="w"> </span><file<span class="w"> </span>folder<span class="w"> </span>location>/bin/activate<span class="w"> </span><span class="c1"># Linux/macOS</span>
</pre></div>
</div>
</div>
<input id="sd-tab-item-7" name="sd-tab-set-3" type="radio">
<label class="sd-tab-label" for="sd-tab-item-7">
Windows cmd.exe</label><div class="sd-tab-content docutils">
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span><span class="p"><</span>file folder location<span class="p">></span>\Scripts\activate.bat
</pre></div>
</div>
</div>
<input id="sd-tab-item-8" name="sd-tab-set-3" type="radio">
<label class="sd-tab-label" for="sd-tab-item-8">
Windows PowerShell</label><div class="sd-tab-content docutils">
<div class="highlight-ps1con notranslate"><div class="highlight"><pre><span></span><span class="go"><file folder location>\Scripts\Activate.ps1</span>
</pre></div>
</div>
</div>
</div>
<p>On some systems, you may need to type <code class="docutils literal notranslate"><span class="pre">python3</span></code> instead of <code class="docutils literal notranslate"><span class="pre">python</span></code>.
For a discussion of the technical reasons, see <a class="reference external" href="https://peps.python.org/pep-0394">PEP-394</a>.</p>
<p>Install the Python dependencies with</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements/dev/dev-requirements.txt
</pre></div>
</div>
<p>Remember to activate the environment whenever you start working on Matplotlib!</p>
</div>
<input id="sd-tab-item-5" name="sd-tab-set-2" type="radio">
<label class="sd-tab-label" for="sd-tab-item-5">
conda environment</label><div class="sd-tab-content docutils">
<p>Create a new <a class="reference external" href="https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html">conda</a> environment and install the Python dependencies with</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>env<span class="w"> </span>create<span class="w"> </span>-f<span class="w"> </span>environment.yml
</pre></div>
</div>
<p>You can use <code class="docutils literal notranslate"><span class="pre">mamba</span></code> instead of <code class="docutils literal notranslate"><span class="pre">conda</span></code> in the above command if
you have <a class="reference external" href="https://mamba.readthedocs.io/en/latest/">mamba</a> installed.</p>
<p>Activate the environment using</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>activate<span class="w"> </span>mpl-dev
</pre></div>
</div>
<p>Remember to activate the environment whenever you start working on Matplotlib!</p>
</div>
</div>
</section>
<section id="install-external-dependencies">
<h4><a class="toc-backref" href="#id6" role="doc-backlink">Install external dependencies</a><a class="headerlink" href="#install-external-dependencies" title="Link to this heading">#</a></h4>
<p>Python dependencies were installed as part of <a class="reference internal" href="#dev-environment"><span class="std std-ref">setting up the environment</span></a>.
Additionally, the following non-Python dependencies must also be installed locally:</p>
<ul class="checklist simple">
<li><p><a class="reference internal" href="../install/dependencies.html#compile-build-dependencies"><span class="std std-ref">Compilers and external build tools</span></a></p></li>
<li><p><a class="reference internal" href="../install/dependencies.html#doc-dependencies-external"><span class="std std-ref">external tools used by the documentation build</span></a></p></li>
</ul>
<p>For a full list of dependencies, see <a class="reference internal" href="../install/dependencies.html#dependencies"><span class="std std-ref">Dependencies</span></a>. External dependencies do not
need to be installed when working in codespaces.</p>
</section>
</section>
<section id="create-github-codespace-svg-version-1-1-width-1-0em-height-1-0em-class-sd-octicon-sd-octicon-codespaces-viewbox-0-0-16-16-aria-hidden-true-path-d-m0-11-25c0-966-784-1-75-1-75-1-75h12-5c-966-0-1-75-784-1-75-1-75v3a1-75-1-75-0-0-1-14-25-16h1-75a1-75-1-75-0-0-1-0-14-25zm2-9-5c2-784-2-784-0-3-75-0h8-5c13-216-0-14-784-14-1-75v5a1-75-1-75-0-0-1-1-75-1-75h-8-5a1-75-1-75-0-0-1-2-6-75zm1-75-25a-25-25-0-0-0-25-25v5c0-138-112-25-25-25h8-5a-25-25-0-0-0-25-25v-5a-25-25-0-0-0-25-25zm-2-9-5a-25-25-0-0-0-25-25v3c0-138-112-25-25-25h12-5a-25-25-0-0-0-25-25v-3a-25-25-0-0-0-25-25z-path-path-d-m7-12-75a-75-75-0-0-1-75-75h4-5a-75-75-0-0-1-0-1-5h-4-5a-75-75-0-0-1-75-75zm-4-0a-75-75-0-0-1-75-75h-5a-75-75-0-0-1-0-1-5h-5a-75-75-0-0-1-75-75z-path-svg">
<span id="development-codespaces"></span><h3><a class="toc-backref" href="#id7" role="doc-backlink">Create GitHub Codespace <svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-codespaces" viewBox="0 0 16 16" aria-hidden="true"><path d="M0 11.25c0-.966.784-1.75 1.75-1.75h12.5c.966 0 1.75.784 1.75 1.75v3A1.75 1.75 0 0 1 14.25 16H1.75A1.75 1.75 0 0 1 0 14.25Zm2-9.5C2 .784 2.784 0 3.75 0h8.5C13.216 0 14 .784 14 1.75v5a1.75 1.75 0 0 1-1.75 1.75h-8.5A1.75 1.75 0 0 1 2 6.75Zm1.75-.25a.25.25 0 0 0-.25.25v5c0 .138.112.25.25.25h8.5a.25.25 0 0 0 .25-.25v-5a.25.25 0 0 0-.25-.25Zm-2 9.5a.25.25 0 0 0-.25.25v3c0 .138.112.25.25.25h12.5a.25.25 0 0 0 .25-.25v-3a.25.25 0 0 0-.25-.25Z"></path><path d="M7 12.75a.75.75 0 0 1 .75-.75h4.5a.75.75 0 0 1 0 1.5h-4.5a.75.75 0 0 1-.75-.75Zm-4 0a.75.75 0 0 1 .75-.75h.5a.75.75 0 0 1 0 1.5h-.5a.75.75 0 0 1-.75-.75Z"></path></svg></a><a class="headerlink" href="#create-github-codespace-svg-version-1-1-width-1-0em-height-1-0em-class-sd-octicon-sd-octicon-codespaces-viewbox-0-0-16-16-aria-hidden-true-path-d-m0-11-25c0-966-784-1-75-1-75-1-75h12-5c-966-0-1-75-784-1-75-1-75v3a1-75-1-75-0-0-1-14-25-16h1-75a1-75-1-75-0-0-1-0-14-25zm2-9-5c2-784-2-784-0-3-75-0h8-5c13-216-0-14-784-14-1-75v5a1-75-1-75-0-0-1-1-75-1-75h-8-5a1-75-1-75-0-0-1-2-6-75zm1-75-25a-25-25-0-0-0-25-25v5c0-138-112-25-25-25h8-5a-25-25-0-0-0-25-25v-5a-25-25-0-0-0-25-25zm-2-9-5a-25-25-0-0-0-25-25v3c0-138-112-25-25-25h12-5a-25-25-0-0-0-25-25v-3a-25-25-0-0-0-25-25z-path-path-d-m7-12-75a-75-75-0-0-1-75-75h4-5a-75-75-0-0-1-0-1-5h-4-5a-75-75-0-0-1-75-75zm-4-0a-75-75-0-0-1-75-75h-5a-75-75-0-0-1-0-1-5h-5a-75-75-0-0-1-75-75z-path-svg" title="Link to this heading">#</a></h3>
<p><a class="reference external" href="https://docs.github.com/codespaces">GitHub Codespaces</a> is a cloud-based
in-browser development environment that comes with the appropriate setup to
contribute to Matplotlib.</p>
<ol class="arabic">
<li><p>Open codespaces on your fork by clicking on the green <svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-code" viewBox="0 0 16 16" aria-hidden="true"><path d="m11.28 3.22 4.25 4.25a.75.75 0 0 1 0 1.06l-4.25 4.25a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L13.94 8l-3.72-3.72a.749.749 0 0 1 .326-1.275.749.749 0 0 1 .734.215Zm-6.56 0a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042L2.06 8l3.72 3.72a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L.47 8.53a.75.75 0 0 1 0-1.06Z"></path></svg> <code class="docutils literal notranslate"><span class="pre">Code</span></code>
button on the GitHub web interface and selecting the <code class="docutils literal notranslate"><span class="pre">Codespaces</span></code> tab.</p></li>
<li><p>Next, click on "Open codespaces on <your branch name>". You will be
able to change branches later, so you can select the default
<code class="docutils literal notranslate"><span class="pre">main</span></code> branch.</p></li>
<li><p>After the codespace is created, you will be taken to a new browser
tab where you can use the terminal to activate a pre-defined conda
environment called <code class="docutils literal notranslate"><span class="pre">mpl-dev</span></code>:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>activate<span class="w"> </span>mpl-dev
</pre></div>
</div>
</li>
</ol>
<p>Remember to activate the <em>mpl-dev</em> environment whenever you start working on
Matplotlib.</p>
<p>If you need to open a GUI window with Matplotlib output on Codespaces, our
configuration includes a <a class="reference external" href="https://github.com/devcontainers/features/tree/main/src/desktop-lite">light-weight Fluxbox-based desktop</a>.
You can use it by connecting to this desktop via your web browser. To do this:</p>
<ol class="arabic simple">
<li><p>Press <code class="docutils literal notranslate"><span class="pre">F1</span></code> or <code class="docutils literal notranslate"><span class="pre">Ctrl/Cmd+Shift+P</span></code> and select
<code class="docutils literal notranslate"><span class="pre">Ports:</span> <span class="pre">Focus</span> <span class="pre">on</span> <span class="pre">Ports</span> <span class="pre">View</span></code> in the VSCode session to bring it into
focus. Open the ports view in your tool, select the <code class="docutils literal notranslate"><span class="pre">noVNC</span></code> port, and
click the Globe icon.</p></li>
<li><p>In the browser that appears, click the Connect button and enter the desktop
password (<code class="docutils literal notranslate"><span class="pre">vscode</span></code> by default).</p></li>
</ol>
<p>Check the <a class="reference external" href="https://github.com/devcontainers/features/tree/main/src/desktop-lite#connecting-to-the-desktop">GitHub instructions</a>
for more details on connecting to the desktop.</p>
<p>If you also built the documentation pages, you can view them using Codespaces.
Use the "Extensions" icon in the activity bar to install the "Live Server"
extension. Locate the <code class="docutils literal notranslate"><span class="pre">doc/build/html</span></code> folder in the Explorer, right click
the file you want to open and select "Open with Live Server."</p>
</section>
</section>
<section id="install-matplotlib-in-editable-mode">
<span id="development-install"></span><h2><a class="toc-backref" href="#id8" role="doc-backlink">Install Matplotlib in editable mode</a><a class="headerlink" href="#install-matplotlib-in-editable-mode" title="Link to this heading">#</a></h2>
<p>Install Matplotlib in editable mode from the <code class="file docutils literal notranslate"><span class="pre">matplotlib</span></code> directory using the
command</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>--verbose<span class="w"> </span>--no-build-isolation<span class="w"> </span>--editable<span class="w"> </span><span class="s2">".[dev]"</span>
</pre></div>
</div>
<p>The 'editable/develop mode' builds everything and places links in your Python environment
so that Python will be able to import Matplotlib from your development source directory.
This allows you to import your modified version of Matplotlib without having to
re-install after changing a <code class="docutils literal notranslate"><span class="pre">.py</span></code> or compiled extension file.</p>
<p>When working on a branch that does not have Meson enabled, meaning it does not
have <a class="reference external" href="https://github.com/matplotlib/matplotlib/pull/26621/">PR #26621</a> in its history (log), you will have to reinstall from source
each time you change any compiled extension code.</p>
<p>If the installation is not working, please consult the <a class="reference internal" href="troubleshooting.html#troubleshooting-faq"><span class="std std-ref">troubleshooting guide</span></a>.
If the guide does not offer a solution, please reach out via <a class="reference external" href="https://discourse.matplotlib.org">discourse</a>
or <a class="reference internal" href="index.html#submitting-a-bug-report"><span class="std std-ref">open an issue</span></a>.</p>
<section id="build-options">
<h3><a class="toc-backref" href="#id9" role="doc-backlink">Build options</a><a class="headerlink" href="#build-options" title="Link to this heading">#</a></h3>
<p>If you are working heavily with files that need to be compiled, you may want to
inspect the compilation log. This can be enabled by setting the environment
variable <span class="target" id="index-0"></span><a class="reference external" href="https://mesonbuild.com/meson-python/reference/environment-variables.html#envvar-MESONPY_EDITABLE_VERBOSE" title="(in meson-python)"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">MESONPY_EDITABLE_VERBOSE</span></code></a> or by setting the <code class="docutils literal notranslate"><span class="pre">editable-verbose</span></code>
config during installation</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>--no-build-isolation<span class="w"> </span>--config-settings<span class="o">=</span>editable-verbose<span class="o">=</span><span class="nb">true</span><span class="w"> </span>--editable<span class="w"> </span>.
</pre></div>
</div>
<p>For more information on installation and other configuration options, see the
Meson Python <a class="reference external" href="https://mesonbuild.com/meson-python/how-to-guides/editable-installs.html#how-to-guides-editable-installs" title="(in meson-python)"><span class="xref std std-ref">editable installs guide</span></a>.</p>
<p>For a list of the other environment variables you can set before install, see <a class="reference internal" href="../install/environment_variables_faq.html#environment-variables"><span class="std std-ref">Environment variables</span></a>.</p>
</section>
</section>
<section id="verify-the-installation">
<h2><a class="toc-backref" href="#id10" role="doc-backlink">Verify the Installation</a><a class="headerlink" href="#verify-the-installation" title="Link to this heading">#</a></h2>
<p>Run the following command to make sure you have correctly installed Matplotlib in
editable mode. The command should be run when the virtual environment is activated:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-c<span class="w"> </span><span class="s2">"import matplotlib; print(matplotlib.__file__)"</span>
</pre></div>
</div>
<p>This command should return : <code class="docutils literal notranslate"><span class="pre"><matplotlib_local_repo>\lib\matplotlib\__init__.py</span></code></p>
<p>We encourage you to run tests and build docs to verify that the code installed correctly
and that the docs build cleanly, so that when you make code or document related changes
you are aware of the existing issues beforehand.</p>
<ul class="simple">
<li><p>Run test cases to verify installation <a class="reference internal" href="testing.html#testing"><span class="std std-ref">Testing</span></a></p></li>
<li><p>Verify documentation build <a class="reference internal" href="document.html#documenting-matplotlib"><span class="std std-ref">Write documentation</span></a></p></li>
</ul>
</section>
<section id="install-pre-commit-hooks">
<span id="pre-commit-hooks"></span><h2><a class="toc-backref" href="#id11" role="doc-backlink">Install pre-commit hooks</a><a class="headerlink" href="#install-pre-commit-hooks" title="Link to this heading">#</a></h2>
<p><a class="reference external" href="https://prek.j178.dev/">prek</a> hooks save time in the review process by
identifying issues with the code before a pull request is formally opened. Most
hooks can also aide in fixing the errors, and the checks should have
corresponding <a class="reference internal" href="development_workflow.html#development-workflow"><span class="std std-ref">development workflow</span></a> and
<a class="reference internal" href="pr_guide.html#pr-guidelines"><span class="std std-ref">pull request</span></a> guidelines. Hooks are configured in
<a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/main/.pre-commit-config.yaml?">.pre-commit-config.yaml</a>
and include checks for spelling and formatting, flake 8 conformity, accidentally
committed files, import order, and incorrect branching.</p>
<p>Install pre-commit hooks</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>prek
prek<span class="w"> </span>install
</pre></div>
</div>
<p>Hooks are run automatically after the <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">commit</span></code> stage of the
<a class="reference internal" href="development_workflow.html#edit-flow"><span class="std std-ref">editing workflow</span></a>. When a hook has found and fixed an error in a
file, that file must be <em>staged and committed</em> again.</p>
<p>Hooks can also be run manually. All the hooks can be run, in order as
listed in <code class="docutils literal notranslate"><span class="pre">.pre-commit-config.yaml</span></code>, against the full codebase with</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>prek<span class="w"> </span>run<span class="w"> </span>--all-files
</pre></div>
</div>
<p>To run a particular hook manually, run <code class="docutils literal notranslate"><span class="pre">prek</span> <span class="pre">run</span></code> with the hook id</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>prek<span class="w"> </span>run<span class="w"> </span><hook<span class="w"> </span>id><span class="w"> </span>--all-files
</pre></div>
</div>
<p>Please note that the <code class="docutils literal notranslate"><span class="pre">mypy</span></code> pre-commit hook cannot check the <a class="reference internal" href="coding_guide.html#type-hints"><span class="std std-ref">Type hints</span></a>
for new functions; instead the stubs for new functions are checked using the
<code class="docutils literal notranslate"><span class="pre">stubtest</span></code> <a class="reference internal" href="development_workflow.html#automated-tests"><span class="std std-ref">CI check</span></a> and can be checked locally using
<code class="docutils literal notranslate"><span class="pre">tox</span> <span class="pre">-e</span> <span class="pre">stubtest</span></code>.</p>
</section>
</section>
</article>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#fork-the-matplotlib-repository">Fork the Matplotlib repository</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#set-up-development-environment">Set up development environment</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#create-local-environment">Create local environment</a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#get-most-recent-code">Get most recent code</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#create-a-dedicated-environment">Create a dedicated environment</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#install-external-dependencies">Install external dependencies</a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#create-github-codespace-svg-version-1-1-width-1-0em-height-1-0em-class-sd-octicon-sd-octicon-codespaces-viewbox-0-0-16-16-aria-hidden-true-path-d-m0-11-25c0-966-784-1-75-1-75-1-75h12-5c-966-0-1-75-784-1-75-1-75v3a1-75-1-75-0-0-1-14-25-16h1-75a1-75-1-75-0-0-1-0-14-25zm2-9-5c2-784-2-784-0-3-75-0h8-5c13-216-0-14-784-14-1-75v5a1-75-1-75-0-0-1-1-75-1-75h-8-5a1-75-1-75-0-0-1-2-6-75zm1-75-25a-25-25-0-0-0-25-25v5c0-138-112-25-25-25h8-5a-25-25-0-0-0-25-25v-5a-25-25-0-0-0-25-25zm-2-9-5a-25-25-0-0-0-25-25v3c0-138-112-25-25-25h12-5a-25-25-0-0-0-25-25v-3a-25-25-0-0-0-25-25z-path-path-d-m7-12-75a-75-75-0-0-1-75-75h4-5a-75-75-0-0-1-0-1-5h-4-5a-75-75-0-0-1-75-75zm-4-0a-75-75-0-0-1-75-75h-5a-75-75-0-0-1-0-1-5h-5a-75-75-0-0-1-75-75z-path-svg">Create GitHub Codespace <svg aria-hidden="true" class="sd-octicon sd-octicon-codespaces" height="1.0em" version="1.1" viewbox="0 0 16 16" width="1.0em"><path d="M0 11.25c0-.966.784-1.75 1.75-1.75h12.5c.966 0 1.75.784 1.75 1.75v3A1.75 1.75 0 0 1 14.25 16H1.75A1.75 1.75 0 0 1 0 14.25Zm2-9.5C2 .784 2.784 0 3.75 0h8.5C13.216 0 14 .784 14 1.75v5a1.75 1.75 0 0 1-1.75 1.75h-8.5A1.75 1.75 0 0 1 2 6.75Zm1.75-.25a.25.25 0 0 0-.25.25v5c0 .138.112.25.25.25h8.5a.25.25 0 0 0 .25-.25v-5a.25.25 0 0 0-.25-.25Zm-2 9.5a.25.25 0 0 0-.25.25v3c0 .138.112.25.25.25h12.5a.25.25 0 0 0 .25-.25v-3a.25.25 0 0 0-.25-.25Z"></path><path d="M7 12.75a.75.75 0 0 1 .75-.75h4.5a.75.75 0 0 1 0 1.5h-4.5a.75.75 0 0 1-.75-.75Zm-4 0a.75.75 0 0 1 .75-.75h.5a.75.75 0 0 1 0 1.5h-.5a.75.75 0 0 1-.75-.75Z"></path></svg></a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#install-matplotlib-in-editable-mode">Install Matplotlib in editable mode</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#build-options">Build options</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#verify-the-installation">Verify the Installation</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#install-pre-commit-hooks">Install pre-commit hooks</a></li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="copyright">
© Copyright 2002–2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012–2025 The Matplotlib development team.
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Built from v3.10.8-1907-gd5f597d3d.
<br/>
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
</p></div>
</div>
</div>
</footer>
</body>
</html>