LogarithmPlotter/README.md
Ad5001 3904dc0217
Some checks failed
continuous-integration/drone/push Build is failing
Removing last instances of PySide2, updating copyrights & version to v0.4
2023-05-23 12:42:43 +02:00

5.2 KiB

icon LogarithmPlotter

Build Status Translation status On flathub On Snapcraft

2D plotter software to make Bode plots, sequences and distribution functions.

Screenshots

Magnitude example Phase example Object settings

You can find more screenshots on the app website.

Run

You can simply run LogarithmPlotter using python3 run.py.

In order to test translations, you can use the --lang=<lang code> command line option to force the detected locale of LogarithmPlotter.

Install

Generate installers:

All scripts noted here can be found in the scripts directory.

You can generate installers from LogarithmPlotter after installing all the dependencies:
For all builds, you need Python 3 with PySide6 installable with pip install PySide6.

  • Windows installer:
    • You need pyinstaller. You can install it using pip install pyinstaller.
    • Run the build-windows.bat script (or build-wine.sh if you're cross-compiling with wine on Linux) to build an exe for LogarithmPlotter.
    • You also need NSIS (Linux users can install the nsis package).
    • Run the package-windows.bat script (or package-wine.shif you're cross-compiling on Linux). You will find a logarithmplotter-setup.exe installer in the dist/accountfree/ folder.
  • MacOS Archive creator installer:
    • You need pyinstaller. You can install it using pip install pyinstaller.
    • Run the build-macosx.sh script to build an .app for LogarithmPlotter which can be found in the dist directory.
    • Run the package-macosx.sh script. You will find a LogarithmPlotter-v0.1-dev-setup.dmg installer in the dist/ folder.
  • Linux packages:
    • To build a DEB, you need DPKG and stdeb. You can install the later by using pip install stdeb.
    • To build and install the flatpak, you need flatpak-builder installed.
    • To build the snap, you need snapcraft installed.
    • Run package-linux.sh.

Linux

Run bash linux/install_local.sh

Contribute

There are several ways to contribute to LogarithmPlotter.

    LogarithmPlotter - 2D plotter software to make BODE plots, sequences and repartition functions.
    Copyright (C) 2023  Ad5001 <mail@ad5001.eu>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.

Language files translations located at LogarithmPlotter/i18n are licensed under GNU GPL3.0+ and are copyrighted by their original authors. See LICENSE.md for more details:

Libraries used

LogarithmPlotter includes expr-eval a port of ndef.parser by Raphael Graf <r@undefined.ch>, ported to javascript by Matthew Crumley <email@matthewcrumley.com> (http://silentmatt.com/), and then to QMLJS by Ad5001.

The code is licensed under the MIT License.