2015-07-28 17:03:27 +00:00
[![Build Status ](https://travis-ci.org/pyqtgraph/pyqtgraph.svg?branch=develop )](https://travis-ci.org/pyqtgraph/pyqtgraph)
2015-07-31 19:37:47 +00:00
[![codecov.io ](http://codecov.io/github/pyqtgraph/pyqtgraph/coverage.svg?branch=develop )](http://codecov.io/github/pyqtgraph/pyqtgraph?branch=develop)
2015-07-28 17:03:27 +00:00
2013-09-12 06:01:52 +00:00
PyQtGraph
=========
A pure-Python graphics library for PyQt/PySide
2013-09-12 06:22:26 +00:00
2018-04-25 23:55:10 +00:00
Copyright 2017 Luke Campagnola, University of North Carolina at Chapel Hill
2013-09-12 06:22:26 +00:00
< http: / / www . pyqtgraph . org >
2013-09-12 06:01:52 +00:00
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.
2013-09-12 06:22:26 +00:00
2013-09-12 06:01:52 +00:00
Requirements
------------
2013-09-12 06:22:26 +00:00
2019-05-23 05:07:30 +00:00
* PyQt 4.7+, PySide, PyQt5, or PySide2
* python 2.7, or 3.x
* NumPy
* For 3D graphics: pyopengl and qt-opengl
* Known to run on Windows, Linux, and Mac.
2013-09-12 06:01:52 +00:00
Support
-------
2018-04-25 23:55:10 +00:00
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 )
2013-09-12 06:01:52 +00:00
Installation Methods
--------------------
2013-09-12 06:22:26 +00:00
2019-05-23 05:07:30 +00:00
* From PyPI:
* Last released version: `pip install pyqtgraph`
* Latest development version: `pip install git+https://github.com/pyqtgraph/pyqtgraph`
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.
* To use with a specific project, simply copy the pyqtgraph subdirectory
2019-05-23 05:07:30 +00:00
anywhere that is importable from your project.
2018-07-10 23:14:59 +00:00
* For installation packages, see the website (pyqtgraph.org)
2013-09-12 06:01:52 +00:00
Documentation
-------------
2013-09-12 06:22:26 +00:00
2018-04-25 23:55:10 +00:00
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
2013-09-12 06:22:26 +00:00
2019-05-23 05:07:30 +00:00
Testing
-------
To test the pyqtgraph library, clone the repository, and run `pytest pyqtgraph` . For more thurough testing, you can use `tox` , however the [tox-conda ](https://github.com/tox-dev/tox-conda ) plugin is required. Running `tox` on its own will run `pytest pyqtgraph -vv` on it's own, however if you want to run a specific test, you can run `tox -- pyqtgraph/exporters/tests/test_svg::test_plotscene` for example.
Dependencies include:
* pytest
* pytest-cov
* pytest-xdist
* tox
* tox-conda