BF/OA: Online adaptive PID controllers

doc/rtd/content/01_welcome/sub/deps.txt

@@ -1,7 +1,7 @@
-dill,0.3.6
+dill,0.3.9
+multiprocess,0.70.17
 numpy,1.24.2
-torch,2.0.0
-matplotlib,3.7.1
+PySide6,6.8.1
+matplotlib,3.10.0
 scipy,1.10.1
-multiprocess,0.70.14
 pandas,2.1.3

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer0_elementary/04_data.rst

@@ -2,7 +2,7 @@ Data Management
 ===============
 
 Data management in a framework is extremely important, which mostly refers to the organization, storage, and retrieval of data within the framework.
-In MLPro, our team also provides such functionalities as saving data, loading data, storing data, creating a buffer, and plotting data.
+MLPro also provides such functionalities as saving data, loading data, storing data, creating a buffer, and plotting data.
 This involves defining a data model that describes the structure and relationships between data elements, implementing mechanisms for storing and retrieving data, and managing data consistency and integrity.
 A well-designed data management system is essential for the efficient and effective processing of data within the framework.
 
@@ -14,7 +14,7 @@ The related data management classes can be accessed as follows:
 
     from mlpro.bf.data import * 
 
-In general, there are two main functionalities of data management in MLPro:
+In general, there are three main functionalities of data management in MLPro:
 
     1) **Data Storing**
         The second possibility is to store a bunch of data in MLPro's **DataStoring** class with three different layers, as follows:
@@ -53,6 +53,11 @@ In general, there are two main functionalities of data management in MLPro:
                 - Clearing the buffer. 
 
         For better understanding : :ref:`Howto BF-004: Buffers <Howto BF 004>`
+
+
+    3) **Configuration data**
+        A further class named **ConfigFile** enables persistent storage of program configuration data in a local JSON file.
+
 
 **Cross Reference**
     + :ref:`Howto BF-003: Store and plot data <Howto BF 003>`

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/04_control.rst

@@ -0,0 +1,22 @@
+.. _target_bf_control:
+Closed-loop Control
+===================
+
+Further descriptions coming soon...
+
+
+**Learn more**
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   control/*
+
+
+**Cross Reference**
+
+- :ref:`Howtos BF-Control <target_howto_bf_control>`
+- :ref:`API Reference BF-Control <target_api_bf_control>`
+- :ref:`API Reference BF-Control Pool Objects <target_pool_bf_control>`
+- :ref:`BF-Systems - Basics of State-based Systems <target_bf_systems>`

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/control/10_control_scenarios.rst

@@ -0,0 +1,19 @@
+.. _target_bf_control_scenarios:
+Control scenarios
+=================
+
+Further descriptions coming soon...
+
+
+**Learn more**
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   control_scenarios/*
+
+
+**Cross Reference**
+
+...

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/control/20_pool_objects.rst

@@ -0,0 +1,19 @@
+.. _target_bf_control_pool_objects:
+Pool objects
+============
+
+Further descriptions coming soon...
+
+
+**Learn more**
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   pool_objects/*
+
+
+**Cross Reference**
+
+...

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/control/control_scenarios/01_basic.rst

@@ -0,0 +1,16 @@
+.. _target_bf_control_scenario_basic:
+Basic control system
+--------------------
+
+Further descriptions coming soon...
+
+
+
+.. image::
+    images/01_control_system.drawio.png
+    :scale: 50%
+
+
+**Cross Reference**
+
+...

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/control/control_scenarios/02_basic_integrator.rst

@@ -0,0 +1,17 @@
+.. _target_bf_control_scenario_basic_int:
+Basic control system with additional integrator
+-----------------------------------------------
+
+Further descriptions coming soon...
+
+
+
+.. image::
+    images/02_control_system_with_integrator.drawio.png
+    :scale: 50%
+
+
+
+**Cross Reference**
+
+...

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/control/control_scenarios/03_cascade.rst

@@ -0,0 +1,17 @@
+.. _target_bf_control_scenario_cascade:
+Cascade control system
+----------------------
+
+Further descriptions coming soon...
+
+
+
+.. image::
+    images/03_cascade_control_system.drawio.png
+    :scale: 50%
+
+
+
+**Cross Reference**
+
+...

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/control/control_scenarios/images/01_control_system.drawio

@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2024-11-07T10:33:56.138Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/20.7.4 Chrome/106.0.5249.199 Electron/21.3.3 Safari/537.36" etag="nl9O9800xUGGUifAFp8L" version="20.7.4" type="device"><diagram id="6TlUjYz_UtGE6yc5RoQW" name="Page-1">1VhNc5swEP01HN3hw2B8tJ20PbQznfGhzVEGgdUIRIUcm/z6rkAy4sOOEzud9ARarbRi39PTCstbZYcvHBXb7yzG1HLt+GB5d5bruuF8Cg9pqRqL43pBY0k5iZWtNazJM1ZGW1l3JMZlx1EwRgUpusaI5TmORMeGOGf7rlvCaDdqgVI8MKwjRIfWnyQWW2V1gnnb8RWTdKtCh+6s6ciQdlZfUm5RzPaGybu3vBVnTDRv2WGFqcyezksz7vOJ3uPCOM7FJQOy5zXKJpunZ/srzhbBn+X+J5nIAXKaJ0R36otXLBecyZFlVQqcqdWLSqeEs10eYzmrbXnL/ZYIvC5QJHv3wAKwbUVGoeXAK0UbTJcoekzrYStGGYeunOXgv0wglsLclZMhStIcGhQn8E3LJ8wFASwWyixYoQep5cgQCaFUz2u5XpIkbhSBvYTPeMS9iAxWSoRkYygDDpOo8ipD44NhUkn9glmGBa/ARfVOFb5Vt7lv2eJrCmwNoni2MiLF0PQ4cwsivCgcX4HpbABppCENqEzrhsNbWicYcYI2kMk+xjiGXaCajIstS1mO6H1rXXZZ0Pp8YxKkGpjfWIhKwYt2gnWZARnn1S+z8SAn++Tr5t1BTd60KtUyOONML2OYQRZ8IOKX8W7EhFYbUjZ0xJMkKdmOR/gMFFqxEE+xOLcNGz+Z9UsoN7E/BeHMbwZxTJEgT129GiOVmu4HI/AZx7mCsMtfJ+jxslm8GtVSc8E5qgy3QjqUp+P4vX3i9OXqBX837PjDS7OC3mi9HJYkJRZWfy8dc/n27aUFYqCYFPPrtLInZDHCYTIUMugJohBvkjEpNPZGKEfqM8e5jdZ5bheUcCh2zpjYhe+ldcEpraOQ9A8ld33ZOsqfoXgPphqekz8D8vPy93bpci+Urumrpcu9Trfef4efrIlqUtkmrwwSBX92spSrAZqUNdILcHDC4lADofs1Gdc3qK7+P8UYq4/+rWT4l5dHGC4QQ03/l7WRbV1VG+lqp61wHswCZ7TaeU099WZ1mV6oLs7r1OU/EJf5xzh84oW8HLe4guUzkV9ShygBGKE9IorKkkTarNzO6sOl+L+I67XFbU98+neuE7XtzUpFe6A1wKriGK7Pgm9y63WR0zfiCFIM9eXwTpyROG5IguHQqaubBkNVkMPk/tLy7668OQ2QPkfuwfFw/D+j1meZv0DGN/Is9LwOeFoLrqTEdNaddd6d4P02/nSkqsgKNBkeOxyJsWOHUlKU+OWiAJVF8ycsIQcpGmfPfH9YRWAn9vFsrIqYBzMPBedIOKDrresJ59R11agnwtuUE9Bs/841LGh/cnr3fwE=</diagram></mxfile>

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/control/control_scenarios/images/02_control_system_with_integrator.drawio

@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2024-11-07T10:35:33.419Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/20.7.4 Chrome/106.0.5249.199 Electron/21.3.3 Safari/537.36" etag="Zro2VQ5gvN6TWJH1leLn" version="20.7.4" type="device"><diagram id="6TlUjYz_UtGE6yc5RoQW" name="Page-1">7Vlbc+I2GP01PJLxBRvzGMits2lnZ9h2t4/Clo0a2fLKAkx+fT/ZEr4D2ZA0O9snrE/SJ0vn6OhYjOxFnN9zlK5/ZwGmI8sI8pF9M7Isy5tN4EdG9mXEtGy3jEScBCpWBZbkGaugoaIbEuCs0VAwRgVJm0GfJQn2RSOGOGe7ZrOQ0eaoKYpwJ7D0Ee1Gv5JArFXUdGdVxQMm0VoN7VnTsiJGurGaSbZGAdvVQvbtyF5wxkT5FOcLTOXq6XUp+90N1B5ejONEnNPh7g//y+RLsEqeUO5E4n4ae/FYZdkiulETXrBEcCY7ZvtM4BgedgSmAokSgSOOBONqQmKvV4mzTRJgOZAxsue7NRF4mSJf1u6AGBBbi5hCyYRHilaYzpH/FBXdFoxCRvsmYQm0n4cwvqKBJZMhSqIEChSHMM35FnNBAJ5rFRYs1Z3U68ghQkKpzjuy7DAMLd+HeAZTe8KtERm8KRGSoJ4csLuuepFgaJzXQmqd7zGLseB7aKJqJwryfbO4qwjkGiq2rnHH1kGkSBsdMle4woOCth/m+HmJ4vFq+2w84Pja/T7ffSXjaQdmX8PsUrmsK8DUjYoFRpygFaxkG2McwMZQRcbFmkUsQfS2is6bLKjaPDIJUgHMP1iIvYIXbQRrMgNWnO+/yf5Xji7+rdIVhZu8UdqrUo0z5uQ8hh3IMoR2xjbcx0fWVKsR4hFWXR8e/1p+4ve7b1vX+pORT3buTXU7uXzncGdsXJmWU/bhmCJBtk0p6iOHyvaZwR6tUrluk4em2+JX+e6qV106dCLdkIVhhkWHhoe3/3FmDgoQxa+UmZYGBAh7YVcDoMb1PbwK+1SkRitP9tQKbl5GJuyWTnhdnTCtHp3w3kom3CGZoLDoH0op2jt+SDnMc5SjBvlx5fhxsbC6YtHbbvJisbBeJxVvv8Ot4R0OpDLqvKqRyP2+kcaoAGicFUhfQwPTS/MCCF2vybhUZuXXUow+a/G+kuF10NU2sSkZZ0A7GYC2x6q8ItuH8DfmlWHOGg7nyvG8E1pVlD5jTgA5zAesD86JqOkglA4yCM9VZlnQiS9tl47ZoJMKaL1MAcEtebbV2BTa7V7YPR32mk5RTvk/dU/O+b4ew8dw11G9q6lvEf6Fpr6f2ca7MvvYmX2S2S/8EPgJjvbZx7B+wbW86KlwhcgdkTMphsgAGKFb+BRlGfF1WDU7ejqfi/9JXF+rRy05al8WDHzMXexDzehoDbAqPQzXZsGj3HpN5PRVjg9LLA+wzmVOTIKgJAmGk7w4pUsMi2GKeTrzkXNz6U/+Y+TumLPDXaN6v1H9Oq9/I089224eUeZFjqjJtJl11kzwdht/0uPp4xSNu8dO/30hDEHSDJ+25ChLy1vdkORSNI46bqfr4bEZOHja5+Fn7tRG7jESduh6aTdvegP3MzU3772RmT/m0Wqw/jZ85/s/hrLWmbwbhlCs/i0od3L1p4t9+y8=</diagram></mxfile>

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/control/control_scenarios/images/03_cascade_control_system.drawio

@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2024-11-08T16:50:56.670Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/20.7.4 Chrome/106.0.5249.199 Electron/21.3.3 Safari/537.36" etag="QlqFhS4QGj9Fpl1QDqlX" version="20.7.4" type="device"><diagram id="6TlUjYz_UtGE6yc5RoQW" name="Page-1">7Vvbdto6EP0aHunyDWM/BsilPelqu3Ky0uRNsWXQiY2ILQLk649kS/gi2RgCIbR5ijWSJVl7a2bP0HbMYbS8jMFs8h37MOwYmr/smKOOYRiOa9E/zLLKLLph2pllHCOf23LDDXqF3Khx6xz5MCkNJBiHBM3KRg9Pp9AjJRuIY7woDwtwWF51BsZQMtx4IJStd8gnE27VbTfvuIJoPOFLO0Y/64iAGMy/JJkAHy8KJvO8Yw5jjEn2FC2HMGSnJ84le++ipne9sRhOSZsXnlxPvwJXy4tvD672fbqyg+HPrpHN8gLCOf/gIUg84MPsSEmM2RTJKiEw4p9BVuJsYjyf+pBNr3XMwWKCCLyZAY/1LigdqG1CopC2dPoYgkcYDoD3NE5fG+IQx7Rriqd0/CCga3HwDTYZCNF4ShshDOjHDV5gTBAF5YybCZ6Jl/h22BIBCkMxb8cwgyAwPI/aE/oZT7CyIqY7RYTR0mELyqfJD5gtDZcFEz/dS4gjSOIVHcJ7LQ70qtxcFGhj29w4KVDGEgwBnKvj9dQ5nPSBI6pGN3q9AVH38eVVu4LRmf08WNyhriHD+2NOYFwCN8T0ME8OWmjXQ7sHLHWjDKauKdDsqdA0rT2gqbyrugTmV+rz/gAwHQ/Wg+mDZJLuXd8PsrZbQVZxT21DAawhPPver6kM7DADNEzR1d8GaOW0fQCdQD5t2mN7DnwMVHjloOsOe1NEMtbJuAcQ42G2mz1AZFY8qaG6fCqInIM50nqE/A7biR0y+j/GJZzs5zkL7un5dZP0AM8Yns5smR6U6KdPY/b3hofZvw9xvffhIO9JkK+9bA52hhukOlN9UaFPxSRv4phM8BhPQXieWwdlYPMx18yRZ+f9HyRkxdEAc4LLYNNDj1e/+ftp4541vvREc7Qsdo5WvFWE2GK9S0R+52/S1r14jz7nk7CGmKNFrFiTqo4kCZ7HHmwAgmcQBMRjSDZ7UXbkbSinfeGXOoYhIOilrPdVdOJT/cSIfkI+BAdBQjdW5dt6xd0p6B6DTxIvpv4Zy6NyXKnlArEvSZdIKDBEjPBCkCTIE2Y+rDFyt8V/I6674ih0QdkBmVVRnvGPv7R/rEW+W/A3lFUzvke1Z7lm16+MntBjHj1m5qAlRRYh38+IAmlEAo/pfAzHdKn0W3uDTm+kYMI2t71NlGjivBQ61hk+33KnmESr73ffMc0SpsJFvJEpVr88q1ue4HD+wFKokGgGunJEigGpi0hhiGYJ3CwiQDLL6ikBWjJ/0qgRerLqgLrfg32V6nDtvgnsJm5KLD64/nAq8sOR5YfznurDrlMfqeCswv0CYpTeiyNpEDlmCE2Sy5D7ol5p0iQFijV7HLVi0RsVy+5hyGgpQ9qGq7Wb0izLPZQSoXEZrAojuJOvdW26rVWLWJWiYuUFw2gcTx+yLezqB+8vXfd1pn27H2Gth0e/EHT/2ZQvG9IV+MOzJ9c4YvKkROid8+W/DnFdP2a+rITclSCvzZcL4UpG7gOnzK1Lo2kQ3D79bXJ2xbjTdOX2lya9iQ2mygGk/I5lPnyq1Ha3vmdvvvTvqlL7O935ky6TbZcEC4kqngtrHkCitnUV5r5dhVob9rWapGpDSaVetMoydK9Jt/KwnPYcF3XgkwpqzWFrE+F3j2uKsm5T/PsgcW37EoyCDJ/BTRHc+i0U7aGC2/Xz64N+9nB7e3Gu3aIf/y5/3S0UOYy6BNMigbFqEpiPI4S3q9O8RQgfsG7TpIs3+pnD/MywdQHGqARN02wuwPSdxvHlAsx7xk1ZGxZ+zzi9CFnjdTdLwt2Za+6ZuZwxXe2LZlhWiTXi16c3Kj7Htss+3KpMUaP4DsRLpVvf4nf9gns2T4mwh65TKM9VwdamOvr767mmXberU3xKuZbVSfOIhQolzLJsb/lz2kkFqqPUJxX6qummHfze02b+b+qzoJH/1wTz/H8=</diagram></mxfile>

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/control/pool_objects/10_operators.rst

@@ -0,0 +1,19 @@
+.. _target_bf_control_pool_operators:
+Operators
+=========
+
+Further descriptions coming soon...
+
+
+**Learn more**
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   operators/*
+
+
+**Cross Reference**
+
+...

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/control/pool_objects/20_controllers.rst

@@ -0,0 +1,19 @@
+.. _target_bf_control_pool_controllers:
+Controllers
+===========
+
+Further descriptions coming soon...
+
+
+**Learn more**
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   controllers/*
+
+
+**Cross Reference**
+
+...

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/control/pool_objects/30_controlled_systems.rst

@@ -0,0 +1,19 @@
+.. _target_bf_control_pool_systems:
+Controlled systems
+==================
+
+Further descriptions coming soon...
+
+
+**Learn more**
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   controlled_systems/*
+
+
+**Cross Reference**
+
+...

doc/rtd/content/03_machine_learning/mlpro_oa/sub/05_oa_control.rst

@@ -0,0 +1,22 @@
+.. _target_oa_control:
+Online Adaptive Closed-loop Control
+===================================
+
+Further descriptions coming soon...
+
+
+**Learn more**
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   oa_control/*
+
+
+**Cross Reference**
+
+- :ref:`Howtos OA-Control <target_howto_oa_control>`
+- :ref:`API Reference OA-Control <target_api_oa_control>`
+- :ref:`API Reference OA-Control Pool Objects <target_api_pool_oa_control>`
+- :ref:`BF-Control - Basics of Closed-loop Control <target_bf_control>`

doc/rtd/content/03_machine_learning/mlpro_oa/sub/oa_control/10_pool_objects.rst

@@ -0,0 +1,19 @@
+.. _target_oa_control_pool_objects:
+Pool objects
+============
+
+Further descriptions coming soon...
+
+
+**Learn more**
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   pool_objects/*
+
+
+**Cross Reference**
+
+...

doc/rtd/content/03_machine_learning/mlpro_oa/sub/oa_control/pool_objects/10_controllers.rst

@@ -0,0 +1,19 @@
+.. _target_oa_control_pool_controllers:
+Online-adaptive controllers
+===========================
+
+Further descriptions coming soon...
+
+
+**Learn more**
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   controllers/*
+
+
+**Cross Reference**
+
+...

doc/rtd/content/03_machine_learning/mlpro_oa/sub/oa_control/pool_objects/controllers/10_rl_policies.rst

@@ -0,0 +1,19 @@
+.. _target_oa_control_pool_controllers_rl_policies:
+RL Policies
+===========
+
+Further descriptions coming soon...
+
+
+**Learn more**
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   rl_policies/*
+
+
+**Cross Reference**
+
+...

doc/rtd/content/03_machine_learning/mlpro_oa/sub/oa_control/pool_objects/controllers/rl_policies/10_rl_pid.rst

@@ -0,0 +1,9 @@
+.. _target_oa_control_pool_controllers_rl_policies_rl_pid:
+RL PID Controller
+=================
+
+Further descriptions coming soon...
+
+**Cross Reference**
+
+...

doc/rtd/content/99_appendices/appendix1/sub/mlpro_bf/layer3_application_support/04_control.rst

@@ -0,0 +1,11 @@
+.. _target_howto_bf_control:
+Closed-loop Control
+===================
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   control/*      
+
+

doc/rtd/content/99_appendices/appendix1/sub/mlpro_oa/03_control.rst

@@ -0,0 +1,9 @@
+.. _target_howto_oa_control:
+Online Adaptive Control
+=======================
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   control/* 

doc/rtd/content/99_appendices/appendix2/sub/core/mlpro_bf/layer0_elementary/02_data_management.rst

@@ -5,7 +5,19 @@ BF-DATA - Data Management
 .. image:: images/MLPro-BF-Data_class_diagram.drawio.png
    :scale: 50%
 
-.. automodule:: mlpro.bf.data
+.. automodule:: mlpro.bf.data.buffers
+   :members:
+   :undoc-members:
+   :private-members:
+   :show-inheritance:
+
+.. automodule:: mlpro.bf.data.datastoring
+   :members:
+   :undoc-members:
+   :private-members:
+   :show-inheritance:
+
+.. automodule:: mlpro.bf.data.cfg_file
    :members:
    :undoc-members:
    :private-members:

doc/rtd/content/99_appendices/appendix2/sub/core/mlpro_bf/layer0_elementary/03_plot.rst

@@ -5,8 +5,32 @@ BF-PLOT - Plotting and Visualization
 .. image:: images/MLPro-BF-Plot_class_diagram.drawio.png
    :scale: 50%
 
-.. automodule:: mlpro.bf.plot
+.. automodule:: mlpro.bf.plot.basics
    :members:
    :undoc-members:
    :private-members:
-   :show-inheritance:
+   :show-inheritance:
+
+.. automodule:: mlpro.bf.plot.backends.basics
+   :members:
+   :undoc-members:
+   :private-members:
+   :show-inheritance:
+
+.. automodule:: mlpro.bf.plot.backends.qtagg
+   :members:
+   :undoc-members:
+   :private-members:
+   :show-inheritance:
+
+.. automodule:: mlpro.bf.plot.backends.tkagg
+   :members:
+   :undoc-members:
+   :private-members:
+   :show-inheritance:
+
+.. automodule:: mlpro.bf.plot.dataplotting
+   :members:
+   :undoc-members:
+   :private-members:
+   :show-inheritance: