Merge pull request #10 from pieterberg/control

Process Control (0.4.0)
pieterberg · Aug 18, 2022 · d3e5159 · d3e5159 · pieterberg · Mar 19, 2023
2 parents e84de88 + fbd4c60
commit d3e5159
Show file tree

Hide file tree

Showing 99 changed files with 192,057 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -4,10 +4,52 @@
 
 <img src="https://img.shields.io/badge/Stellenbosch University-BEng ChemE-008BC0?style=flat"/>
 
-BEng ChemE final year project using PCA and statistical classification to identify a process' state.
+Chemical Engineering final year project using PCA and statistical classification to identify a process' state.
 
 ## Usage instructions
 
+### Running the simulation
+
 1. Run the Simulink model from the MATLAB Live Script `process_model/copper_solvent_extraction_model.mlx`.
 
 1. Run the MATLAB Live Script from the main `Process-State-Identification` folder.
+
+### Simulation settings
+
+| Setting               | Values                    | Description                                                                 |
+|-----------------------|---------------------------|-----------------------------------------------------------------------------|
+| `SAVE_IMAGES`         | - `true` <br> - `false`   | Saves the generated images to the respective output folder if set to `true` |
+| `SAVE_DATA`           | - `true` <br> - `false`   | Saves the simulation data to the respective output folder if set to `true`  |
+| `SENSOR_NOISE`        | - `true` <br> - `false`   | Adds sensor noise to the measurements if set to `true`                      |
+| `FEEDBACK_CONTROL`    | - `true` <br> - `false`   | Enables feedback control of the process if set to `true`                    |
+| `FEEDFORWARD_CONTROL` | - `true` <br> - `false`   | Enables feedforward control of the process if set to `true`                 |
+
+### Output folder structure
+
+Create the following folder structure to save to simulation results using the `SAVE_IMAGES` and `SAVE_DATA` settings:
+
+```
+.
+|__ output
+    |__ process_model
+        |__ data
+        |__ graphs
+            |__ measured_variables
+            |__ process_variables
+            |__ sensor_noise
+```
+
+Create the following folder structure to save the ARX model results:
+
+```
+.
+|__ controller_tuning
+    |__ output
+        |__ feedback
+        |__ feedforward
+```
+
+
+
+
+
diff --git a/assets/simulink/.gitkeep b/assets/simulink/.gitkeep
diff --git a/assets/simulink/controllers/c_LO_controller.png b/assets/simulink/controllers/c_LO_controller.png
diff --git a/assets/simulink/controllers/c_RE_controller.png b/assets/simulink/controllers/c_RE_controller.png
diff --git a/assets/simulink/controllers/controller_FB1.png b/assets/simulink/controllers/controller_FB1.png
diff --git a/assets/simulink/controllers/controller_FB2.png b/assets/simulink/controllers/controller_FB2.png
diff --git a/assets/simulink/controllers/controller_FF1.png b/assets/simulink/controllers/controller_FF1.png
diff --git a/assets/simulink/controllers/controller_FF2.png b/assets/simulink/controllers/controller_FF2.png
diff --git a/assets/simulink/controllers/controller_FF3.png b/assets/simulink/controllers/controller_FF3.png
diff --git a/assets/simulink/controllers/controller_FF4.png b/assets/simulink/controllers/controller_FF4.png
diff --git a/assets/simulink/main_processes/E1.png b/assets/simulink/main_processes/E1.png
diff --git a/assets/simulink/main_processes/E2.png b/assets/simulink/main_processes/E2.png
diff --git a/assets/simulink/main_processes/E3.png b/assets/simulink/main_processes/E3.png
diff --git a/assets/simulink/main_processes/LE.png b/assets/simulink/main_processes/LE.png
diff --git a/assets/simulink/main_processes/PLSP.png b/assets/simulink/main_processes/PLSP.png
diff --git a/assets/simulink/main_processes/PLSS.png b/assets/simulink/main_processes/PLSS.png
diff --git a/assets/simulink/main_processes/S1.png b/assets/simulink/main_processes/S1.png
diff --git a/assets/simulink/main_processes/scopes.png b/assets/simulink/main_processes/scopes.png
diff --git a/assets/simulink/mixers_and_setlers/E1_mixer.png b/assets/simulink/mixers_and_setlers/E1_mixer.png
diff --git a/assets/simulink/mixers_and_setlers/E1_settler.png b/assets/simulink/mixers_and_setlers/E1_settler.png
diff --git a/assets/simulink/mixers_and_setlers/E2_mixer.png b/assets/simulink/mixers_and_setlers/E2_mixer.png
diff --git a/assets/simulink/mixers_and_setlers/E2_settler.png b/assets/simulink/mixers_and_setlers/E2_settler.png
diff --git a/assets/simulink/mixers_and_setlers/E3_mixer.png b/assets/simulink/mixers_and_setlers/E3_mixer.png
diff --git a/assets/simulink/mixers_and_setlers/E3_settler.png b/assets/simulink/mixers_and_setlers/E3_settler.png
diff --git a/assets/simulink/mixers_and_setlers/S1_mixer.png b/assets/simulink/mixers_and_setlers/S1_mixer.png
diff --git a/assets/simulink/mixers_and_setlers/S1_settler.png b/assets/simulink/mixers_and_setlers/S1_settler.png
diff --git a/assets/simulink/sensors/c_BO_sensor.png b/assets/simulink/sensors/c_BO_sensor.png
diff --git a/assets/simulink/sensors/c_LE_sensor.png b/assets/simulink/sensors/c_LE_sensor.png
diff --git a/assets/simulink/sensors/c_LO_sensor.png b/assets/simulink/sensors/c_LO_sensor.png
diff --git a/assets/simulink/sensors/c_PLS_sensor.png b/assets/simulink/sensors/c_PLS_sensor.png
diff --git a/assets/simulink/sensors/c_RE_sensor.png b/assets/simulink/sensors/c_RE_sensor.png
diff --git a/assets/simulink/sensors/c_RaffP_sensor.png b/assets/simulink/sensors/c_RaffP_sensor.png
diff --git a/assets/simulink/sensors/c_RaffS_sensor.png b/assets/simulink/sensors/c_RaffS_sensor.png
diff --git a/assets/simulink/sensors/f_LE_sensor.png b/assets/simulink/sensors/f_LE_sensor.png
diff --git a/assets/simulink/sensors/f_LO_sensor.png b/assets/simulink/sensors/f_LO_sensor.png
diff --git a/assets/simulink/sensors/f_PLSP_sensor.png b/assets/simulink/sensors/f_PLSP_sensor.png
diff --git a/assets/simulink/sensors/f_PLSS_sensor.png b/assets/simulink/sensors/f_PLSS_sensor.png
diff --git a/assets/simulink/valves/Valve_LE.png b/assets/simulink/valves/Valve_LE.png
diff --git a/assets/simulink/valves/Valve_LO.png b/assets/simulink/valves/Valve_LO.png
diff --git a/assets/simulink/valves/valve_LE_flow_model.png b/assets/simulink/valves/valve_LE_flow_model.png
diff --git a/assets/simulink/valves/valve_LE_valve_model.png b/assets/simulink/valves/valve_LE_valve_model.png
diff --git a/assets/simulink/valves/valve_LO_flow_model.png b/assets/simulink/valves/valve_LO_flow_model.png
diff --git a/assets/simulink/valves/valve_LO_valve_model.png b/assets/simulink/valves/valve_LO_valve_model.png
diff --git a/controller_tuning/arx_models/arx_models.slx b/controller_tuning/arx_models/arx_models.slx
diff --git a/controller_tuning/arx_models/feedback_arx_models.mlx b/controller_tuning/arx_models/feedback_arx_models.mlx
diff --git a/controller_tuning/arx_models/feedforward_arx_models.mlx b/controller_tuning/arx_models/feedforward_arx_models.mlx