mlpyqtgraph 0.9.1

Matplotlib like plotting with pyqtgraph in python

mlpyqtgraph

mlpyqtgraph enables matplotlib-like plotting with pyqtgraph in existing python programs. It relies on pqthreads to separate mlpyqtgraph's plotting functionality from the existing python program, by separating them in different Qthreads.

Checkout the documentation's introduction for more background information.

Getting started

Installation

First, install mlpyqtgraph like any other python package using pip:

pip install mlpyqtgraph

Detailed installation instructions are found in the documentation.

Usage

To use mlpyqtgraph, decorate your main function with mlpyqtgraph's plotter decorator. This diverts the existing python program into a dedicated thread, while using the main thread solely for plotting with pyqtgraph.

Now you can use mlpyqtgraph's plot functionalities inside your decorated function. A python program that shows a very basic plot could look like this:

import mlpyqtgraph as mpg

@mpg.plotter
def main():
    """ Minimal mlpyqtgraph example """
    mpg.plot(range(5), (1, 3, 2, 0, 5))

if __name__ == '__main__':
    main()

Examples

Please refer to the examples for a few applications of mlpyqtgraph.

Documentation

Check out the documentation! Please note that it's currently still under construction.

Pre-commit hooks

This repository comes with pre-commit hooks, which are stored in .hooks. To enable the hooks issue:

git config --local core.hooksPath .hooks/

License

An MIT style license applies for mlpyqtgraph, see the LICENSE file for more details.