127 lines
6.3 KiB
Markdown
127 lines
6.3 KiB
Markdown
PyQtGraph
|
|
=========
|
|
|
|
[](https://pypi.org/project/pyqtgraph/)
|
|
[](https://anaconda.org/conda-forge/pyqtgraph)
|
|
[](https://github.com/pyqtgraph/pyqtgraph/actions/?query=workflow%3Amain)
|
|
[](https://github.com/pyqtgraph/pyqtgraph/actions/?query=workflow%3Acodeql)
|
|
[](https://pyqtgraph.readthedocs.io/en/latest/?badge=latest)
|
|
[](https://lgtm.com/projects/g/pyqtgraph/pyqtgraph/alerts/)
|
|
[](https://lgtm.com/projects/g/pyqtgraph/pyqtgraph/context:python)
|
|
|
|
A pure-Python graphics library for PyQt5/PyQt6/PySide2/PySide6
|
|
|
|
Copyright 2020 Luke Campagnola, University of North Carolina at Chapel Hill
|
|
|
|
<http://www.pyqtgraph.org>
|
|
|
|
PyQtGraph is intended for use in mathematics / scientific / engineering applications.
|
|
Despite being written entirely in python, the library is fast due to its
|
|
heavy leverage of numpy for number crunching, Qt's GraphicsView framework for
|
|
2D display, and OpenGL for 3D display.
|
|
|
|
Requirements
|
|
------------
|
|
|
|
PyQtGraph has adopted [NEP 29](https://numpy.org/neps/nep-0029-deprecation_policy.html).
|
|
|
|
This project supports:
|
|
|
|
* All minor versions of Python released 42 months prior to the project, and at minimum the two latest minor versions.
|
|
* All minor versions of numpy released in the 24 months prior to the project, and at minimum the last three minor versions.
|
|
* All Qt5 versions from 5.12-5.15, and Qt6 6.1
|
|
|
|
Currently this means:
|
|
|
|
* Python 3.7+
|
|
* Qt 5.12-5.15, 6.1
|
|
* [PyQt5](https://www.riverbankcomputing.com/software/pyqt/),
|
|
[PyQt6](https://www.riverbankcomputing.com/software/pyqt/),
|
|
[PySide2](https://wiki.qt.io/Qt_for_Python), or
|
|
[PySide6](https://wiki.qt.io/Qt_for_Python)
|
|
* [`numpy`](https://github.com/numpy/numpy) 1.18+
|
|
|
|
### Optional added functionalities
|
|
|
|
Through 3rd part libraries, additional functionality may be added to PyQtGraph, see the table below for a summary.
|
|
|
|
| Library | Added functionality |
|
|
|----------------|-|
|
|
| [`scipy`] | <ul><li> Image processing through [`ndimage`]</li><li> Data array filtering through [`signal`] </li><ul> |
|
|
| [`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> |
|
|
| [`h5py`] | <ul><li> Export in hdf5 format </li></ul> |
|
|
| [`colorcet`] | <ul><li> Add a collection of perceptually uniform colormaps </li></ul> |
|
|
| [`matplotlib`] | <ul><li> Export of PlotItem in matplotlib figure </li><li> Add matplotlib collection of colormaps </li></ul> |
|
|
| [`cupy`] | <ul><li> CUDA-enhanced image processing </li><li> Note: On Windows, CUDA toolkit must be >= 11.1 </li></ul> |
|
|
| [`numba`] | <ul><li> Faster image processing </li></ul> |
|
|
|
|
[`scipy`]: https://github.com/scipy/scipy
|
|
[`ndimage`]: https://docs.scipy.org/doc/scipy/reference/ndimage.html
|
|
[`signal`]: https://docs.scipy.org/doc/scipy/reference/signal.html
|
|
[`pyopengl`]: https://github.com/mcfletch/pyopengl
|
|
[`h5py`]: https://github.com/h5py/h5py
|
|
[`colorcet`]: https://github.com/holoviz/colorcet
|
|
[`matplotlib`]: https://github.com/matplotlib/matplotlib
|
|
[`numba`]: https://github.com/numba/numba
|
|
[`cupy`]: https://docs.cupy.dev/en/stable/install.html
|
|
|
|
Qt Bindings Test Matrix
|
|
-----------------------
|
|
|
|
The 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.
|
|
|
|
| Qt-Bindings | Python 3.7 | Python 3.8 | Python 3.9 |
|
|
| :------------- | :----------------: | :----------------: | :----------------: |
|
|
| PySide2-5.12 | :white_check_mark: | :x: | :x: |
|
|
| PyQt5-5.12 | :white_check_mark: | | :x: |
|
|
| PySide2-5.15 | | :white_check_mark: | |
|
|
| PyQt5-5.15 | | :white_check_mark: | |
|
|
| PySide6-6.1 | | | :white_check_mark: |
|
|
| PyQt6-6.1 | | | :white_check_mark: |
|
|
|
|
* :x: - Not compatible
|
|
* :white_check_mark: - Tested
|
|
|
|
Support
|
|
-------
|
|
|
|
* Report issues on the [GitHub issue tracker](https://github.com/pyqtgraph/pyqtgraph/issues)
|
|
* Post questions to the [mailing list / forum](https://groups.google.com/forum/?fromgroups#!forum/pyqtgraph) or [StackOverflow](https://stackoverflow.com/questions/tagged/pyqtgraph)
|
|
|
|
Installation Methods
|
|
--------------------
|
|
|
|
* From PyPI:
|
|
* Last released version: `pip install pyqtgraph`
|
|
* Latest development version: `pip install git+https://github.com/pyqtgraph/pyqtgraph@master`
|
|
* From conda
|
|
* Last released version: `conda install -c conda-forge pyqtgraph`
|
|
* To install system-wide from source distribution: `python setup.py install`
|
|
* Many linux package repositories have release versions.
|
|
* To use with a specific project, simply copy the PyQtGraph subdirectory
|
|
anywhere that is importable from your project.
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
The official documentation lives at [pyqtgraph.readthedocs.io](https://pyqtgraph.readthedocs.io)
|
|
|
|
The easiest way to learn PyQtGraph is to browse through the examples; run `python -m pyqtgraph.examples` to launch the examples application.
|
|
|
|
Used By
|
|
-------
|
|
|
|
Here is a partial listing of some of the applications that make use of PyQtGraph!
|
|
|
|
* [ACQ4](https://github.com/acq4/acq4)
|
|
* [Orange3](https://orangedatamining.com/)
|
|
* [neurotic](https://neurotic.readthedocs.io)
|
|
* [ephyviewer](https://ephyviewer.readthedocs.io)
|
|
* [Joulescope](https://www.joulescope.com/)
|
|
* [rapidtide](https://rapidtide.readthedocs.io/en/latest/)
|
|
* [argos](https://github.com/titusjan/argos)
|
|
* [PySpectra](http://hasyweb.desy.de/services/computing/Spock/node138.html)
|
|
* [Semi-Supervised Semantic Annotator](https://gitlab.com/ficsresearch/s3ah)
|
|
|
|
Do you use PyQtGraph in your own project, and want to add it to the list? Submit a pull request to update this listing!
|