pyqtgraph/README.md

PyQtGraph
=========

[![PyPi](https://img.shields.io/pypi/v/pyqtgraph.svg)](https://pypi.org/project/pyqtgraph/)
[![conda-forge](https://img.shields.io/conda/vn/conda-forge/pyqtgraph.svg)](https://anaconda.org/conda-forge/pyqtgraph)
[![Build Status](https://github.com/pyqtgraph/pyqtgraph/workflows/main/badge.svg)](https://github.com/pyqtgraph/pyqtgraph/actions/?query=workflow%3Amain)
[![CodeQL Status](https://github.com/pyqtgraph/pyqtgraph/workflows/codeql/badge.svg)](https://github.com/pyqtgraph/pyqtgraph/actions/?query=workflow%3Acodeql)
[![Documentation Status](https://readthedocs.org/projects/pyqtgraph/badge/?version=latest)](https://pyqtgraph.readthedocs.io/en/latest/?badge=latest)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/pyqtgraph/pyqtgraph.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/pyqtgraph/pyqtgraph/alerts/)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/pyqtgraph/pyqtgraph.svg?logo=lgtm&logoWidth=18)](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
* Required
  * [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.17+

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`](https://github.com/scipy/scipy)                | <ul><li> Image processing through [`ndimage`](https://docs.scipy.org/doc/scipy/reference/ndimage.html)</li><li> Data array filtering through [`signal`](https://docs.scipy.org/doc/scipy/reference/signal.html) </li><ul> |
| [`pyopengl`](https://github.com/mcfletch/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`](https://github.com/h5py/h5py)                   | <ul><li> Export in hdf5 format </li></ul>                                                                                                                                                                                 |
| [`colorcet`](https://github.com/holoviz/colorcet)        | <ul><li> Add a collection of perceptually uniform colormaps </li></ul>                                                                                                                                                    |
| [`matplotlib`](https://github.com/matplotlib/matplotlib) | <ul><li> Export of PlotItem in matplotlib figure </li><li> Add matplotlib collection of colormaps </li></ul>                                                                                                              |
| [`cupy`](https://docs.cupy.dev/en/stable/install.html)   | <ul><li> CUDA-enhanced image processing </li><li> Note: On Windows, CUDA toolkit must be >= 11.1 </li></ul>                                                                                                               |
| [`numba`](https://github.com/numba/numba)                | <ul><li> Faster image processing </li></ul>                                                                                                                                                                               |

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!
Convert README to markdown for better github presentation 2013-09-12 06:01:52 +00:00			`PyQtGraph`
			`=========`

Add more badges 2020-12-23 05:29:39 +00:00			`[![PyPi](https://img.shields.io/pypi/v/pyqtgraph.svg)](https://pypi.org/project/pyqtgraph/)`
			`[![conda-forge](https://img.shields.io/conda/vn/conda-forge/pyqtgraph.svg)](https://anaconda.org/conda-forge/pyqtgraph)`
Remove linting check, add pytest test publishing (#1477) 2020-12-24 07:04:30 +00:00			`[![Build Status](https://github.com/pyqtgraph/pyqtgraph/workflows/main/badge.svg)](https://github.com/pyqtgraph/pyqtgraph/actions/?query=workflow%3Amain)`
			`[![CodeQL Status](https://github.com/pyqtgraph/pyqtgraph/workflows/codeql/badge.svg)](https://github.com/pyqtgraph/pyqtgraph/actions/?query=workflow%3Acodeql)`
Add more badges 2020-12-23 05:29:39 +00:00			`[![Documentation Status](https://readthedocs.org/projects/pyqtgraph/badge/?version=latest)](https://pyqtgraph.readthedocs.io/en/latest/?badge=latest)`
			`[![Total alerts](https://img.shields.io/lgtm/alerts/g/pyqtgraph/pyqtgraph.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/pyqtgraph/pyqtgraph/alerts/)`
			`[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/pyqtgraph/pyqtgraph.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/pyqtgraph/pyqtgraph/context:python)`

add PyQt6 to CI skip tests that don't work for Qt6 add Qt6 and remove Qt4 from test_examples.py update README.md switch mouse tests to use QPointF this eliminates all the special casing for different bindings 2021-01-18 04:38:28 +00:00			`A pure-Python graphics library for PyQt5/PyQt6/PySide2/PySide6`
Update README.md correct markdown 2013-09-12 06:22:26 +00:00
Update README for 0.11 release 2020-06-07 03:34:21 +00:00			`Copyright 2020 Luke Campagnola, University of North Carolina at Chapel Hill`
Update README.md correct markdown 2013-09-12 06:22:26 +00:00
			`<http://www.pyqtgraph.org>`
Convert README to markdown for better github presentation 2013-09-12 06:01:52 +00:00
Clean up README Removed contributor list; the actual list of contributors is way too long to hold here :D 2018-04-25 23:55:10 +00:00			`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.`
Update README.md correct markdown 2013-09-12 06:22:26 +00:00
Convert README to markdown for better github presentation 2013-09-12 06:01:52 +00:00			`Requirements`
			`------------`
Update README.md correct markdown 2013-09-12 06:22:26 +00:00
Iterative improvement of the README file Replace "pyqtgraph" by "PyQtGraph". Replace the optional libraries list by an "Optional added functionalities" section. More precise on the role of each optional library. Add numba in optional library. 2021-06-29 09:26:51 +00:00			`PyQtGraph has adopted [NEP 29](https://numpy.org/neps/nep-0029-deprecation_policy.html).`
MAINT: Post 0.11.1 release, drop py2, qt4 (#1473) * MAINT: Post 0.11.1 release, drop py2, qt4 This focuses on distribution, tests, and docs. This may not be comprehensive, but covers the cases I found by looking and a few greps Noteably, this does not change any actual internal code yet, to avoid merge conflicts with pending PRs. * NEP 29 language/versions 2020-12-22 18:25:06 +00:00
			`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.`
Remove Qt 6.0 support Simplify some PyQt6 code branches 2021-06-06 01:22:10 +00:00			`* All Qt5 versions from 5.12-5.15, and Qt6 6.1`
MAINT: Post 0.11.1 release, drop py2, qt4 (#1473) * MAINT: Post 0.11.1 release, drop py2, qt4 This focuses on distribution, tests, and docs. This may not be comprehensive, but covers the cases I found by looking and a few greps Noteably, this does not change any actual internal code yet, to avoid merge conflicts with pending PRs. * NEP 29 language/versions 2020-12-22 18:25:06 +00:00
			`Currently this means:`

			`* Python 3.7+`
Remove Qt 6.0 support Simplify some PyQt6 code branches 2021-06-06 01:22:10 +00:00			`* Qt 5.12-5.15, 6.1`
README and CONTRIBUTING update 2019-06-11 05:24:53 +00:00			`* Required`
Update README Add matplotlib as optional library. Replace hdf5 by h5py. Add links towards the github page or website of the different linraries. 2021-06-28 07:24:55 +00:00			`* [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.17+
Iterative improvement of the README file Replace "pyqtgraph" by "PyQtGraph". Replace the optional libraries list by an "Optional added functionalities" section. More precise on the role of each optional library. Add numba in optional library. 2021-06-29 09:26:51 +00:00
			`Optional added functionalities`
			`------------------------------`

			`Through 3rd part libraries, additional functionality may be added to PyQtGraph, see the table below for a summary.`

			`\| Library \| Added functionality \|`
			`\|----------------------------------------------------------\|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:\|`
Modify optional libraries style 2021-06-30 07:02:24 +00:00			\| [`scipy`](https://github.com/scipy/scipy) \| <ul><li> Image processing through [`ndimage`](https://docs.scipy.org/doc/scipy/reference/ndimage.html)</li><li> Data array filtering through [`signal`](https://docs.scipy.org/doc/scipy/reference/signal.html) </li><ul> \|
			\| [`pyopengl`](https://github.com/mcfletch/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`](https://github.com/h5py/h5py) \| <ul><li> Export in hdf5 format </li></ul> \|
			\| [`colorcet`](https://github.com/holoviz/colorcet) \| <ul><li> Add a collection of perceptually uniform colormaps </li></ul> \|
			\| [`matplotlib`](https://github.com/matplotlib/matplotlib) \| <ul><li> Export of PlotItem in matplotlib figure </li><li> Add matplotlib collection of colormaps </li></ul> \|
			\| [`cupy`](https://docs.cupy.dev/en/stable/install.html) \| <ul><li> CUDA-enhanced image processing </li><li> Note: On Windows, CUDA toolkit must be >= 11.1 </li></ul> \|
			\| [`numba`](https://github.com/numba/numba) \| <ul><li> Faster image processing </li></ul> \|
README and CONTRIBUTING update 2019-06-11 05:24:53 +00:00
			`Qt Bindings Test Matrix`
			`-----------------------`

README.md : update support matrix 2021-01-20 04:41:29 +00:00			`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.`
README and CONTRIBUTING update 2019-06-11 05:24:53 +00:00
Update README 2020-12-22 20:16:05 +00:00			`\| Qt-Bindings \| Python 3.7 \| Python 3.8 \| Python 3.9 \|`
MAINT: Post 0.11.1 release, drop py2, qt4 (#1473) * MAINT: Post 0.11.1 release, drop py2, qt4 This focuses on distribution, tests, and docs. This may not be comprehensive, but covers the cases I found by looking and a few greps Noteably, this does not change any actual internal code yet, to avoid merge conflicts with pending PRs. * NEP 29 language/versions 2020-12-22 18:25:06 +00:00			`\| :------------- \| :----------------: \| :----------------: \| :----------------: \|`
Update README 2020-12-22 20:16:05 +00:00			`\| PySide2-5.12 \| :white_check_mark: \| :x: \| :x: \|`
Update README table show not-supported configs 2021-04-16 06:05:38 +00:00			`\| PyQt5-5.12 \| :white_check_mark: \| \| :x: \|`
			`\| PySide2-5.15 \| \| :white_check_mark: \| \|`
			`\| PyQt5-5.15 \| \| :white_check_mark: \| \|`
Remove Qt 6.0 support Simplify some PyQt6 code branches 2021-06-06 01:22:10 +00:00			`\| PySide6-6.1 \| \| \| :white_check_mark: \|`
			`\| PyQt6-6.1 \| \| \| :white_check_mark: \|`
Update README table show not-supported configs 2021-04-16 06:05:38 +00:00
			`* :x: - Not compatible`
			`* :white_check_mark: - Tested`
Convert README to markdown for better github presentation 2013-09-12 06:01:52 +00:00
			`Support`
			`-------`
Add missing project URL for neurotic to README, add ephyviewer (#1633) * Add missing project URL for neurotic to README * Add ephyviewer to project list in README 2021-03-14 15:49:52 +00:00
Create tox configuration, update README accordingly. 2019-05-23 05:07:30 +00:00			`* 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)`
Convert README to markdown for better github presentation 2013-09-12 06:01:52 +00:00
			`Installation Methods`
			`--------------------`
Update README.md correct markdown 2013-09-12 06:22:26 +00:00
Create tox configuration, update README accordingly. 2019-05-23 05:07:30 +00:00			`* From PyPI:`
			* Last released version: `pip install pyqtgraph`
Update README for 0.11 release 2020-06-07 03:34:21 +00:00			* Latest development version: `pip install git+https://github.com/pyqtgraph/pyqtgraph@master`
README and CONTRIBUTING update 2019-06-11 05:24:53 +00:00			`* From conda`
Update README for 0.11 release 2020-06-07 03:34:21 +00:00			* Last released version: `conda install -c conda-forge pyqtgraph`
add pip/git install method to README 2018-07-10 23:14:59 +00:00			* To install system-wide from source distribution: `python setup.py install`
			`* Many linux package repositories have release versions.`
Iterative improvement of the README file Replace "pyqtgraph" by "PyQtGraph". Replace the optional libraries list by an "Optional added functionalities" section. More precise on the role of each optional library. Add numba in optional library. 2021-06-29 09:26:51 +00:00			`* To use with a specific project, simply copy the PyQtGraph subdirectory`
Create tox configuration, update README accordingly. 2019-05-23 05:07:30 +00:00			`anywhere that is importable from your project.`
Convert README to markdown for better github presentation 2013-09-12 06:01:52 +00:00
			`Documentation`
			`-------------`
Update README.md correct markdown 2013-09-12 06:22:26 +00:00
Remove linting check, add pytest test publishing (#1477) 2020-12-24 07:04:30 +00:00			`The official documentation lives at [pyqtgraph.readthedocs.io](https://pyqtgraph.readthedocs.io)`
Update README for 0.11 release 2020-06-07 03:34:21 +00:00
Iterative improvement of the README file Replace "pyqtgraph" by "PyQtGraph". Replace the optional libraries list by an "Optional added functionalities" section. More precise on the role of each optional library. Add numba in optional library. 2021-06-29 09:26:51 +00:00			The easiest way to learn PyQtGraph is to browse through the examples; run `python -m pyqtgraph.examples` to launch the examples application.
Add used by in readme (#1626) * Add projects with links that use pyqtgraph * Add existing projects to README.md 2021-03-08 17:22:13 +00:00
			`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/)`
Add missing project URL for neurotic to README, add ephyviewer (#1633) * Add missing project URL for neurotic to README * Add ephyviewer to project list in README 2021-03-14 15:49:52 +00:00			`* [neurotic](https://neurotic.readthedocs.io)`
			`* [ephyviewer](https://ephyviewer.readthedocs.io)`
Add used by in readme (#1626) * Add projects with links that use pyqtgraph * Add existing projects to README.md 2021-03-08 17:22:13 +00:00			`* [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!`