README.md
1PyQtGraph
2=========
3
4[](https://pypi.org/project/pyqtgraph/)
5[](https://anaconda.org/conda-forge/pyqtgraph)
6[](https://github.com/pyqtgraph/pyqtgraph/actions/?query=workflow%3Amain)
7[](https://github.com/pyqtgraph/pyqtgraph/actions/?query=workflow%3Acodeql)
8[](https://pyqtgraph.readthedocs.io/en/latest/?badge=latest)
9[](https://lgtm.com/projects/g/pyqtgraph/pyqtgraph/alerts/)
10[](https://lgtm.com/projects/g/pyqtgraph/pyqtgraph/context:python)
11
12A pure-Python graphics library for PyQt5/PyQt6/PySide2/PySide6
13
14Copyright 2020 Luke Campagnola, University of North Carolina at Chapel Hill
15
16<http://www.pyqtgraph.org>
17
18PyQtGraph is intended for use in mathematics / scientific / engineering applications.
19Despite being written entirely in python, the library is fast due to its
20heavy leverage of numpy for number crunching, Qt's GraphicsView framework for
212D display, and OpenGL for 3D display.
22
23Requirements
24------------
25
26PyQtGraph has adopted [NEP 29](https://numpy.org/neps/nep-0029-deprecation_policy.html).
27
28This project supports:
29
30* All minor versions of Python released 42 months prior to the project, and at minimum the two latest minor versions.
31* All minor versions of numpy released in the 24 months prior to the project, and at minimum the last three minor versions.
32* All Qt5 versions from 5.12-5.15, and Qt6 6.1
33
34Currently this means:
35
36* Python 3.7+
37* Qt 5.12-5.15, 6.1
38* [PyQt5](https://www.riverbankcomputing.com/software/pyqt/),
39 [PyQt6](https://www.riverbankcomputing.com/software/pyqt/),
40 [PySide2](https://wiki.qt.io/Qt_for_Python), or
41 [PySide6](https://wiki.qt.io/Qt_for_Python)
42* [`numpy`](https://github.com/numpy/numpy) 1.18+
43
44### Optional added functionalities
45
46Through 3rd part libraries, additional functionality may be added to PyQtGraph, see the table below for a summary.
47
48| Library | Added functionality |
49|----------------|-|
50| [`scipy`] | <ul><li> Image processing through [`ndimage`]</li><li> Data array filtering through [`signal`] </li><ul> |
51| [`pyopengl`] | <ul><li> 3D graphics </li><li> Faster image processing </li><li>Note: on macOS Big Sur only works with python 3.9.1+</li></ul> |
52| [`h5py`] | <ul><li> Export in hdf5 format </li></ul> |
53| [`colorcet`] | <ul><li> Add a collection of perceptually uniform colormaps </li></ul> |
54| [`matplotlib`] | <ul><li> Export of PlotItem in matplotlib figure </li><li> Add matplotlib collection of colormaps </li></ul> |
55| [`cupy`] | <ul><li> CUDA-enhanced image processing </li><li> Note: On Windows, CUDA toolkit must be >= 11.1 </li></ul> |
56| [`numba`] | <ul><li> Faster image processing </li></ul> |
57
58[`scipy`]: https://github.com/scipy/scipy
59[`ndimage`]: https://docs.scipy.org/doc/scipy/reference/ndimage.html
60[`signal`]: https://docs.scipy.org/doc/scipy/reference/signal.html
61[`pyopengl`]: https://github.com/mcfletch/pyopengl
62[`h5py`]: https://github.com/h5py/h5py
63[`colorcet`]: https://github.com/holoviz/colorcet
64[`matplotlib`]: https://github.com/matplotlib/matplotlib
65[`numba`]: https://github.com/numba/numba
66[`cupy`]: https://docs.cupy.dev/en/stable/install.html
67
68Qt Bindings Test Matrix
69-----------------------
70
71The following table represents the python environments we test in our CI system. Our CI system uses Ubuntu 20.04, Windows Server 2019, and macOS 10.15 base images.
72
73| Qt-Bindings | Python 3.7 | Python 3.8 | Python 3.9 |
74| :------------- | :----------------: | :----------------: | :----------------: |
75| PySide2-5.12 | :white_check_mark: | :x: | :x: |
76| PyQt5-5.12 | :white_check_mark: | | :x: |
77| PySide2-5.15 | | :white_check_mark: | |
78| PyQt5-5.15 | | :white_check_mark: | |
79| PySide6-6.1 | | | :white_check_mark: |
80| PyQt6-6.1 | | | :white_check_mark: |
81
82* :x: - Not compatible
83* :white_check_mark: - Tested
84
85Support
86-------
87
88* Report issues on the [GitHub issue tracker](https://github.com/pyqtgraph/pyqtgraph/issues)
89* Post questions to the [mailing list / forum](https://groups.google.com/forum/?fromgroups#!forum/pyqtgraph) or [StackOverflow](https://stackoverflow.com/questions/tagged/pyqtgraph)
90
91Installation Methods
92--------------------
93
94* From PyPI:
95 * Last released version: `pip install pyqtgraph`
96 * Latest development version: `pip install git+https://github.com/pyqtgraph/pyqtgraph@master`
97* From conda
98 * Last released version: `conda install -c conda-forge pyqtgraph`
99* To install system-wide from source distribution: `python setup.py install`
100* Many linux package repositories have release versions.
101* To use with a specific project, simply copy the PyQtGraph subdirectory
102 anywhere that is importable from your project.
103
104Documentation
105-------------
106
107The official documentation lives at [pyqtgraph.readthedocs.io](https://pyqtgraph.readthedocs.io)
108
109The easiest way to learn PyQtGraph is to browse through the examples; run `python -m pyqtgraph.examples` to launch the examples application.
110
111Used By
112-------
113
114Here is a partial listing of some of the applications that make use of PyQtGraph!
115
116* [ACQ4](https://github.com/acq4/acq4)
117* [Orange3](https://orangedatamining.com/)
118* [neurotic](https://neurotic.readthedocs.io)
119* [ephyviewer](https://ephyviewer.readthedocs.io)
120* [Joulescope](https://www.joulescope.com/)
121* [rapidtide](https://rapidtide.readthedocs.io/en/latest/)
122* [argos](https://github.com/titusjan/argos)
123* [PySpectra](http://hasyweb.desy.de/services/computing/Spock/node138.html)
124* [Semi-Supervised Semantic Annotator](https://gitlab.com/ficsresearch/s3ah)
125
126Do you use PyQtGraph in your own project, and want to add it to the list? Submit a pull request to update this listing!
127
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}