.. Seeq-SysID documentation master file, created by
   sphinx-quickstart on Thu Apr 28 00:39:43 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Seeq SysID Add-on
=========================================



`Seeq-System Identification <https://github.com/BYU-PRISM/Seeq>`_ is a Seeq Add-on built in python to identify
input and output relationship 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 contexutalized
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.    

.. image:: https://github.com/BYU-PRISM/Seeq/blob/main/docs/images/github_cover.png?raw=true
  :width: 700
  :align: center

|

.. raw:: html

    <div style="position: relative; padding-bottom: 5%; height: 0; overflow: hidden; max-width: 100%; height: auto;">
      <iframe width="100%" height="400" src="https://www.youtube.com/embed/glWIzPPJRnQ" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
    </div>

.. .. note::

..    This documentation is under active development.

Contents
--------

.. toctree::
   :maxdepth: 2

   Introduction <pages/introduction.md>
   System Identification <pages/system_identification.md>
   Installation <pages/installation.md>
   User Guide <pages/user_guide.md>
   Examples <pages/examples.md>
   Changelog <pages/changelog.md>
   License <pages/license.md>
   Citation <pages/citation.md>
   View on Github <pages/viewongithub.md>

.. Indices and tables
.. ------------------

.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`