Merge pull request #34 from BYU-PRISM/develop

SysID v0.6.0

README.md

@@ -16,7 +16,7 @@
 A Seeq Add-on built-in python to identify input and output relationships for the system to create **digital twin**
 models for various analytics and machine learning tasks. System dynamics are identified thereby
 allowing users to get dynamic predictions quickly. The Add-on is fully integrated with
-Seeq Workbench. Cleaned and contextualized data from Seeq workbench can be used to identify dynamic models; the models can be pushed back into Seeq workbench. This framework supports both adhoc investigations as well as streaming predictions. The system identification framework can be used for a variety of tasks including simulation, digital twin construction, advanced process control, real-time optimization, etc.
+Seeq Workbench. Cleaned and contextualized data from Seeq workbench can be used to identify dynamic models; the models can be pushed back into Seeq workbench. This framework supports both ad-hoc investigations as well as streaming predictions. The system identification framework can be used for a variety of tasks including simulation, digital twin construction, advanced process control, real-time optimization, etc.
 
 <p align="center">
 <img src="https://github.com/BYU-PRISM/Seeq/blob/main/docs/images/Digital_twin_inout.png?raw=true" align="center" width="650" height="150">
@@ -36,8 +36,8 @@ The System Identification Add-on supports the construction of a variety of dynam
 
 ## ARX model
 ARX model is a system identification model that uses the linear correlation between previous and future values. ARX model consists of previous output terms (y) and previous input (u) terms multiplied by the linear coefficients (a, b). The linear combination of past input and output value computes the one-step-ahead prediction of output value(y<sub>k+1</sub>).
-Multiple iterations of the one-step-ahead prediction return the multi-step prediction (from y<sub>k+1</sub> to y<sub>k+n</sub>). The time window of the past input and output terms is shifted toward next segment for every iteration for multi-step prediction.
-Here is an example formular with <img src="https://render.githubusercontent.com/render/math?math=\large n_a=3"> and <img src="https://render.githubusercontent.com/render/math?math=\large n_b=2"> for the single input and single output system,
+Multiple iterations of the one-step-ahead prediction return the multi-step prediction (from y<sub>k+1</sub> to y<sub>k+n</sub>). The time window of the past input and output terms is shifted toward the next segment for every iteration for multi-step prediction.
+Here is an example formula with <img src="https://render.githubusercontent.com/render/math?math=\large n_a=3"> and <img src="https://render.githubusercontent.com/render/math?math=\large n_b=2"> for the single input and single output system,
 <p align="center">
 <img src="https://render.githubusercontent.com/render/math?math=\large y_{k %2B 1}=a_{0} y_{k} %2B a_{1} y_{k-1} %2B a_{2} y_{k-2} %2B b_{0} u_{k} %2B b_{1} u_{k-1}" >
 </p>
@@ -55,7 +55,7 @@ Here is an example formular with <img src="https://render.githubusercontent.com/
 <img src="https://render.githubusercontent.com/render/math?math=\large n_c">: Delay between input and output  
 <img src="https://render.githubusercontent.com/render/math?math=\large k">: present time step  
 
-Here is another example formular with **delay**  <img src="https://render.githubusercontent.com/render/math?math=\small (n_a=3, n_b=2, n_c=2)">,  
+Here is another example formula with **delay**  <img src="https://render.githubusercontent.com/render/math?math=\small (n_a=3, n_b=2, n_c=2)">,  
 
 <p align="center">
 <img src="https://render.githubusercontent.com/render/math?math=\large y_{k %2B 1}=a_{1} y_{k} %2B a_{2} y_{k-1} %2B a_{3} y_{k-2} %2B b_{1} u_{k-2-2} %2B b_{2} u_{k-1-2}" >
@@ -143,7 +143,7 @@ If you want to install **seeq-sysid** as a Seeq Add-on Tool, you will need:
 
 - Enable Add-on Tools (or External Tools) in the Seeq server
 
-*Note:* For older versions of Seeq Data Lab you can find installation guide [`here`](https://user-images.githubusercontent.com/55245976/137494969-43d93065-1e23-4e7c-952f-2397993eb269.mp4).
+*Note:* For older versions of Seeq Data Lab you can find the installation guide `here``](https://user-images.githubusercontent.com/55245976/137494969-43d93065-1e23-4e7c-952f-2397993eb269.mp4).
 <!-- (>= R50.5.0, >=R51.1.0, or >=R52.1.0) -->
 
 
@@ -201,10 +201,29 @@ run `developer_notebook.ipynb` notebook there.
 
 # Changelog
 
+## v0.6.0
+- MA model added
+- Units switch added
+- Version number added to the GUI
+
+## v0.5.1
+- Minor bugs fixed
+
+## v0.5.0
+
+- ARIMAX model added
+- Minor improvements
+- GUI object moved to app.py
+- Display results after calculation (Default)
+- Unit compatibility error fixed
+- Workbook pull step bypassed
+- Push functions improved
+
 ## v0.4.1
 - Hotfix for R57+ (search, pull, push functions)
 
-## v0.4
+## v0.4.0
+
 
 - Export ARX model (Gekko sysid outputs as a pickle)
 - Data Editor Added
@@ -251,7 +270,7 @@ Code related issues (e.g. bugs, feature requests) can be created in the
 Please cite this work as:
 
 ```shell
-seeq-sysid v0.4.1
+seeq-sysid v0.6.0
 BYU PRISM Group https://apm.byu.edu/prism/
 https://github.com/BYU-PRISM/Seeq
 ```

SysID Addon/README.md

@@ -1,6 +1,6 @@
 <!-- workflow badges -->
 [![CodeQL](https://github.com/BYU-PRISM/Seeq/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/BYU-PRISM/Seeq/actions/workflows/codeql-analysis.yml)
-[![pages-build-deployment](https://github.com/BYU-PRISM/Seeq/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/BYU-PRISM/Seeq/actions/workflows/pages/pages-build-deployment)
+[![Documentation](https://github.com/BYU-PRISM/Seeq/actions/workflows/pages/pages-build-deployment/badge.svg)](https://byu-prism.github.io/Seeq/)
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/BYU-PRISM/Seeq/binder?urlpath=apps%2Fsysid_notebook.ipynb)
 
 <p align="left">
@@ -16,7 +16,7 @@
 A Seeq Add-on built-in python to identify input and output relationships for the system to create **digital twin**
 models for various analytics and machine learning tasks. System dynamics are identified thereby
 allowing users to get dynamic predictions quickly. The Add-on is fully integrated with
-Seeq Workbench. Cleaned and contextualized data from Seeq workbench can be used to identify dynamic models; the models can be pushed back into Seeq workbench. This framework supports both adhoc investigations as well as streaming predictions. The system identification framework can be used for a variety of tasks including simulation, digital twin construction, advanced process control, real-time optimization, etc.
+Seeq Workbench. Cleaned and contextualized data from Seeq workbench can be used to identify dynamic models; the models can be pushed back into Seeq workbench. This framework supports both ad-hoc investigations as well as streaming predictions. The system identification framework can be used for a variety of tasks including simulation, digital twin construction, advanced process control, real-time optimization, etc.
 
 <p align="center">
 <img src="https://github.com/BYU-PRISM/Seeq/blob/main/docs/images/Digital_twin_inout.png?raw=true" align="center" width="650" height="150">
@@ -36,8 +36,8 @@ The System Identification Add-on supports the construction of a variety of dynam
 
 ## ARX model
 ARX model is a system identification model that uses the linear correlation between previous and future values. ARX model consists of previous output terms (y) and previous input (u) terms multiplied by the linear coefficients (a, b). The linear combination of past input and output value computes the one-step-ahead prediction of output value(y<sub>k+1</sub>).
-Multiple iterations of the one-step-ahead prediction return the multi-step prediction (from y<sub>k+1</sub> to y<sub>k+n</sub>). The time window of the past input and output terms is shifted toward next segment for every iteration for multi-step prediction.
-Here is an example formular with <img src="https://render.githubusercontent.com/render/math?math=\large n_a=3"> and <img src="https://render.githubusercontent.com/render/math?math=\large n_b=2"> for the single input and single output system,
+Multiple iterations of the one-step-ahead prediction return the multi-step prediction (from y<sub>k+1</sub> to y<sub>k+n</sub>). The time window of the past input and output terms is shifted toward the next segment for every iteration for multi-step prediction.
+Here is an example formula with <img src="https://render.githubusercontent.com/render/math?math=\large n_a=3"> and <img src="https://render.githubusercontent.com/render/math?math=\large n_b=2"> for the single input and single output system,
 <p align="center">
 <img src="https://render.githubusercontent.com/render/math?math=\large y_{k %2B 1}=a_{0} y_{k} %2B a_{1} y_{k-1} %2B a_{2} y_{k-2} %2B b_{0} u_{k} %2B b_{1} u_{k-1}" >
 </p>
@@ -55,7 +55,7 @@ Here is an example formular with <img src="https://render.githubusercontent.com/
 <img src="https://render.githubusercontent.com/render/math?math=\large n_c">: Delay between input and output  
 <img src="https://render.githubusercontent.com/render/math?math=\large k">: present time step  
 
-Here is another example formular with **delay**  <img src="https://render.githubusercontent.com/render/math?math=\small (n_a=3, n_b=2, n_c=2)">,  
+Here is another example formula with **delay**  <img src="https://render.githubusercontent.com/render/math?math=\small (n_a=3, n_b=2, n_c=2)">,  
 
 <p align="center">
 <img src="https://render.githubusercontent.com/render/math?math=\large y_{k %2B 1}=a_{1} y_{k} %2B a_{2} y_{k-1} %2B a_{3} y_{k-2} %2B b_{1} u_{k-2-2} %2B b_{2} u_{k-1-2}" >
@@ -143,7 +143,7 @@ If you want to install **seeq-sysid** as a Seeq Add-on Tool, you will need:
 
 - Enable Add-on Tools (or External Tools) in the Seeq server
 
-*Note:* For older versions of Seeq Data Lab you can find installation guide [`here`](https://user-images.githubusercontent.com/55245976/137494969-43d93065-1e23-4e7c-952f-2397993eb269.mp4).
+*Note:* For older versions of Seeq Data Lab you can find the installation guide `here``](https://user-images.githubusercontent.com/55245976/137494969-43d93065-1e23-4e7c-952f-2397993eb269.mp4).
 <!-- (>= R50.5.0, >=R51.1.0, or >=R52.1.0) -->
 
 
@@ -201,11 +201,28 @@ run `developer_notebook.ipynb` notebook there.
 
 # Changelog
 
+## v0.6.0
+- MA model added
+- Units switch added
+- Version number added to the GUI
+
+## v0.5.1
+- Minor bugs fixed
+
+## v0.5.0
+
+- ARIMAX model added
+- Minor improvements
+- GUI object moved to app.py
+- Display results after calculation (Default)
+- Unit compatibility error fixed
+- Workbook pull step bypassed
+- Push functions improved
+
 ## v0.4.1
 - Hotfix for R57+ (search, pull, push functions)
 
-## v0.4
-
+## v0.4.0
 - Export ARX model (Gekko sysid outputs as a pickle)
 - Data Editor Added
 
@@ -251,7 +268,7 @@ Code related issues (e.g. bugs, feature requests) can be created in the
 Please cite this work as:
 
 ```shell
-seeq-sysid v0.4.1
+seeq-sysid v0.6.0
 BYU PRISM Group https://apm.byu.edu/prism/
 https://github.com/BYU-PRISM/Seeq
 ```

SysID Addon/TODO

@@ -1,7 +1,7 @@
 # Improvements
 - Add Auto Sysid
 - Train/Valid/Test Dataset
-
+- Add Reset Button
 .
 .
 .