From 6dc4d9caabe3f94cd45d5f8cef79cbda2dd1433c Mon Sep 17 00:00:00 2001 From: Pierre Raybaut Date: Mon, 17 Aug 2020 18:00:56 +0200 Subject: [PATCH 1/3] Set theme jekyll-theme-minimal --- _config.yml | 1 + index.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 _config.yml create mode 100644 index.md diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..2f7efbe --- /dev/null +++ b/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-minimal \ No newline at end of file diff --git a/index.md b/index.md new file mode 100644 index 0000000..469353d --- /dev/null +++ b/index.md @@ -0,0 +1,37 @@ +## Welcome to GitHub Pages + +You can use the [editor on GitHub](https://github.com/PierreRaybaut/PythonQwt/edit/gh-pages/index.md) to maintain and preview the content for your website in Markdown files. + +Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files. + +### Markdown + +Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for + +```markdown +Syntax highlighted code block + +# Header 1 +## Header 2 +### Header 3 + +- Bulleted +- List + +1. Numbered +2. List + +**Bold** and _Italic_ and `Code` text + +[Link](url) and ![Image](src) +``` + +For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/). + +### Jekyll Themes + +Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/PierreRaybaut/PythonQwt/settings). The name of this theme is saved in the Jekyll `_config.yml` configuration file. + +### Support or Contact + +Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://github.com/contact) and we’ll help you sort it out. From cdc5f8167b41cec78d6df8153d57799b8da87b3c Mon Sep 17 00:00:00 2001 From: Pierre Raybaut Date: Mon, 17 Aug 2020 18:02:26 +0200 Subject: [PATCH 2/3] Update index.md --- index.md | 125 +++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 104 insertions(+), 21 deletions(-) diff --git a/index.md b/index.md index 469353d..796e780 100644 --- a/index.md +++ b/index.md @@ -1,37 +1,120 @@ -## Welcome to GitHub Pages +# PythonQwt: Qt plotting widgets for Python -You can use the [editor on GitHub](https://github.com/PierreRaybaut/PythonQwt/edit/gh-pages/index.md) to maintain and preview the content for your website in Markdown files. +[![license](https://img.shields.io/pypi/l/PythonQwt.svg)](./LICENSE) +[![pypi version](https://img.shields.io/pypi/v/PythonQwt.svg)](https://pypi.org/project/PythonQwt/) +[![PyPI status](https://img.shields.io/pypi/status/PythonQwt.svg)](https://github.com/PierreRaybaut/PythonQwt) +[![PyPI pyversions](https://img.shields.io/pypi/pyversions/PythonQwt.svg)](https://pypi.python.org/pypi/PythonQwt/) +[![download count](https://img.shields.io/conda/dn/conda-forge/PythonQwt.svg)](https://www.anaconda.com/download/) +[![Documentation Status](https://readthedocs.org/projects/pythonqwt/badge/?version=latest)](https://pythonqwt.readthedocs.io/en/latest/?badge=latest) -Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files. + -### Markdown +The `PythonQwt` project was initiated to solve -at least temporarily- the +obsolescence issue of `PyQwt` (the Python-Qwt C++ bindings library) which is +no longer maintained. The idea was to translate the original Qwt C++ code to +Python and then to optimize some parts of the code by writing new modules +based on NumPy and other libraries. -Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for +The `PythonQwt` package consists of a single Python package named `qwt` and +of a few other files (examples, doc, ...). -```markdown -Syntax highlighted code block +See documentation [online](https://pythonqwt.readthedocs.io/en/latest/) or [PDF](https://pythonqwt.readthedocs.io/_/downloads/en/latest/pdf/) for more details on +the library and [changelog](CHANGELOG.md) for recent history of changes. -# Header 1 -## Header 2 -### Header 3 +## Sample -- Bulleted -- List +```python +import qwt +import numpy as np -1. Numbered -2. List +app = qwt.qt.QtGui.QApplication([]) -**Bold** and _Italic_ and `Code` text +# Create plot widget +plot = qwt.QwtPlot("Trigonometric functions") +plot.insertLegend(qwt.QwtLegend(), qwt.QwtPlot.BottomLegend) -[Link](url) and ![Image](src) +# Create two curves and attach them to plot +x = np.linspace(-10, 10, 500) +qwt.QwtPlotCurve.make(x, np.cos(x), "Cosinus", plot, linecolor="red", antialiased=True) +qwt.QwtPlotCurve.make(x, np.sin(x), "Sinus", plot, linecolor="blue", antialiased=True) + +# Resize and show plot +plot.resize(600, 300) +plot.show() + +app.exec_() +``` + + +## Examples (tests) + +The GUI-based test launcher may be executed from Python: + +```python +from qwt import tests +tests.run() +``` + +or from the command line: + +```bash +PythonQwt-tests +``` + +## Overview + +The `qwt` package is a pure Python implementation of `Qwt` C++ library with +the following limitations. + +The following `Qwt` classes won't be reimplemented in `qwt` because more +powerful features already exist in `guiqwt`: `QwtPlotZoomer`, +`QwtCounter`, `QwtEventPattern`, `QwtPicker`, `QwtPlotPicker`. + +Only the following plot items are currently implemented in `qwt` (the only +plot items needed by `guiqwt`): `QwtPlotItem` (base class), `QwtPlotItem`, +`QwtPlotMarker`, `QwtPlotSeriesItem` and `QwtPlotCurve`. + +See "Overview" section in [documentation](https://pythonqwt.readthedocs.io/en/latest/) +for more details on API limitations when comparing to Qwt. + +## Dependencies + +### Requirements ### +- Python >=2.6 or Python >=3.2 +- PyQt4 >=4.4 or PyQt5 >= 5.5 +- NumPy >= 1.5 + +## Installation + +From the source package: + +```bash +python setup.py install ``` -For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/). +## Copyrights + +#### Main code base +- Copyright © 2002 Uwe Rathmann, for the original Qwt C++ code +- Copyright © 2015 Pierre Raybaut, for the Qwt C++ to Python translation and +optimization +- Copyright © 2015 Pierre Raybaut, for the PythonQwt specific and exclusive +Python material + +#### PyQt, PySide and Python2/Python3 compatibility modules +- Copyright © 2009-2013 Pierre Raybaut +- Copyright © 2013-2015 The Spyder Development Team -### Jekyll Themes +#### Some examples +- Copyright © 2003-2009 Gerard Vermeulen, for the original PyQwt code +- Copyright © 2015 Pierre Raybaut, for the PyQt5/PySide port and further +developments (e.g. ported to PythonQwt API) -Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/PierreRaybaut/PythonQwt/settings). The name of this theme is saved in the Jekyll `_config.yml` configuration file. +## License -### Support or Contact +The `qwt` Python package was partly (>95%) translated from Qwt C++ library: +the associated code is distributed under the terms of the LGPL license. The +rest of the code was either wrote from scratch or strongly inspired from MIT +licensed third-party software. -Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://github.com/contact) and we’ll help you sort it out. +See included [LICENSE](LICENSE) file for more details about licensing terms. From e4395a7cc820f928e179877391fd7c5e4982d726 Mon Sep 17 00:00:00 2001 From: Pierre Raybaut Date: Mon, 17 Aug 2020 18:04:46 +0200 Subject: [PATCH 3/3] Update index.md --- index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.md b/index.md index 796e780..5e5a5ca 100644 --- a/index.md +++ b/index.md @@ -1,4 +1,4 @@ -# PythonQwt: Qt plotting widgets for Python +# Qt plotting widgets for Python [![license](https://img.shields.io/pypi/l/PythonQwt.svg)](./LICENSE) [![pypi version](https://img.shields.io/pypi/v/PythonQwt.svg)](https://pypi.org/project/PythonQwt/)