Getting started¶
This chapter will give a basic instructions for installing and running the program. For detailed usage instructions please see the User guide.
Desktop¶
As simple_plotter is entirely written in python it should run on any desktop platform with a python3 interpreter and support for the required packages (see Requirements).
The packages for simple-plotter are available on PyPI. The easiest solution is to install the simple-plotter-qt package with the default desktop GUI front-end and plotting library (i.e. PyQt and matplotlib) using pip.
Open up a terminal and type:
pip install simple-plotter-qt
It will automatically install the requirements.
To launch simple-plotter just enter:
simple-plotter-qt
To install different GUI/plotting library options see Configuration options.
Android¶
The Android app is available in the F-Droid app-store [work in progress…].
Alternatively you can build the Android APK from source. Follow the instructions on https://gitlab.com/thecker/simple-plotter4a
Note
Due to a broken matplotlib recipe in the python-for-android project the Android app is currently based on the kivy-garden-graph configuration - see Configuration options.
Configuration options¶
The table below shows the currently available configuration options.
| Package | Configuration | plotting library | GUI frame work | ||
|---|---|---|---|---|---|
| matplotlib | garden.graph | PyQt | kivy | ||
| simple-plotter | x | x | |||
| simple-plotter-qt | x | x | |||
| simple-plotter4a | kivy-matplotlib | x | x | ||
| simple-plotter4a | kivy-garden-graph | x | x | ||
The base package (simple-plotter) only provides a command line interface (CLI) for the plot-code generator.
Use pip install <Package>[<Configuration>] to install one of the configuration options, where the [<Configuration>]
is optional, if available - e.g.:
pip install simple-plotter4a[kivy-matplotlib]
Similarly you launch the programs with simple-plotter-<Configuration> - e.g.:
simple-plotter-kivy-matplotlib
Requirements¶
simple_plotter is written in python3 and requires has following dependencies:
Mandatory:
- numpy
- setuptools_scm
- jinja2
Optional:
- pyqt >= 5
- matplotlib>=2
- kivy>=1.11
- kivy-garden.graph>=0.4
The optional dependencies provide are related to the different Configuration options.
Source code¶
The source code for the base package can be obtained from:
https://gitlab.com/thecker/simple-plotter
For Qt-based GUI see:
https://gitlab.com/thecker/simple-plotter-qt
and for the kivy-based GUI see:
https://gitlab.com/thecker/simple-plotter4a
If you would like to contribute see Contributing.