SunDevilRocketry · 266-750Balloons · Sep 15, 2024 · Sep 16, 2024 · Sep 16, 2024 · Sep 16, 2024
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,6 @@ test/DAQexperimental/__pycache__
 
 # Output data
 output/*
+
+build/*
+liquid_engine_gui.egg-info
diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +1,4 @@
 [submodule "sdec"]
 	path = sdec
-	url = git@github.com:SunDevilRocketry/sdec.git
+	url = https://github.com/SunDevilRocketry/sdec
+	branch = pip-packaging
diff --git a/Arduino/serialtest/serialtest.ino → Extras/Arduino/serialtest/serialtest.ino b/Arduino/serialtest/serialtest.ino → Extras/Arduino/serialtest/serialtest.ino
diff --git a/test/DAQexperimental.zip → Extras/test/DAQexperimental.zip b/test/DAQexperimental.zip → Extras/test/DAQexperimental.zip
diff --git a/test/DAQexperimental/.DS_Store → Extras/test/DAQexperimental/.DS_Store b/test/DAQexperimental/.DS_Store → Extras/test/DAQexperimental/.DS_Store
diff --git a/test/DAQexperimental/AvTest.py → Extras/test/DAQexperimental/AvTest.py b/test/DAQexperimental/AvTest.py → Extras/test/DAQexperimental/AvTest.py
diff --git a/test/DAQexperimental/DAQexperimental.ino → .../test/DAQexperimental/DAQexperimental.ino b/test/DAQexperimental/DAQexperimental.ino → .../test/DAQexperimental/DAQexperimental.ino
diff --git a/test/DAQexperimental/DataGUI.py → Extras/test/DAQexperimental/DataGUI.py b/test/DAQexperimental/DataGUI.py → Extras/test/DAQexperimental/DataGUI.py
diff --git a/test/DAQexperimental/Gauge.py → Extras/test/DAQexperimental/Gauge.py b/test/DAQexperimental/Gauge.py → Extras/test/DAQexperimental/Gauge.py
diff --git a/test/DAQexperimental/Gauge.pyc → Extras/test/DAQexperimental/Gauge.pyc b/test/DAQexperimental/Gauge.pyc → Extras/test/DAQexperimental/Gauge.pyc
diff --git a/test/DAQexperimental/SDRlogo5.ico → Extras/test/DAQexperimental/SDRlogo5.ico b/test/DAQexperimental/SDRlogo5.ico → Extras/test/DAQexperimental/SDRlogo5.ico
diff --git a/test/DAQexperimental/Servo.py → Extras/test/DAQexperimental/Servo.py b/test/DAQexperimental/Servo.py → Extras/test/DAQexperimental/Servo.py
diff --git a/test/DAQexperimental/VTC/results.png → Extras/test/DAQexperimental/VTC/results.png b/test/DAQexperimental/VTC/results.png → Extras/test/DAQexperimental/VTC/results.png
diff --git a/test/DAQexperimental/VTC/spice_sim.csv → ...as/test/DAQexperimental/VTC/spice_sim.csv b/test/DAQexperimental/VTC/spice_sim.csv → ...as/test/DAQexperimental/VTC/spice_sim.csv
diff --git a/test/DAQexperimental/VTC/vtc.py → Extras/test/DAQexperimental/VTC/vtc.py b/test/DAQexperimental/VTC/vtc.py → Extras/test/DAQexperimental/VTC/vtc.py
diff --git a/test/DAQexperimental/arduinoCom.py → Extras/test/DAQexperimental/arduinoCom.py b/test/DAQexperimental/arduinoCom.py → Extras/test/DAQexperimental/arduinoCom.py
diff --git a/test/DAQexperimental/convertDAQ.py → Extras/test/DAQexperimental/convertDAQ.py b/test/DAQexperimental/convertDAQ.py → Extras/test/DAQexperimental/convertDAQ.py
diff --git a/...xperimental/data/injector_test_700psi.txt → ...xperimental/data/injector_test_700psi.txt b/...xperimental/data/injector_test_700psi.txt → ...xperimental/data/injector_test_700psi.txt
diff --git a/test/DAQexperimental/debug.py → Extras/test/DAQexperimental/debug.py b/test/DAQexperimental/debug.py → Extras/test/DAQexperimental/debug.py
diff --git a/images/SDRLogo5.png → .../test/DAQexperimental/images/SDRLogo5.png b/images/SDRLogo5.png → .../test/DAQexperimental/images/SDRLogo5.png
diff --git a/images/SDRlogont2.png → ...est/DAQexperimental/images/SDRlogont2.png b/images/SDRlogont2.png → ...est/DAQexperimental/images/SDRlogont2.png
diff --git a/test/DAQexperimental/orificeCalData.txt → ...s/test/DAQexperimental/orificeCalData.txt b/test/DAQexperimental/orificeCalData.txt → ...s/test/DAQexperimental/orificeCalData.txt
diff --git a/liquid_engine_gui/__init__.py b/liquid_engine_gui/__init__.py
diff --git a/main.py → liquid_engine_gui/__main__.py b/main.py → liquid_engine_gui/__main__.py
@@ -33,6 +33,7 @@
 import sys
 import datetime
 import math
+from importlib.resources import files
 
 # Serial (USB)
 import serial
@@ -54,20 +55,17 @@
 sys.path.insert(0, './sdec')
 
 # Imports
-import solenoid
-import gauge          as SDR_gauge
-import valve          as SDR_valve
-import engine_display as SDR_engine_display
-import sequence       as SDR_sequence
-import buttons        as SDR_buttons
-import sensor         as SDR_sensor
+from liquid_engine_gui.plumbing import solenoid
+from liquid_engine_gui import gauge              as SDR_gauge
+from liquid_engine_gui import valve              as SDR_valve
+from liquid_engine_gui import engine_display     as SDR_engine_display
+from liquid_engine_gui import sequence           as SDR_sequence
+from liquid_engine_gui import buttons            as SDR_buttons
+from liquid_engine_gui import sensor             as SDR_sensor
 
 # SDEC
-import sdec
-import commands
-import hw_commands
-import sensor_conv
-import engineController
+import sdec.__main__ as sdec
+from sdec import commands, hw_commands, sensor_conv, engineController
 
 
 ####################################################################################
@@ -514,8 +512,10 @@ def update_valve_states( valve_states ):
                  )
 
 	# Program icon
-    SDRlogo  = tk.PhotoImage(file='images/SDRLogo5.png')
-    SDRImage = Image.open("images/SDRlogont2.png")
+    # SDRlogo  = tk.PhotoImage(file='images/SDRLogo5.png')
+    # SDRImage = Image.open("images/SDRlogont2.png")
+    SDRlogo  = tk.PhotoImage(files("liquid_engine_gui").joinpath("images").joinpath("SDRLogo5.png"))
+    SDRImage = Image.open(files("liquid_engine_gui").joinpath("images").joinpath("SDRlogont2.png"))
     SDRImage = SDRImage.resize(
                               (int(0.8*140),int(0.8*125)),
                               Image.Resampling.LANCZOS

diff --git a/buttons.py → liquid_engine_gui/buttons.py b/buttons.py → liquid_engine_gui/buttons.py
diff --git a/engine_display.py → liquid_engine_gui/engine_display.py b/engine_display.py → liquid_engine_gui/engine_display.py
@@ -19,16 +19,16 @@
 ###############################################################
 # Project Modules                                             #
 ###############################################################
-import component_template
-import solenoid        as SDR_solenoid
-import ball_valve      as SDR_ball_valve
-import orifice         as SDR_orifice
-import pressure_sensor as SDR_pressure_sensor
-import temp_sensor     as SDR_temp_sensor
-import tank            as SDR_tank
-import pipe            as SDR_pipe
-import nozzle          as SDR_nozzle
-import main
+from liquid_engine_gui.plumbing import component_template
+from liquid_engine_gui.plumbing import solenoid        as SDR_solenoid
+from liquid_engine_gui.plumbing import ball_valve      as SDR_ball_valve
+from liquid_engine_gui.plumbing import orifice         as SDR_orifice
+from liquid_engine_gui.plumbing import pressure_sensor as SDR_pressure_sensor
+from liquid_engine_gui.plumbing import temp_sensor     as SDR_temp_sensor
+from liquid_engine_gui.plumbing import tank            as SDR_tank
+from liquid_engine_gui.plumbing import pipe            as SDR_pipe
+from liquid_engine_gui.plumbing import nozzle          as SDR_nozzle
+# import main
 
 
 ###############################################################

diff --git a/gauge.py → liquid_engine_gui/gauge.py b/gauge.py → liquid_engine_gui/gauge.py
diff --git a/test/DAQexperimental/images/SDRLogo5.png → liquid_engine_gui/images/SDRLogo5.png b/test/DAQexperimental/images/SDRLogo5.png → liquid_engine_gui/images/SDRLogo5.png
diff --git a/test/DAQexperimental/images/SDRlogont2.png → liquid_engine_gui/images/SDRlogont2.png b/test/DAQexperimental/images/SDRlogont2.png → liquid_engine_gui/images/SDRlogont2.png
diff --git a/images/engine_gui.png → liquid_engine_gui/images/engine_gui.png b/images/engine_gui.png → liquid_engine_gui/images/engine_gui.png
diff --git a/images/engine_gui_2023.png → liquid_engine_gui/images/engine_gui_2023.png b/images/engine_gui_2023.png → liquid_engine_gui/images/engine_gui_2023.png
diff --git a/images/gui.png → liquid_engine_gui/images/gui.png b/images/gui.png → liquid_engine_gui/images/gui.png
diff --git a/plumbing/ball_valve.py → liquid_engine_gui/plumbing/ball_valve.py b/plumbing/ball_valve.py → liquid_engine_gui/plumbing/ball_valve.py
@@ -12,7 +12,7 @@
 ###############################################################
 # Standard Imports                                            #
 ###############################################################
-import component_template as SDR_component_template
+from liquid_engine_gui.plumbing import component_template as SDR_component_template
 
 
 class Ball_Valve(SDR_component_template.Component):

diff --git a/plumbing/component_template.py → ...engine_gui/plumbing/component_template.py b/plumbing/component_template.py → ...engine_gui/plumbing/component_template.py
diff --git a/plumbing/nozzle.py → liquid_engine_gui/plumbing/nozzle.py b/plumbing/nozzle.py → liquid_engine_gui/plumbing/nozzle.py
@@ -18,7 +18,7 @@
 ###############################################################
 # Project Imports                                             #
 ###############################################################
-import component_template as SDR_component_template
+from liquid_engine_gui.plumbing import component_template as SDR_component_template
 
 
 class Nozzle:

diff --git a/plumbing/orifice.py → liquid_engine_gui/plumbing/orifice.py b/plumbing/orifice.py → liquid_engine_gui/plumbing/orifice.py
@@ -12,7 +12,7 @@
 ###############################################################
 # Standard Imports                                            #
 ###############################################################
-import component_template as SDR_component_template
+from liquid_engine_gui.plumbing import component_template as SDR_component_template
 
 
 class Orifice(SDR_component_template.Component):

diff --git a/plumbing/pipe.py → liquid_engine_gui/plumbing/pipe.py b/plumbing/pipe.py → liquid_engine_gui/plumbing/pipe.py
@@ -18,7 +18,7 @@
 ###############################################################
 # Project Imports                                             #
 ###############################################################
-import component_template as SDR_component_template
+from liquid_engine_gui.plumbing import component_template as SDR_component_template
 
 
 ###############################################################

diff --git a/plumbing/pressure_sensor.py → ...id_engine_gui/plumbing/pressure_sensor.py b/plumbing/pressure_sensor.py → ...id_engine_gui/plumbing/pressure_sensor.py
@@ -13,7 +13,7 @@
 ###############################################################
 # Standard Imports                                            #
 ###############################################################
-import component_template as SDR_component_template
+from liquid_engine_gui.plumbing import component_template as SDR_component_template
 
 
 class PressureSensor(SDR_component_template.Component):

diff --git a/plumbing/solenoid.py → liquid_engine_gui/plumbing/solenoid.py b/plumbing/solenoid.py → liquid_engine_gui/plumbing/solenoid.py
@@ -12,7 +12,7 @@
 ###############################################################
 # Project Imports                                             #
 ###############################################################
-import component_template as SDR_component_template
+from liquid_engine_gui.plumbing import component_template as SDR_component_template
 
 
 class Solenoid(SDR_component_template.Component):

diff --git a/plumbing/tank.py → liquid_engine_gui/plumbing/tank.py b/plumbing/tank.py → liquid_engine_gui/plumbing/tank.py
@@ -18,7 +18,7 @@
 ###############################################################
 # Project Imports                                             #
 ###############################################################
-import component_template as SDR_component_template
+from liquid_engine_gui.plumbing import component_template as SDR_component_template
 
 
 class Tank:

diff --git a/plumbing/temp_sensor.py → liquid_engine_gui/plumbing/temp_sensor.py b/plumbing/temp_sensor.py → liquid_engine_gui/plumbing/temp_sensor.py
@@ -13,7 +13,7 @@
 ###############################################################
 # Standard Imports                                            #
 ###############################################################
-import component_template as SDR_component_template
+from liquid_engine_gui.plumbing import component_template as SDR_component_template
 
 
 class TempSensor(SDR_component_template.Component):

diff --git a/sensor.py → liquid_engine_gui/sensor.py b/sensor.py → liquid_engine_gui/sensor.py
@@ -12,7 +12,7 @@
 ####################################################################################
 # Imports                                                                          #
 ####################################################################################
-import controller as SDR_controller
+from sdec import controller as SDR_controller
 
 
 ####################################################################################

diff --git a/sequence.py → liquid_engine_gui/sequence.py b/sequence.py → liquid_engine_gui/sequence.py
@@ -19,8 +19,8 @@
 ####################################################################################
 # Project Imports                                                                  #
 ####################################################################################
-import engineController
-import valveController
+from sdec import engineController
+from sdec import valveController
 
 
 ####################################################################################

diff --git a/valve.py → liquid_engine_gui/valve.py b/valve.py → liquid_engine_gui/valve.py
@@ -19,7 +19,7 @@
 ####################################################################################
 # Project Imports                                                                  #
 ####################################################################################
-import buttons as SDR_buttons
+from liquid_engine_gui import buttons as SDR_buttons
 
 
 ####################################################################################

diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,24 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages]
+find = {where=["."], include=["liquid_engine_gui*"], exclude = ["Extras"]}
+
+[tool.setuptools.package-data]
+liquid_engine_gui = ["images/*"]
+
+[project]
+name = "liquid_engine_gui"
+authors = [
+    {name = "Nitish Chennoju"},
+    {name = "Ian Chandra"},
+    {name = "Colton Acosta"},
+    {name = "Nick Nguyen"}
+]
+version = "2024.9.0+packagingdev"
+dependencies = [
+    "pillow",
+    "sdec@git+https://github.com/SunDevilRocketry/sdec"
+]
+readme = "readme.md"
diff --git a/readme.md b/readme.md
@@ -1,17 +1,31 @@
 # Rocket Engine GUI
-## Getting Started
-1) Open cmd / terminal
-2) Navigate into the project folder
-3) Ensure all required libraries are downloaded (pip install -r requirements.txt)
-4) Run main program (python SDR_LiquidGUI.py)
-5) Connect Arduino running SDR_DataLogger_Analog.ino via USB port
+![A screenshot of the sdec gui](liquid_engine_gui/images/engine_gui_2023.png)
+
+The Liquid Engine GUI is a visual control and monitoring software for the SDR Liquid Engine Valve controller, written in Python using Tk and our [sdec](https://github.com/SunDevilRocketry/sdec) library.
 
 The following code on this repository has been designed to control the SDR Liquid Engine Switchbox to:
 - Automate Rocket Engine Startup
 - Display Rocket Engine State
 - Log Sensor Data
 - Have Pre-programmed actions to execute (i.e. Startup)
 
-## GUI Layout
-<img src="images/engine_gui_2023.png">
+## Installation
+> In the near future, we intend to have an installer application for, at the minimum, Microsoft Windows. For now, the installation process 
+1. Make sure you have a working Python installation with pip.
+2. Install the GUI with pip.
+
+        pip install git+https://github.com/SunDevilRocketry/liquid_engine_gui
+3. Run the GUI with the following command:
+
+        python -m liquid_engine_gui
+> If you are developing the software, make sure you don't execute this command in the same directory as the repository, or you may experience bugs.
+
+## Development
+The source code is under the directory liquid_engine_gui. The versioning convention is the same as SDEC.
+
+Normally, sdec is automatically pulled with pip. However, it is also included as a submodule in this repo should you be working on sdec development. To test changes to sdec and/or liquids gui, pull your submodules, then use the repo as the current directory and run:
+
+```python3 -m liquid_engine_gui```
+
+This project uses Tk and sdec as a library.
 
diff --git a/sdec b/sdec
+4 −1		.gitignore
+64 −29		README.md
+0 −1		input/README.md
+0 −1		output/README.md
+30 −0		pyproject.toml
+0 −0		sdec/__init__.py
+15 −6		sdec/__main__.py
+9 −4		sdec/commands.py
+0 −0		sdec/config.py
+1 −1		sdec/controller.py
+0 −0		sdec/doc/comports
+0 −0		sdec/doc/connect
+0 −0		sdec/doc/dual-deploy
+0 −0		sdec/doc/flash
+0 −0		sdec/doc/ignite
+0 −0		sdec/doc/manpage
+0 −0		sdec/doc/ping
+0 −0		sdec/doc/power
+0 −0		sdec/doc/sensor
+0 −0		sdec/doc/sol
+0 −0		sdec/doc/valve
+4 −4		sdec/engineController.py
+7 −7		sdec/flightComputer.py
+31 −28		sdec/hw_commands.py
+0 −0		sdec/plot_data.py
+1 −1		sdec/sensor_conv.py
+2 −2		sdec/valveController.py