pyqtgraph/README.md

PyQtGraph

A pure-Python graphics library for PyQt/PySide/PyQt5/PySide2

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

• Python 2.7, or 3.x
• Required
  • PyQt 4.8+, PySide, PyQt5, or PySide2
  • numpy
• Optional
  • scipy for image processing
  • pyopengl for 3D graphics
  • hdf5 for large hdf5 binary format support

Qt Bindings Test Matrix

The following table represents the python environments we test in our CI system. Our CI system uses Ubuntu 18.04, Windows Server 2019, and macOS 10.15 base images.

Qt-Bindings	Python 2.7	Python 3.6	Python 3.7	Python 3.8
PyQt-4	✅	❌	❌	❌
PySide1	✅	❌	❌	❌
PyQt5-5.9	❌	✅	❌	❌
PySide2-5.13	❌	❌	✅	❌
PyQt5-Latest	❌	❌	❌	✅
PySide2-Latest	❌	❌	❌	✅

• pyqtgraph has had some incompatibilities with PySide2 versions 5.6-5.11, and we recommend you avoid those versions if possible
• on macOS with Python 2.7 and Qt4 bindings (PyQt4 or PySide) the openGL related visualizations do not work reliably

Support

• Report issues on the GitHub issue tracker
• Post questions to the mailing list / forum or StackOverflow

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 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.