janishutz/BiogasControllerApp
1
0
Fork 0
mirror of https://github.com/janishutz/BiogasControllerApp.git synced 2025-11-25 13:54:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Install and run the program (markdown)

Janis Hutz
2025-06-10 15:30:26 +00:00
parent 8c0459970e
commit 2da9ca433e
1 changed files with 16 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
Install-and-run-the-program.md

@@ -2,65 +2,39 @@
<a href="https://store.janishutz.com/donate" target="_blank"><img src="https://store-cdn.janishutz.com/static/support-me.jpg" width="150px"></a> <a href="https://store.janishutz.com/donate" target="_blank"><img src="https://store-cdn.janishutz.com/static/support-me.jpg" width="150px"></a>
</div> </div>
# Let's download the App! # Downloading
## Windows (all versions) ## Windows (all versions)
1. Go to the main page, click on the release you'd like to download (located on the right) 1. On the "Code" page, click the current release (on the right hand side), scroll down to assets and select "BiogasControllerApp-Windows.zip".
2. Download the executable, run it and follow the steps in the setup 2. Extract the zip archive you just downloaded.
## GNU/Linux (all distros), MacOS (for now) ## GNU/Linux
1. Download the source code of the latest release 1. From the releases page, download either `biogascontrollerapp-linux.tar.gz` or the `install-linux.sh` script.
2. Extract the folder "BiogasControllerApp VX.x". 2. Extract the tarball and enter the extracted directory or give the script execute permission
3. Open a terminal and type `pip install kivy[base]`, press enter. 3. Run `pip install -r requirements.txt` or run the script.
4. Once the other installation is done, type: `pip install pyserial`
# Run the app # Run the app
## Windows (all versions) ## Windows
1. Double click the desktop shortcut, use windows search, open it using the start menu entry or by navigating into the save folder 1. Navigate to the folder where you have saved the files during install and enter the folder
2. Open BiogasControllerApp.exe
## GNU/Linux (all distros) ## GNU/Linux (all distros)
1. Open a terminal and cd into the folder where you saved the folder beforehands 1. Navigate to the folder where you have saved the files during install and enter the folder
2. type `python3 biogascontrollerapp.py` 2. Run the launch.py script or run `python biogascontrollerapp.py` in the terminal
## MacOS (all versions)
1. Open the terminal.
2. If you know where exactly you have saved the folder you downloaded before, then you can head to step 4.
3. Locate your downloaded file in Finder and remember the file path to it.
4. head to the terminal and type `cd ./[followed by the path. Put a slash (/) after every folder name. You may use the tab key to autocomplete]`. Important! Do not write the quotation marks nor the square brackets with its content! Also, do not type in the last slash and also not the name of the python file you are going to execute.
5. Now type in `python3 biogascontrollerapp.py`. Same here, without the quotation marks
# DOWNLOAD dev versions (if you run into a bug, then this may help) # Dev Versions
First things first, you need to get the code of the BiogasControllerApp. For this, head to the "code" tab on GitHub and then, when downloading the development version, click "code" (the green button) and hit "download zip". If you want to download the code for the latest release of the BiogasControllerApp, then instead of clicking onto the green "code" button, click onto "Releases" on the right-hand side and select the latest release. Then, download either the Zip file or the G-Zip compressed Tarball (.tar.gz file). First things first, you need to get the code of the BiogasControllerApp. For this, head to the "code" tab on GitHub and then, when downloading the development version, click "code" (the green button) and hit "download zip". If you want to download the code for the latest release of the BiogasControllerApp, then instead of clicking onto the green "code" button, click onto "Releases" on the right-hand side and select the latest release. Then, download either the Zip file or the G-Zip compressed Tarball (.tar.gz file).
Now head to the folder you downloaded the file into and extract the archive. Now head to the folder you downloaded the file into and extract the archive.
## Installing dependencies
## Installing Python + required packages: In the folder of the repo, run `pip install -r requirements.txt`, preferrably in a venv.
### GNU/Linux (most distros)
1. Python is preinstalled, though you‘ll need to install pip on most distros. Use `sudo (your package manager name here, (apt-get install for ubuntu / debian based distros; dnf install for fedora and pacman for arch based)) pip`
2. copy & paste the following command into your terminal:
`pip install pyserial kivy[base]`
*NOTE: Some distros have blocked pip and require you to use either pipx or the distro package manager. Read more in your distro's docs / wiki.*
### MacOS
1. head to this link, install python and make sure you have pip selected: https://www.python.org/downloads/macos/
2. now open a terminal and type the following command:
`pip install pyserial kivy[base]`
### Windows
1. head to this link, install python and make sure you have pip selected: https://www.python.org/downloads/windows/
2. now open the command prompt (by typing “cmd” into the search bar, for example)
3. type the following command:
`pip install pyserial kivy[base]`
## Launching the app Then, simply run the app using python
1. On MacOS and Linux, open a terminal in the project folder.
`cd ./BiogasController`, press tab and then press enter.
On Windows open your Explorer and navigate into the BiogasControllerApp-VX.X (whereas x is to be replaced with whatever folder‘s in there with that structure). Then click on the bar where you can find the path. Type in „cmd“.
2. You may start the app by typing `python3 biogascontrollerapp.py`
<div id="donate" align="center"> <div id="donate" align="center">