LogarithmPlotter/README.md

5.4 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's website.

Run

You can simply run LogarithmPlotter using python3 run.py.

In order to test translations, you can use the --lang=<lang code> commandline option to force the locale.

Install

Generate installers:

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

You can generate installers for LogarithmPlotter after installing all the dependencies:
For all builds, you will need Python 3 with poetry, and poetry install --with packaging.

  • Windows installer:
    • 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/logarithmplotter/ folder.
  • MacOS Archive creator installer:
    • 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-v<version>-setup.dmg installer in the dist/ folder.
  • Linux packages:
    • To build and install the flatpak, you need flatpak-builder installed.
    • To build the snap, you need snapcraft installed.
    • Run package-linux.sh.

Contribute

There are several ways you can contribute to LogarithmPlotter.

Tests

To run LogarithmPlotter's tests, follow these steps:

  • Python
    • Install python3 and poetry
    • Run poetry install --with test
    • Run scripts/run-tests.sh
    LogarithmPlotter - 2D plotter software to make Bode plots, sequences and repartition functions.
    Copyright (C) 2021-2024  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.

All files in (LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/lib/expr-eval/) except integration.mjs are licensed under the MIT License.