pyqtgraph/README.md

85 lines
2.4 KiB
Markdown
Raw Normal View History

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)
[![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
PyQtGraph
=========
A pure-Python graphics library for PyQt/PySide
2013-09-12 06:22:26 +00:00
Copyright 2012 Luke Campagnola, University of North Carolina at Chapel Hill
2013-09-12 06:22:26 +00:00
<http://www.pyqtgraph.org>
Maintainer
----------
2013-09-12 06:22:26 +00:00
* Luke Campagnola <luke.campagnola@gmail.com>
Contributors
------------
2013-09-12 06:22:26 +00:00
* Megan Kratz
* Paul Manis
* Ingo Breßler
* Christian Gavin
* Michael Cristopher Hogg
* Ulrich Leutner
* Felix Schill
* Guillaume Poulin
2013-12-15 16:38:44 +00:00
* Antony Lee
* Mattias Põldaru
* Thomas S.
2014-03-05 16:05:09 +00:00
* Fabio Zadrozny
* Mikhail Terekhov
* Pietro Zambelli
2014-05-08 14:40:58 +00:00
* Stefan Holzmann
* Nicholas TJ
* John David Reaver
* David Kaplan
* Martin Fitzpatrick
* Daniel Lidstrom
2015-07-11 16:32:29 +00:00
* Eric Dill
Requirements
------------
2013-09-12 06:22:26 +00:00
* PyQt 4.7+, PySide, or PyQt5
2013-09-12 06:22:26 +00:00
* python 2.6, 2.7, or 3.x
* NumPy
* For 3D graphics: pyopengl and qt-opengl
2013-09-12 06:22:26 +00:00
* Known to run on Windows, Linux, and Mac.
Support
-------
2013-09-12 06:22:26 +00:00
Post at the [mailing list / forum](https://groups.google.com/forum/?fromgroups#!forum/pyqtgraph)
Installation Methods
--------------------
2013-09-12 06:22:26 +00:00
* To use with a specific project, simply copy the pyqtgraph subdirectory
anywhere that is importable from your project. PyQtGraph may also be
used as a git subtree by cloning the git-core repository from github.
2013-09-12 06:22:26 +00:00
* To install system-wide from source distribution:
`$ python setup.py install`
2014-07-05 15:00:53 +00:00
* For installation packages, see the website (pyqtgraph.org)
* On debian-like systems, pyqtgraph requires the following packages:
python-numpy, python-qt4 | python-pyside
For 3D support: python-opengl, python-qt4-gl | python-pyside.qtopengl
Documentation
-------------
2013-09-12 06:22:26 +00:00
There are many examples; run `python -m pyqtgraph.examples` for a menu.
Some (incomplete) documentation exists at this time.
* Easiest place to get documentation is at <http://www.pyqtgraph.org/documentation>
* If you acquired this code as a .tar.gz file from the website, then you can also look in
doc/html.
2013-09-12 06:22:26 +00:00
* If you acquired this code via GitHub, then you can build the documentation using sphinx.
From the documentation directory, run:
`$ make html`
2013-09-12 06:22:26 +00:00
Please feel free to pester Luke or post to the forum if you need a specific
section of documentation to be expanded.