Skip to content

Commit f4d9686

Browse files
committed
README.md: add supported Qt bindings
See #20
1 parent 81b28a0 commit f4d9686

File tree

1 file changed

+27
-28
lines changed

1 file changed

+27
-28
lines changed

README.md

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,19 @@
1111

1212
## Overview
1313

14-
`plotpy` is is a Python library providing efficient 2D data-plotting features
15-
for interactive computing and signal/image processing application development.
16-
It is part of the [PlotPyStack](https://github.com/PlotPyStack) project, aiming at
17-
providing a unified framework for creating scientific GUIs with Python and Qt.
14+
`plotpy` is is a Python library providing efficient 2D data-plotting features for interactive computing and signal/image processing application development.
15+
It is part of the [PlotPyStack](https://github.com/PlotPyStack) project, aiming at providing a unified framework for creating scientific GUIs with Python and Qt.
1816

1917
`plotpy` is based on:
2018

21-
* [Python](http://www.python.org) language and [Qt](https://doc.qt.io/) GUI toolkit (via [PySide](https://doc.qt.io/qtforpython-6/) or [PyQt](http://www.riverbankcomputing.co.uk/software/pyqt/intro))
19+
* [Python](http://www.python.org) language and [Qt](https://doc.qt.io/) GUI toolkit
2220
* [guidata](https://pypi.python.org/pypi/guidata) automatic GUI generation library
2321
* [PythonQwt](https://pypi.python.org/pypi/PythonQwt) plotting widgets library
2422
* [NumPy](https://pypi.python.org/pypi/NumPy) and [SciPy](https://pypi.python.org/pypi/SciPy) scientific computing libraries
2523

2624
<img src="https://raw.githubusercontent.com/PlotPyStack/plotpy/master/doc/images/panorama.png">
2725

28-
See [documentation](https://plotpy.readthedocs.io/en/latest/) for more details on
29-
the library and [changelog](https://github.com/PlotPyStack/PlotPy/blob/master/CHANGELOG.md)
30-
for recent history of changes.
26+
See [documentation](https://plotpy.readthedocs.io/en/latest/) for more details on the library and [changelog](https://github.com/PlotPyStack/PlotPy/blob/master/CHANGELOG.md) for recent history of changes.
3127

3228
Copyrights and licensing:
3329

@@ -41,36 +37,39 @@ The `plotpy` library also provides the following features.
4137
General plotting features:
4238

4339
* Ready-to-use [plot widgets and dialog boxes](https://plotpy.readthedocs.io/en/latest/features/plot/index.html)
44-
* [pyplot](https://plotpy.readthedocs.io/en/latest/features/pyplot.html): interactive
45-
plotting widgets, equivalent to `matplotlib.pyplot`, at least for the implemented functions
46-
* Supported [plot items](https://plotpy.readthedocs.io/en/latest/features/items/index.html):
47-
curves, images, contours, histograms, labels, shapes, annotations, ...
40+
* [pyplot](https://plotpy.readthedocs.io/en/latest/features/pyplot.html): interactive plotting widgets, equivalent to `matplotlib.pyplot`, at least for the implemented functions
41+
* Supported [plot items](https://plotpy.readthedocs.io/en/latest/features/items/index.html): curves, images, contours, histograms, labels, shapes, annotations, ...
4842

4943
Interactive features (i.e. not only programmatic plotting but also with mouse/keyboard):
5044

51-
* Multiple object selection for moving objects or editing their properties through
52-
automatically generated dialog boxes
53-
* Item list panel: move objects from foreground to background, show/hide objects,
54-
remove objects, ...
45+
* Multiple object selection for moving objects or editing their properties through automatically generated dialog boxes
46+
* Item list panel: move objects from foreground to background, show/hide objects, remove objects, ...
5547
* Customizable aspect ratio for images
56-
* Tons of ready-to-use tools: plot canvas export to image file, image snapshot,
57-
interval selection, image rectangular filter, etc.
48+
* Tons of ready-to-use tools: plot canvas export to image file, image snapshot, interval selection, image rectangular filter, etc.
5849
* Curve fitting tool with automatic fit, manual fit with sliders, ...
59-
* Contrast adjustment panel for images: select the LUT by moving a range selection
60-
object on the image levels histogram, eliminate outliers, ...
61-
* X-axis and Y-axis cross-sections: support for multiple images, average
62-
cross-section tool on a rectangular area, ...
63-
* Apply any affine transform to displayed images in real-time (rotation,
64-
magnification, translation, horizontal/vertical flip, ...)
50+
* Contrast adjustment panel for images: select the LUT by moving a range selection object on the image levels histogram, eliminate outliers, ...
51+
* X-axis and Y-axis cross-sections: support for multiple images, average cross-section tool on a rectangular area, ...
52+
* Apply any affine transform to displayed images in real-time (rotation, magnification, translation, horizontal/vertical flip, ...)
6553

6654
Application development helpers:
6755

6856
* Ready-to-use [plot widgets and dialog boxes](https://plotpy.readthedocs.io/en/latest/features/plot/index.html)
6957
* Load/save graphical objects (curves, images, shapes) into HDF5, JSON or INI files
70-
* A lot of test scripts which demonstrate `plotpy` features
71-
(see [examples](https://plotpy.readthedocs.io/en/latest/intro/examples.html))
58+
* A lot of test scripts which demonstrate `plotpy` features (see [examples](https://plotpy.readthedocs.io/en/latest/intro/examples.html))
7259

7360
## Dependencies and installation
7461

75-
See [Installation](https://plotpy.readthedocs.io/en/latest/intro/installation.html)
76-
section in the documentation for more details.
62+
### Supported Qt versions and bindings
63+
64+
The whole PlotPyStack set of libraries relies on the [Qt](https://doc.qt.io/) GUI toolkit, thanks to [QtPy](https://pypi.org/project/QtPy/), an abstraction layer which allows to use the same API to interact with different Python-to-Qt bindings (PyQt5, PyQt6, PySide2, PySide6).
65+
66+
Compatibility table:
67+
68+
| PlotPy version | PyQt5 | PyQt6 | PySide2 | PySide6 |
69+
|----------------|-------|-------|---------|---------|
70+
| 2.0-2.5 || ⚠️ || ⚠️ |
71+
| Latest |||||
72+
73+
### Other dependencies and installation
74+
75+
See [Installation](https://plotpy.readthedocs.io/en/latest/intro/installation.html) section in the documentation for more details.

0 commit comments

Comments
 (0)