In the following sections, the available installation methods and instructions are provided.
The easiest way to run the software is to download the package version from the Releases. At the time of writting this guide version v0.1.0-alpha have just been released!
In the release section you will find three files, a zip-file corresponding to the full-installation (SSPC.zip) along with two files corresponding to the source code (zip and tar).
Download SSPC.zip and unzip it where you want it. Inside there will be a SSPC folder, inside are all the files needed to run the program (including all the LICENSES from third party libraries and SSPC itself). Just search for the executable: SSPC.exe and the program should launch.
You can put the folder anywhere you want, and then generate a desktop shortcut of SSPC.exe.
To install from sources you only need a copy of this repository!
The software was developed using Python 3.8, and all of the following dependencies are listed with this version in mind. However, it is possible that the software is compatible with newer versions of the interpreter and dependencies. This includes the Pipfiles and requirements.txt files.
| Dependency | Version | Description | License |
|---|---|---|---|
| PySide2 | 5.15.2.1 | Used to build the GUI | LGPLv3 |
| Pyserial | 3.5 | Used for serial communication | BSD |
| altgraph | 0.17.3 | Used by Pyserial | MIT |
| numpy | 1.24.2 | Used for numerical operations | BSD External |
| shiboken2 | 5.15.2.1 | Used by PySide2 | LGPLv3 |
* External refers to third-party software used by the dependency itself.
Although not requiered to run the software, this dependencies were used to compiled the package (exe) for Windows:
| Dependency | Version | Description |
|---|---|---|
| pyinstaller | 5.9.0 | Package Windows application |
| pip-licenses | 4.1.0 | Try to understand what license can I use for this piece of software |
To install the dependencies use the Pipfile and Pipfile.lock provided with the repository. Using the following command from the root of the project to install them:
$ pipenv install
If you also want to install the dev dependencies (i.e to package for Windows), use the following command:
$ pipenv install -dev
After installation you need to activate the virtual environment running:
$ pipenv shell
To install the dependencies use the requirements.txt provided with the repository. Using the following command from the roof of the project to install them:
$ pip install -r requirements.txt
After installing the dependencies, you should be able to run the code. You can try to run it using the following commands from the root of the project.
$ python SSPC.py
