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

Support
-------
  
  * 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)

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

  * From pypi:  
        `pip install pyqtgraph`
  * To use with a specific project, simply copy the pyqtgraph subdirectory
    anywhere that is importable from your project. 
  * To install system-wide from source distribution:
        `$ python setup.py install`
  * 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
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
Clean up README Removed contributor list; the actual list of contributors is way too long to hold here :D 2018-04-25 23:55:10 +00:00			`Copyright 2017 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
Clean up README Removed contributor list; the actual list of contributors is way too long to hold here :D 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.`
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
			`Requirements`
			`------------`
Update README.md correct markdown 2013-09-12 06:22:26 +00:00
update readme / install docs to mention PySide2 2018-05-25 00:16:38 +00:00			`* PyQt 4.7+, PySide, PyQt5, or PySide2`
Clean up README Removed contributor list; the actual list of contributors is way too long to hold here :D 2018-04-25 23:55:10 +00:00			`* python 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`
			`-------`
Clean up README Removed contributor list; the actual list of contributors is way too long to hold here :D 2018-04-25 23:55:10 +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)`
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
Clean up README Removed contributor list; the actual list of contributors is way too long to hold here :D 2018-04-25 23:55:10 +00:00			`* From pypi:`
			`pip install pyqtgraph`
Update README.md correct markdown 2013-09-12 06:22:26 +00:00			`* To use with a specific project, simply copy the pyqtgraph subdirectory`
Clean up README Removed contributor list; the actual list of contributors is way too long to hold here :D 2018-04-25 23:55:10 +00:00			`anywhere that is importable from your project.`
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)`
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
Clean up README Removed contributor list; the actual list of contributors is way too long to hold here :D 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`
Update README.md correct markdown 2013-09-12 06:22:26 +00:00