pyqtgraph/README.md

[![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)

PyQtGraph
=========

A pure-Python graphics library for PyQt/PySide

Copyright 2012 Luke Campagnola, University of North Carolina at Chapel Hill

<http://www.pyqtgraph.org>

Maintainer
----------

  * Luke Campagnola   <luke.campagnola@gmail.com>

Contributors
------------

  * Megan Kratz
  * Paul Manis
  * Ingo Breßler
  * Christian Gavin
  * Michael Cristopher Hogg
  * Ulrich Leutner
  * Felix Schill
  * Guillaume Poulin
  * Antony Lee
  * Mattias Põldaru
  * Thomas S.
  * Fabio Zadrozny
  * Mikhail Terekhov
  * Pietro Zambelli
  * Stefan Holzmann
  * Nicholas TJ
  * John David Reaver
  * David Kaplan
  * Martin Fitzpatrick
  * Daniel Lidstrom
  * Eric Dill

Requirements
------------

  * PyQt 4.7+, PySide, or PyQt5
  * python 2.6, 2.7, or 3.x
  * NumPy
  * For 3D graphics: pyopengl and qt-opengl
  * Known to run on Windows, Linux, and Mac.

Support
-------

  Post at the [mailing list / forum](https://groups.google.com/forum/?fromgroups#!forum/pyqtgraph)

Installation Methods
--------------------

  * 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.
  * To install system-wide from source distribution:
        `$ python setup.py install`
  * 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
-------------

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.
  * If you acquired this code via GitHub, then you can build the documentation using sphinx.
      From the documentation directory, run:
          `$ make html`
  
Please feel free to pester Luke or post to the forum if you need a specific
  section of documentation to be expanded.
DOC: Add a travis and codecov badges 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)`
DOC: I should, uh, badge this repo correctly... 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)`
DOC: Add a travis and codecov badges 2015-07-28 17:03:27 +00:00
Convert README to markdown for better github presentation 2013-09-12 06:01:52 +00:00			`PyQtGraph`
			`=========`

			`A pure-Python graphics library for PyQt/PySide`
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			`Copyright 2012 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
			`Maintainer`
			`----------`
Update README.md correct markdown 2013-09-12 06:22:26 +00:00
Make setPen() methods more consistent throughout the package. Merge remote-tracking branch 'termim/develop' into develop Conflicts: pyqtgraph/graphicsItems/ROI.py 2014-03-01 14:37:59 +00:00			`* Luke Campagnola <luke.campagnola@gmail.com>`
Convert README to markdown for better github presentation 2013-09-12 06:01:52 +00:00
			`Contributors`
			`------------`
Update README.md correct markdown 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`
Updated contributors list 2013-12-15 16:38:44 +00:00			`* Antony Lee`
Fixed AxisItem to support unicode in tick strings 2013-12-29 14:17:23 +00:00			`* Mattias Põldaru`
doc corrections update contributors list 2014-03-01 02:09:03 +00:00			`* Thomas S.`
corrected contributors list 2014-03-05 16:05:09 +00:00			`* Fabio Zadrozny`
Make setPen() methods more consistent throughout the package. Merge remote-tracking branch 'termim/develop' into develop Conflicts: pyqtgraph/graphicsItems/ROI.py 2014-03-01 14:37:59 +00:00			`* Mikhail Terekhov`
Ignore NaN when checking data range in ImageView. Merge remote-tracking branch 'zarch/bottleneck_range' into develop 2014-03-06 20:30:36 +00:00			`* Pietro Zambelli`
Update contrib list 2014-05-08 14:40:58 +00:00			`* Stefan Holzmann`
Merge remote-tracking branch 'nicolaisi/ntj01' into develop 2014-10-25 18:24:15 +00:00			`* Nicholas TJ`
			`* John David Reaver`
Merge branch 'flowchart-node-menus' into develop 2014-11-14 13:12:33 +00:00			`* David Kaplan`
Added more examples to menu Minor edits 2015-03-01 21:52:15 +00:00			`* Martin Fitzpatrick`
Merge branch 'lidstrom83-DockArea_apoptose_fix' into develop Also corrected temporary container persisting after calling dockarea.addDock() 2015-03-14 19:49:45 +00:00			`* Daniel Lidstrom`
contrib update 2015-07-11 16:32:29 +00:00			`* Eric Dill`
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
Added more examples to menu Minor edits 2015-03-01 21:52:15 +00:00			`* PyQt 4.7+, PySide, or PyQt5`
Update README.md correct markdown 2013-09-12 06:22:26 +00:00			`* python 2.6, 2.7, or 3.x`
DOC: I should, uh, badge this repo correctly... 2015-07-31 19:37:47 +00:00			`* NumPy`
Update README to reflect loss of scipy dependency 2014-03-14 18:11:53 +00:00			`* For 3D graphics: pyopengl and qt-opengl`
Update README.md correct markdown 2013-09-12 06:22:26 +00:00			`* Known to run on Windows, Linux, and Mac.`
Convert README to markdown for better github presentation 2013-09-12 06:01:52 +00:00
			`Support`
			`-------`
Update README.md correct markdown 2013-09-12 06:22:26 +00:00
			`Post at the [mailing list / forum](https://groups.google.com/forum/?fromgroups#!forum/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
			`* To use with a specific project, simply copy the pyqtgraph subdirectory`
Fixed AxisItem to support unicode in tick strings 2013-12-29 14:17:23 +00:00			`anywhere that is importable from your project. PyQtGraph may also be`
			`used as a git subtree by cloning the git-core repository from github.`
Update README.md correct markdown 2013-09-12 06:22:26 +00:00			`* To install system-wide from source distribution:`
			`$ python setup.py install`
Fixed typo in readme 2014-07-05 15:00:53 +00:00			`* For installation packages, see the website (pyqtgraph.org)`
Update README to reflect loss of scipy dependency 2014-03-14 18:11:53 +00:00			`* 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`
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
			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`
Convert README to markdown for better github presentation 2013-09-12 06:01:52 +00:00			`doc/html.`
Update README.md correct markdown 2013-09-12 06:22:26 +00:00			`* If you acquired this code via GitHub, then you can build the documentation using sphinx.`
Convert README to markdown for better github presentation 2013-09-12 06:01:52 +00:00			`From the documentation directory, run:`
			`$ make html`
Update README.md correct markdown 2013-09-12 06:22:26 +00:00
			`Please feel free to pester Luke or post to the forum if you need a specific`
Fixed AxisItem to support unicode in tick strings 2013-12-29 14:17:23 +00:00			`section of documentation to be expanded.`