-
Notifications
You must be signed in to change notification settings - Fork 0
/
installation.html
892 lines (670 loc) · 36.2 KB
/
installation.html
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
<!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>Installation — VisPy</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=26a4bc78f4c0ddb94549" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/style.css?v=7002c910" />
<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" />
<!-- So that users can add custom icons -->
<script src="_static/scripts/fontawesome.js?digest=26a4bc78f4c0ddb94549"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
<script src="_static/documentation_options.js?v=7bdd12f5"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'installation';</script>
<link rel="icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation on Raspberry Pi 3 Model B" href="raspberry.html" />
<link rel="prev" title="Home" href="index.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.14" />
</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="index.html">
<img src="_static/vispy-teaser-short.png" class="logo__image only-light" alt="VisPy - Home"/>
<img src="_static/vispy-teaser-short.png" class="logo__image only-dark pst-js-only" alt="VisPy - Home"/>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item current active">
<a class="nav-link nav-internal" href="#">
Installation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="getting_started/index.html">
Getting Started
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="overview.html">
Documentation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="gallery/index.html">
Gallery
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="api/modules.html">
API
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="news.html">
News
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://github.com/vispy/vispy/blob/main/CODE_OF_CONDUCT.md">
Code of Conduct
</a>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button class="btn search-button-field 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"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</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"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/vispy/vispy" 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-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://twitter.com/vispyproject" title="Twitter" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-twitter fa-lg" aria-hidden="true"></i>
<span class="sr-only">Twitter</span></a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn search-button-field 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"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</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">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item current active">
<a class="nav-link nav-internal" href="#">
Installation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="getting_started/index.html">
Getting Started
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="overview.html">
Documentation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="gallery/index.html">
Gallery
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="api/modules.html">
API
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="news.html">
News
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://github.com/vispy/vispy/blob/main/CODE_OF_CONDUCT.md">
Code of Conduct
</a>
</li>
</ul>
</nav></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"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/vispy/vispy" 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-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://twitter.com/vispyproject" title="Twitter" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-twitter fa-lg" aria-hidden="true"></i>
<span class="sr-only">Twitter</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="raspberry.html">Installation on Raspberry Pi 3 Model B</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></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 active" aria-current="page"><span class="ellipsis">Installation</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Link to this heading">#</a></h1>
<section id="package-requirements">
<h2>Package requirements<a class="headerlink" href="#package-requirements" title="Link to this heading">#</a></h2>
<p>The only mandatory requirement for VisPy is the <a class="reference external" href="http://numpy.org">numpy</a>
package.</p>
</section>
<section id="backend-requirements">
<h2>Backend requirements<a class="headerlink" href="#backend-requirements" title="Link to this heading">#</a></h2>
<p>VisPy requires at least one toolkit for opening a window and creates an OpenGL
context. This can be done using any one of the following.</p>
<div class="pst-scrollable-table-container"><table class="table">
<colgroup>
<col style="width: 25.0%" />
<col style="width: 25.0%" />
<col style="width: 50.0%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Backend</p></th>
<th class="head"><p>Status</p></th>
<th class="head"><p>Dependencies</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>pyqt4</p></td>
<td><p>Stable</p></td>
<td><p>pyqt4</p></td>
</tr>
<tr class="row-odd"><td><p>pyqt5</p></td>
<td><p>Stable</p></td>
<td><p>pyqt5</p></td>
</tr>
<tr class="row-even"><td><p>pyqt6</p></td>
<td><p>Stable</p></td>
<td><p>pyqt6</p></td>
</tr>
<tr class="row-odd"><td><p>pyside</p></td>
<td><p>Stable</p></td>
<td><p>pyside</p></td>
</tr>
<tr class="row-even"><td><p>pyside2</p></td>
<td><p>Stable</p></td>
<td><p>pyside2</p></td>
</tr>
<tr class="row-odd"><td><p>pyside6</p></td>
<td><p>Stable</p></td>
<td><p>pyside6</p></td>
</tr>
<tr class="row-even"><td><p>glfw</p></td>
<td><p>Stable</p></td>
<td><p>glfw (python)</p></td>
</tr>
<tr class="row-odd"><td><p>sdl2</p></td>
<td><p>Stable</p></td>
<td><p>pysdl2 (pysdl2-dll recommended for MacOS/Windows)</p></td>
</tr>
<tr class="row-even"><td><p>wx</p></td>
<td><p>Stable</p></td>
<td><p>wxPython</p></td>
</tr>
<tr class="row-odd"><td><p>pyglet</p></td>
<td><p>Stable</p></td>
<td><p>pyglet</p></td>
</tr>
<tr class="row-even"><td><p>tkinter</p></td>
<td><p>Experimental</p></td>
<td><p>pyopengltk</p></td>
</tr>
</tbody>
</table>
</div>
<p>You can also use a Jupyter notebook with visualizations appearing inline with the <code class="docutils literal notranslate"><span class="pre">jupyter_rfb</span></code> backend (requires <code class="docutils literal notranslate"><span class="pre">jupyter_rfb</span></code> package).</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>You only need to have one of these packages, no need to install them all!</p>
</div>
</section>
<section id="optional-dependencies">
<h2>Optional dependencies<a class="headerlink" href="#optional-dependencies" title="Link to this heading">#</a></h2>
<p>VisPy has various optional dependencies to support features that may not be relevant for all users. The below is a list of dependencies that you may want to install to use the functionality mentioned.</p>
<ul class="simple">
<li><p><strong>pillow</strong>: Pillow (imported as PIL) is used to read image files. Some VisPy examples will use Pillow to load the image data that will then be shown by VisPy.</p></li>
<li><p><strong>triangle</strong>: The <a class="reference external" href="https://www.cs.cmu.edu/~quake/triangle.html">Triangle C package</a> is used via it’s <a class="reference external" href="https://github.com/drufat/triangle">triangle python</a> bindings. Please acknowledge and adhere to the licensing terms of both packages. Within VisPy <cite>triangle</cite>, if installed, is used to calculate a constrained Delaunay triangulation for <cite>PolygonCollections</cite>.</p></li>
</ul>
</section>
<section id="hardware-requirements">
<h2>Hardware requirements<a class="headerlink" href="#hardware-requirements" title="Link to this heading">#</a></h2>
<p>VisPy makes heavy use of the graphic card installed on your system. More
precisely, VisPy uses the Graphical Processing Unit (GPU) through
shaders. VisPy thus requires a fairly recent video card (~ less than 12 years
old) as well as an up-to-date video driver such that vispy can access the
programmable pipeline (as opposed to the fixed pipeline).</p>
<p>To get information on your system, you can type:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">vispy</span><span class="o">.</span><span class="n">sys_info</span><span class="p">())</span>
</pre></div>
</div>
<p>The results of the above command and is long list of information related to
your system and video driver. The OpenGL version must be at least 2.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>On linux systems the <cite>xrandr</cite> command is used to determine the screen’s
DPI. On certain (virtual) displays it reports screen dimensions of
0mm x 0mm. In this case users may attempt to fix their screen resolution
or download the <cite>xdpyinfo</cite> (xorg-xdpyinfo) utility as an alternative to
<cite>xrandr</cite>. A default DPI of 96 is used otherwise.</p>
</div>
</section>
<section id="installation-options">
<h2>Installation options<a class="headerlink" href="#installation-options" title="Link to this heading">#</a></h2>
<p><strong>Before installing VisPy</strong> you should ensure a working version of python is
installed on your computer, including all of the requirements included in the
<strong>Backend Requirements</strong> section above. A simple way to install most of these
requirements is to install the <strong>Anaconda</strong> scientific python distribution
from Continuum Analytics.
<a class="reference external" href="https://www.anaconda.com/download/">Anaconda</a> will
install most of the VisPy dependencies for you. If your computer is low on hard
disk space, or you would like a minimal python installation, you may install
the <a class="reference external" href="https://conda.io/miniconda.html">Miniconda</a> package also from
Continuum Analytics. Once Anaconda is installed, create a
<a class="reference external" href="https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-python.html">conda python environment</a>.</p>
<section id="via-conda">
<h3>Via conda<a class="headerlink" href="#via-conda" title="Link to this heading">#</a></h3>
<p>VisPy can be installed in a conda environment by using the package available
from the <a class="reference external" href="https://conda-forge.org/">conda-forge</a> channel:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">conda install -c conda-forge vispy</span>
</pre></div>
</div>
</section>
<section id="via-pypi">
<h3>Via PyPI<a class="headerlink" href="#via-pypi" title="Link to this heading">#</a></h3>
<p>VisPy can also be installed with <code class="docutils literal notranslate"><span class="pre">pip</span></code> to install it from PyPI:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">pip install --upgrade vispy</span>
</pre></div>
</div>
<p>Once the python dependencies have been installed, install the latest
proprietary drivers for your computer’s GPU. Generally these drivers may be
downloaded from the GPU manufacturer’s website.</p>
</section>
<section id="via-github">
<span id="dev-install"></span><h3>Via GitHub<a class="headerlink" href="#via-github" title="Link to this heading">#</a></h3>
<p><strong>If you want to run the latest development version</strong>, you can clone the
repository to your local machine and install vispy in “development” mode.
This means that any changes to the cloned repository will be immediately
available in the python environment:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>creates<span class="w"> </span><span class="s2">"vispy"</span><span class="w"> </span>folder
<span class="go">git clone git://github.com/vispy/vispy.git</span>
<span class="go">cd vispy</span>
<span class="gp"># </span>install<span class="w"> </span>the<span class="w"> </span>vispy<span class="w"> </span>package<span class="w"> </span><span class="k">in</span><span class="w"> </span>editable/development<span class="w"> </span>mode
<span class="go">pip install -e .</span>
</pre></div>
</div>
<p>To run the latest development version without cloning the repository, you
can also use this line:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">pip install git+https://github.com/vispy/vispy.git</span>
</pre></div>
</div>
</section>
<section id="via-test-pypi">
<h3>Via Test PyPI<a class="headerlink" href="#via-test-pypi" title="Link to this heading">#</a></h3>
<p>The VisPy project uploads the latest development version of the package to
test.pypi.org. This can be a good alternative to the above GitHub installation
process if you don’t have or don’t want to use git.</p>
<p>You can install these versions of the package by doing:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">pip install --pre -i https://test.pypi.org/simple/ vispy</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The main portion of the version number is based on the last public
release of VisPy so the Test PyPI package may be smaller than when
the final package is released.</p>
</div>
</section>
<section id="jupyter-notebook-and-lab">
<h3>Jupyter Notebook and Lab<a class="headerlink" href="#jupyter-notebook-and-lab" title="Link to this heading">#</a></h3>
<p>If you would like to use VisPy in a Jupyter Notebook and have the
visualizations appear inline, we recommend using the “jupyter_rfb” backend.
This backend depends on
<a class="reference external" href="https://jupyter-rfb.readthedocs.io/en/latest/">jupyter_rfb library</a> which
must be installed before your jupyter notebook or jupyter lab session is
started.</p>
<p>Note that the ‘jupyter_rfb’ library uses the “remote” jupyter kernel
(the server) to do the drawing of your visualization and then sends the
results to the client (the browser). This means that performance of animations
and user interactions (mouse and keyboard events) will differ depending on the
connection quality between server and client.</p>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 0.8: </span>The “jupyter_rfb” backend was added in Version 0.8 and the old
“ipynb_webgl” was removed.</p>
</div>
</section>
<section id="testing-installation">
<h3>Testing installation<a class="headerlink" href="#testing-installation" title="Link to this heading">#</a></h3>
<p>It is strongly advised to run the vispy test suite right after installation to
check if everything is ok. To do this, just type:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">vispy</span>
<span class="gp">>>> </span><span class="n">vispy</span><span class="o">.</span><span class="n">test</span><span class="p">()</span>
<span class="gp">...</span>
</pre></div>
</div>
<p>Please note that the test suite may be unstable on some systems. Any potential
instability in the test suite does not necessarily imply instability in the
working state of the provided VisPy examples.</p>
</section>
</section>
<section id="usage-in-an-interactive-console">
<h2>Usage in an interactive console<a class="headerlink" href="#usage-in-an-interactive-console" title="Link to this heading">#</a></h2>
<p>If running from a jupyter console, either the <code class="docutils literal notranslate"><span class="pre">jupyter-qtconsole</span></code>, the
<code class="docutils literal notranslate"><span class="pre">jupyter-console</span></code>, or, the console within
<a class="reference external" href="https://pythonhosted.org/spyder/">Spyder</a>, you may need to ensure a few
other
<a class="reference external" href="https://ipython.org/ipython-doc/3/interactive/tutorial.html#magic-functions">IPython magic</a>
functions are called prior to using vispy in a given kernel. Before using any
VisPy code, we recommend running the following commands when starting your
python kernel:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="o">%</span><span class="n">gui</span> <span class="n">qt</span>
<span class="gp">>>> </span><span class="c1"># your vispy code</span>
</pre></div>
</div>
<p>Namely, this has the effect of sharing the event loop between application and the interactive
console allowing you use both simultaneously.</p>
</section>
<section id="switchable-graphics">
<h2>Switchable graphics<a class="headerlink" href="#switchable-graphics" title="Link to this heading">#</a></h2>
<p>If your laptop comes with switchable graphics you have to make sure to tell
python to use your graphics card instead of the integrated Intel graphics.
You can identify which graphics card will be used by running:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">vispy</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">vispy</span><span class="o">.</span><span class="n">sys_info</span><span class="p">())</span>
</pre></div>
</div>
<p>and look for Nvidia in the <code class="docutils literal notranslate"><span class="pre">GL</span> <span class="pre">version</span></code>. For example:
<code class="docutils literal notranslate"><span class="pre">GL</span> <span class="pre">version:</span>  <span class="pre">'4.6.0</span> <span class="pre">NVIDIA</span> <span class="pre">390.25'</span></code>.</p>
<section id="windows">
<h3>Windows<a class="headerlink" href="#windows" title="Link to this heading">#</a></h3>
<p>In Windows, you should open the the Nvidia-console and add your specific
python to the list of programs that should use the dedicated graphics card.
Note that this setting is separate for different conda environments so make
sure you have selected the one you are using VisPy with.</p>
</section>
<section id="linux">
<h3>Linux<a class="headerlink" href="#linux" title="Link to this heading">#</a></h3>
<p>On Linux with the proprietary Nvidia graphics drivers, you should run python
with <code class="docutils literal notranslate"><span class="pre">primusrun</span> <span class="pre">python</span> <span class="pre">your_script.py</span></code>.</p>
<p>For use with a Jupyter kernel, say in Spyder or the <code class="docutils literal notranslate"><span class="pre">jupyter-qtconsole</span></code>,
make sure the kernel is started with <code class="docutils literal notranslate"><span class="pre">primusrun</span></code>. For example:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>primusrun<span class="w"> </span>spyder3
</pre></div>
</div>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>primusrun<span class="w"> </span>jupyter-qtconsole
</pre></div>
</div>
</section>
<section id="modifying-default-jupyter-kernel">
<h3>Modifying default jupyter kernel<a class="headerlink" href="#modifying-default-jupyter-kernel" title="Link to this heading">#</a></h3>
<p>If you want the jupyter-qtconsole to always use your Nvidia graphics card,
you can change the parameters in the default kernel. To find the default
kernel, run</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>jupyter<span class="w"> </span>kernelspec<span class="w"> </span>list
</pre></div>
</div>
<p>then edit the <code class="docutils literal notranslate"><span class="pre">kernel.json</span></code> file to include <code class="docutils literal notranslate"><span class="pre">"primusrun",</span></code> as the first
parameter in <code class="docutils literal notranslate"><span class="pre">argv</span></code>. For example:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="nt">"argv"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="s2">"primusrun"</span><span class="p">,</span>
<span class="w"> </span><span class="s2">"python"</span><span class="p">,</span>
<span class="w"> </span><span class="s2">"-m"</span><span class="p">,</span>
<span class="w"> </span><span class="s2">"ipykernel_launcher"</span><span class="p">,</span>
<span class="w"> </span><span class="s2">"-f"</span><span class="p">,</span>
<span class="w"> </span><span class="s2">"{connection_file}"</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">"language"</span><span class="p">:</span><span class="w"> </span><span class="s2">"python"</span><span class="p">,</span>
<span class="w"> </span><span class="nt">"display_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Python 3"</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Using a similar configuration, you could have two kernels configurations, one
for the dedicated graphics card, and one for the integrated graphics.</p>
<p>Spyder has it’s own configuration and I don’t know exactly how to make its
console run with <code class="docutils literal notranslate"><span class="pre">primusrun</span></code> without running <code class="docutils literal notranslate"><span class="pre">primusrun</span> <span class="pre">spyder3</span></code>.</p>
</section>
</section>
<section id="embedded-system-installation">
<h2>Embedded System Installation<a class="headerlink" href="#embedded-system-installation" title="Link to this heading">#</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="raspberry.html">Installation on Raspberry Pi 3 Model B</a></li>
</ul>
</div>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="index.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Home</p>
</div>
</a>
<a class="right-next"
href="raspberry.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Installation on Raspberry Pi 3 Model B</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</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="#package-requirements">Package requirements</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#backend-requirements">Backend requirements</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#optional-dependencies">Optional dependencies</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#hardware-requirements">Hardware requirements</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#installation-options">Installation options</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#via-conda">Via conda</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#via-pypi">Via PyPI</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#via-github">Via GitHub</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#via-test-pypi">Via Test PyPI</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#jupyter-notebook-and-lab">Jupyter Notebook and Lab</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#testing-installation">Testing installation</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#usage-in-an-interactive-console">Usage in an interactive console</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#switchable-graphics">Switchable graphics</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#windows">Windows</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#linux">Linux</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#modifying-default-jupyter-kernel">Modifying default jupyter kernel</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#embedded-system-installation">Embedded System Installation</a></li>
</ul>
</nav></div>
<div class="sidebar-secondary-item">
<div class="tocsection editthispage">
<a href="
https://github.com/vispy/vispy/edit/main/doc/installation.rst">
<i class="fa-solid fa-pencil"></i>
Edit
</a>
</div>
</div>
<div class="sidebar-secondary-item">
<div class="tocsection sourcelink">
<a href="_sources/installation.rst.txt">
<i class="fa-solid fa-file-lines"></i> Show Source
</a>
</div>
</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=26a4bc78f4c0ddb94549"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549"></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 2013-2024, VisPy developers.
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
<br/>
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.0.
</p></div>
</div>
</div>
</footer>
</body>
</html>