pyqtgraph/README.md
Ogi Moore 2203933393
Declare scipy optional (#1067)
* Replace use of scipy.random with numpy.random

* Update README to reflect scipy being an optional depenency
2019-11-12 09:02:08 -08:00

3.8 KiB

Build Status

PyQtGraph

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

Copyright 2019 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

  • PyQt 4.8+, PySide, PyQt5, or PySide2
  • python 2.7, or 3.x
  • Required
    • numpy
  • Optional
    • scipy for image processing
    • pyopengl for 3D graphics
      • macOS with Python2 and Qt4 bindings (PyQt4 or PySide) do not work with 3D OpenGL graphics
      • pyqtgraph.opengl will be depreciated in a future version and replaced with VisPy
    • hdf5 for large hdf5 binary format support
  • Known to run on Windows, Linux, and macOS.

Qt Bindings Test Matrix

Below is a table of the configurations we test and have confidence pyqtgraph will work with. All current operating major operating systems (Windows, macOS, Linux) are tested against this configuration. We recommend using the Qt 5.12 or 5.9 (either PyQt5 or PySide2) bindings.

Python Version PyQt4 PySide PyQt5-5.6 PySide2-5.6 PyQt5-5.9 PySide2-5.9 PyQt5-5.12 PySide2 5.12
2.7
3.5
3.6
3.7
  • pyqtgraph has had some incompatabilities with PySide2-5.6, and we recommend you avoid those bindings if possible
  • on macOS with Python 2.7 and Qt4 bindings (PyQt4 or PySide) the openGL related visualizations do not work

Support

Installation Methods

  • From PyPI:
    • Last released version: pip install pyqtgraph
    • Latest development version: pip install git+https://github.com/pyqtgraph/pyqtgraph@develop
  • From conda
    • Last released version: conda install 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.
  • For installation packages, see the website (pyqtgraph.org)

Documentation

The easiest way to learn pyqtgraph is to browse through the examples; run python -m pyqtgraph.examples for a menu.

The official documentation lives at http://pyqtgraph.org/documentation