Replay function redone and beam experiment data added (#39)

- Updates clustering and mode tracking modules
- Separates YaFEM models from methods
- Updates documentation
- Adds recorded data of cantilever beam for repeatable experiments

Author: au650680

USERGUIDE.md

@@ -47,12 +47,12 @@ Inside `examples/run_sysid.py`, `examples/run_mode_clustering.py`, `examples/run
 the sample time can be changed: `number_of_minutes`.
 
 * **Parameters**
-Inside  `method/constans.py` the parameters for system identification, mode clustering, mode tracking and model updating
+Inside  `method/constants.py` the parameters for system identification, mode clustering, mode tracking and model updating
 can be changed.
 
 * **Model**
 A digital YAFEM model can be added to `models/<your_model>`.
-Inside  `method/constans.py` the model paramters can be set together with the paths to the model folder and the model function file.
+Inside  `method/constants.py` the model paramters can be set together with the paths to the model folder and the model function file.
 
 
 ## Step 1.4 Run examples
@@ -124,7 +124,7 @@ poetry build
 ```
 
 This will create a `.whl` file in the `dist/` directory,
-e.g., `dist/cp_sens-0.6.0-py3-none-any.whl`.
+e.g., `dist/cp_sens-0.6.1-py3-none-any.whl`.
 
 ### Step 2.2: Create and Activate a Virtual Environment
 
@@ -141,7 +141,7 @@ pip install example_shm-<version>-py3-none-any.whl
 ```
 
 Replace `<version>` with the version number found in the `.whl`
-filename. (e.g `0.6.0`).
+filename. (e.g `0.6.1`).
 
 ## Step 2.4: Create Configuration
 
@@ -226,7 +226,6 @@ Options:
 Commands:
   accelerometers
   align-readings
-  align-readings-plot
   clustering-with-local-sysid
   clustering-with-remote-sysid
   live-clustering-with-remote-sysid
@@ -257,13 +256,6 @@ $example-shm
 Usage: example-shm  --config <config-file> accelerometers
 ```
 
-
-
-
-
-
-
-
 ## Distributed Setup Overview
 
 This explains the setup needed to run the distributed version of the example-shm pipeline.
@@ -310,7 +302,7 @@ CONFIG_PATH = "config/replay.json"
 RECORDINGS_DIR = "record/mqtt_recordings"
 FILE_NAME = "recording.jsonl"
 
-REPLAY_SPEED = 0.1  # Multiplier for replay speed
+REPLAY_SPEED = 1  # Multiplier for replay speed
 ```
 At the bottom the number of times to loop the replay function can be stated: `replay_mqtt_messages(loop=10) # Times to loop`
 

models/beam/beam_yafem_model.py

@@ -14,13 +14,13 @@ def eval_yafem_model(pars=None):
     l1  = pars.setdefault('l1' ,0.030)  # [m] distance from the beam top to the top accelerometer
     l2  = pars.setdefault('l2' ,0.0675) # [m] distance between the accelerometers 0.0675
     l3  = pars.setdefault('l3' ,0.070)  # [m] distance between the supports
-    l4   = pars.setdefault('l4'  ,0.130)  # [m] VARIABLE approx. the depth of the "ground"
+    l4   = pars.setdefault('l4'  ,0.1289)  # [m] VARIABLE approx. the depth of the "ground"
     E   = pars.setdefault('E'  ,200e9)  # [Pa] Young modulus, normal steel
     b   = pars.setdefault('b'  ,29e-3)  # [m] width of the ruler
     h   = pars.setdefault('h'  ,1e-3)   # [m] thichness of the ruler
     rho = pars.setdefault('rho',7850)   # [kg/m3] density of the steel
     m   = pars.setdefault('m'  ,15e-3)  # [kg] VARIABLE tip mass
-    k_rot = pars.setdefault('k_rot' ,3.5e3) # [Nm/rad] VARIABLE rotational stiffness
+    k_rot = pars.setdefault('k_rot' ,10) # [Nm/rad] VARIABLE rotational stiffness
     modes = pars.setdefault('modes' ,3)
     dofs_sel = pars.setdefault('dofs_sel',np.array([1,1]))
 
@@ -59,7 +59,7 @@ def eval_yafem_model(pars=None):
     mass_pars['dofs'] = np.array([[8,1]])
     mass_tip = MCK(myNodes,mass_pars)
 
-    # # springs
+    # springs
     spring_pars = {}
     spring_pars['K'] = np.array([[k_rot,0],[0,k_rot]])
     spring_pars['dofs'] = np.array([[3,3],[2,3]])
@@ -136,4 +136,4 @@ def eval_yafem_model(pars=None):
     idxs_sel = myModel.find_dofs(dofs_sel)
     phi_sel = phi[idxs_sel,:]
 
-    return omega, phi, phi_sel, myModel
+    return omega, phi, phi_sel, myModel, mySimulation

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "example-shm"
-version = "0.6.0"
+version = "0.6.1"
 description = "Demonstration for structural health monitoring of engineering structures"
 authors = [
     "Mohamed Abdulkarim <202206332@post.au.dk>",
@@ -14,7 +14,8 @@ packages = [
     {include = "examples", from="src"},
     {include = "functions", from="src"},
     {include = "methods", from="src"},
-    {include = "beam", from="models"}
+    {include = "beam", from="models"},
+    {include = "record"}
 ]
 
 [tool.poetry.dependencies]

record/README.md

@@ -0,0 +1,37 @@
+# Purpose
+The record.py and replay.py files are used to record data from MQTT topics which later can be replayed and re-published with replay.py.
+
+# Run the functions
+The functions are directly run with:
+```bash
+python ./record/record.py
+
+python ./record/replay.py
+```
+
+# Parameters for record.py
+
+CONFIG_PATH = "<path>.json": Path to config file
+
+RECORDINGS_DIR : Directory path to what folder to save recording to
+
+FILE_NAME = "<name>.jsonl": filename for saved recording file
+
+DURATION_SECONDS: Recording duration in seconds 
+
+# Parameters for replay.py
+
+CONFIG_PATH = "<path>.json": Path to config file
+
+RECORDINGS_DIR : Directory path to what folder the file to replay
+FILE_NAME = "<name>.jsonl": filename for file to replay
+
+REPLAY_SPEED:  # Multiplier for replay speed
+ 
+KEEP_UP_TIME: If delay time (remaining) is lower than this time, warn the user that the replay speed is two fast.
+
+PRINT_INTERVAL: Interval between printing information
+
+BATCH_SIZE: Number of values in every MQTT package
+
+LOOPS: Number of times to loop over the recording