https://github.com/carletonurocketry/hybrid-engine-ui
The user interface for the hybrid engine ground system
https://github.com/carletonurocketry/hybrid-engine-ui
Last synced: 4 months ago
JSON representation
The user interface for the hybrid engine ground system
- Host: GitHub
- URL: https://github.com/carletonurocketry/hybrid-engine-ui
- Owner: CarletonURocketry
- Created: 2024-09-08T23:13:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-02-10T23:13:47.000Z (4 months ago)
- Last Synced: 2026-02-11T00:35:48.129Z (4 months ago)
- Language: Python
- Homepage:
- Size: 9.26 MB
- Stars: 3
- Watchers: 7
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# hybrid-engine-ui
This repo contains the source code for the hybrid engine ground system UI
## Setup
0. (Only required if working on UI) Follow steps on InSpace wiki to apply for Qt educational license and install Qt tools https://imaginary-fennel-36b.notion.site/PyQt-9af8dcdfb79d4bae98e3848670bb9994
1. Create a Python virtual environment `python -m venv `
2. Activate the virtual environment
- **On Windows**: Run `.\\Scripts\Activate.ps1`. Note that you made need modify your machines execution policy if on Windows 11. To do so, run `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser`
- **On Linux/Mac**: Run `source \bin\activate`
3. Install the required dependencies by running `pip install -r requirements.txt`
4. Build the UI either using [custom build steps in Qt Creator](https://github.com/CarletonURocketry/hybrid-engine-ui/pull/40) or running the build script `python build.py`
## Running
This application can be run either from the command line or in the Qt creator application. If running in Qt creator ensure that you have correctly added the [custom build steps](https://github.com/CarletonURocketry/hybrid-engine-ui/pull/40). To run this application from the command line run `python main.py`
## Development notes
This application was recently refactored to make more use of the "Signals and Slots" framework provided by Qt. This effectively implements the mediator and observer design patterns
## Deployment
In an effort to make the UI quickly accessible for all systems, PySide6-deploy is used to convert the Python code to C code and create an executable that is included in each new release. PySide6 uses the `pysidedeploy.spec` file that is included in this repo to compile the application into an executable. Note: this file requires specific information about where the project is on your machine as well as where the Python executable is. You can use `pysidedeploy.spec.template` and replace everything in <> brackets.
Once you have filled out the template file and created a `pysidedeploy.spec` file, create a fresh executable with the current code, using `pyside6-deploy`. This process takes a few minutes and is only really necesarry when making a new release. Furthermore, at the cost of accessbility, the executable will take slightly longer to launch than the python application but should perform comparatively.