Initial setup #1

fhswf · Feb 11, 2024 · fd36a16 · fd36a16
1 parent 36c823a
commit fd36a16
Show file tree

Hide file tree

Showing 105 changed files with 1,654 additions and 1,675 deletions.
diff --git a/.github/workflows.inactive/ci.yml b/.github/workflows.inactive/ci.yml
diff --git a/.github/workflows.inactive/doc_gen.yml b/.github/workflows.inactive/doc_gen.yml
diff --git a/.github/workflows.inactive/pypi_deploy.yml → .github/workflows/pypi_deploy.yml b/.github/workflows.inactive/pypi_deploy.yml → .github/workflows/pypi_deploy.yml
diff --git a/doc/rtd/_build/html/.buildinfo b/doc/rtd/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 05c3a2b544df5b9237c8998922cebdf6
+config: dc6aea52cd58074cad26b0d960f5bd61
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/doc/rtd/_build/html/.doctrees/README.doctree b/doc/rtd/_build/html/.doctrees/README.doctree
diff --git a/...ild/html/.doctrees/content/01_example_pool/01_howtos_streams/howto.bf.streams.001.doctree b/...ild/html/.doctrees/content/01_example_pool/01_howtos_streams/howto.bf.streams.001.doctree
diff --git a/doc/rtd/_build/html/.doctrees/content/01_example_pool/01_streams.doctree b/doc/rtd/_build/html/.doctrees/content/01_example_pool/01_streams.doctree
diff --git a/doc/rtd/_build/html/.doctrees/content/01_getting_started/main.doctree b/doc/rtd/_build/html/.doctrees/content/01_getting_started/main.doctree
diff --git a/doc/rtd/_build/html/.doctrees/content/01_getting_started/sub/01_prerequisites.doctree b/doc/rtd/_build/html/.doctrees/content/01_getting_started/sub/01_prerequisites.doctree
diff --git a/doc/rtd/_build/html/.doctrees/content/02_api/00_basic.doctree b/doc/rtd/_build/html/.doctrees/content/02_api/00_basic.doctree
diff --git a/doc/rtd/_build/html/.doctrees/content/02_api/01_streams.doctree b/doc/rtd/_build/html/.doctrees/content/02_api/01_streams.doctree
diff --git a/doc/rtd/_build/html/.doctrees/content/02_api/02_cluster_analysis.doctree b/doc/rtd/_build/html/.doctrees/content/02_api/02_cluster_analysis.doctree
diff --git a/doc/rtd/_build/html/.doctrees/content/02_api/03_anomaly_detection.doctree b/doc/rtd/_build/html/.doctrees/content/02_api/03_anomaly_detection.doctree
diff --git a/doc/rtd/_build/html/.doctrees/content/02_example_pool/custom_section1/main.doctree b/doc/rtd/_build/html/.doctrees/content/02_example_pool/custom_section1/main.doctree
diff --git a/...rtd/_build/html/.doctrees/content/02_example_pool/custom_section1/sub/01_overview.doctree b/...rtd/_build/html/.doctrees/content/02_example_pool/custom_section1/sub/01_overview.doctree
diff --git a/doc/rtd/_build/html/.doctrees/content/03_about/01_versions.doctree b/doc/rtd/_build/html/.doctrees/content/03_about/01_versions.doctree
diff --git a/...dices/appendix1/sub/04_disclaimer.doctree → ...es/content/03_about/02_disclaimer.doctree b/...dices/appendix1/sub/04_disclaimer.doctree → ...es/content/03_about/02_disclaimer.doctree
diff --git a/doc/rtd/_build/html/.doctrees/content/03_api/custom_section2/main.doctree b/doc/rtd/_build/html/.doctrees/content/03_api/custom_section2/main.doctree
diff --git a/doc/rtd/_build/html/.doctrees/content/03_api/custom_section2/sub/01_overview.doctree b/doc/rtd/_build/html/.doctrees/content/03_api/custom_section2/sub/01_overview.doctree
diff --git a/doc/rtd/_build/html/.doctrees/content/04_appendices/appendix1/main.doctree b/doc/rtd/_build/html/.doctrees/content/04_appendices/appendix1/main.doctree
diff --git a/doc/rtd/_build/html/.doctrees/content/04_appendices/appendix1/sub/01_versions.doctree b/doc/rtd/_build/html/.doctrees/content/04_appendices/appendix1/sub/01_versions.doctree
diff --git a/doc/rtd/_build/html/.doctrees/content/04_appendices/appendix1/sub/02_publications.doctree b/doc/rtd/_build/html/.doctrees/content/04_appendices/appendix1/sub/02_publications.doctree
diff --git a/doc/rtd/_build/html/.doctrees/content/04_appendices/appendix1/sub/03_contribution.doctree b/doc/rtd/_build/html/.doctrees/content/04_appendices/appendix1/sub/03_contribution.doctree
diff --git a/doc/rtd/_build/html/.doctrees/environment.pickle b/doc/rtd/_build/html/.doctrees/environment.pickle
diff --git a/doc/rtd/_build/html/.doctrees/index.doctree b/doc/rtd/_build/html/.doctrees/index.doctree
diff --git a/doc/rtd/_build/html/README.html b/doc/rtd/_build/html/README.html
@@ -1,22 +1,24 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Documentation &mdash; MLPro Documentations 1.0.0 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
-      <link rel="stylesheet" href="_static/copybutton.css" type="text/css" />
-      <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+  <title>Documentation &mdash; MLPro Documentations 0.5.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+      <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
+      <link rel="stylesheet" type="text/css" href="_static/custom.css?v=3876c83e" />
+
+
     <link rel="shortcut icon" href="_static/favicon.ico"/>
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=8d563738"></script>
+        <script src="_static/documentation_options.js?v=1dd76d02"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="_static/clipboard.min.js?v=a7894cd8"></script>
@@ -46,21 +48,21 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="content/01_getting_started/sub/01_prerequisites.html">1. Prerequisites</a></li>
-</ul>
-<p class="caption" role="heading"><span class="caption-text">Example Pool</span></p>
+              <p class="caption" role="heading"><span class="caption-text">MLPro-Int-River - Example Pool</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="content/02_example_pool/custom_section1/main.html">2. Custom Section</a></li>
+<li class="toctree-l1"><a class="reference internal" href="content/01_example_pool/01_streams.html">Reuse of River Data Streams</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">API</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="content/03_api/custom_section2/main.html">3. Custom Section</a></li>
+<li class="toctree-l1"><a class="reference internal" href="content/02_api/00_basic.html">Wrapper Root Class</a></li>
+<li class="toctree-l1"><a class="reference internal" href="content/02_api/01_streams.html">Wrappers for River Data Streams</a></li>
+<li class="toctree-l1"><a class="reference internal" href="content/02_api/02_cluster_analysis.html">Wrappers for River Cluster Analyzers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="content/02_api/03_anomaly_detection.html">Wrappers for River Anomaly Detectors</a></li>
 </ul>
-<p class="caption" role="heading"><span class="caption-text">Appendices</span></p>
+<p class="caption" role="heading"><span class="caption-text">About</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="content/04_appendices/appendix1/main.html">A1 - Project MLPro-Int-River</a></li>
+<li class="toctree-l1"><a class="reference internal" href="content/03_about/01_versions.html">Release Notes</a></li>
+<li class="toctree-l1"><a class="reference internal" href="content/03_about/02_disclaimer.html">Disclaimer</a></li>
 </ul>
 
         </div>

diff --git a/doc/rtd/_build/html/_images/MLPro-Int-River-Cluster_Analyzers.drawio.png b/doc/rtd/_build/html/_images/MLPro-Int-River-Cluster_Analyzers.drawio.png
diff --git a/doc/rtd/_build/html/_images/MLPro-Int-River-Streams.drawio.png b/doc/rtd/_build/html/_images/MLPro-Int-River-Streams.drawio.png
diff --git a/doc/rtd/_build/html/_images/MLPro-Int-River.drawio.png b/doc/rtd/_build/html/_images/MLPro-Int-River.drawio.png
diff --git a/..._sources/content/01_example_pool/01_howtos_streams/howto.bf.streams.001.rst.txt b/..._sources/content/01_example_pool/01_howtos_streams/howto.bf.streams.001.rst.txt
@@ -0,0 +1,21 @@
+.. _Howto_BF_STREAMS_001:
+Howto BF-STREAMS-001: Accessing Native Data From MLPro
+======================================================
+
+**Executable code**
+
+.. literalinclude:: ../../../../../../../../../test/howtos/bf/howto_bf_streams_001_accessing_native_data_from_mlpro.py
+	:language: python
+
+
+
+**Results**
+
+.. image::
+    images/howto_bf_streams_001_accessing_native_data_from_mlpro.png
+    :width: 600px
+
+
+
+**Cross Reference**
+    - :ref:`API Reference: Streams <api_streams>`
diff --git a/doc/rtd/_build/html/_sources/content/01_example_pool/01_streams.rst.txt b/doc/rtd/_build/html/_sources/content/01_example_pool/01_streams.rst.txt
@@ -0,0 +1,9 @@
+.. _howto_streams:
+Reuse of River Data Streams
+==========================
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   01_howtos_streams/* 
diff --git a/doc/rtd/_build/html/_sources/content/01_getting_started/main.rst.txt b/doc/rtd/_build/html/_sources/content/01_getting_started/main.rst.txt
diff --git a/...td/_build/html/_sources/content/01_getting_started/sub/01_prerequisites.rst.txt b/...td/_build/html/_sources/content/01_getting_started/sub/01_prerequisites.rst.txt
diff --git a/doc/rtd/_build/html/_sources/content/02_api/00_basic.rst.txt b/doc/rtd/_build/html/_sources/content/02_api/00_basic.rst.txt
@@ -0,0 +1,15 @@
+.. _api_basics:
+Wrapper Root Class
+==================
+
+.. image:: images/MLPro-Int-River.drawio.png
+   :scale: 50%
+
+
+.. automodule:: mlpro_int_river.wrappers.basics
+    :members:
+    :undoc-members:
+    :private-members:
+    :show-inheritance:
+    :private-members:
+
diff --git a/doc/rtd/_build/html/_sources/content/02_api/01_streams.rst.txt b/doc/rtd/_build/html/_sources/content/02_api/01_streams.rst.txt
@@ -0,0 +1,15 @@
+.. _api_streams:
+Wrappers for River Data Streams
+==============================
+
+.. image:: images/MLPro-Int-River-Streams.drawio.png
+   :scale: 50%
+
+
+.. automodule:: mlpro_int_river.wrappers.streams
+    :members:
+    :undoc-members:
+    :private-members:
+    :show-inheritance:
+    :private-members:
+
diff --git a/doc/rtd/_build/html/_sources/content/02_api/02_cluster_analysis.rst.txt b/doc/rtd/_build/html/_sources/content/02_api/02_cluster_analysis.rst.txt
@@ -0,0 +1,15 @@
+.. _api_ca:
+Wrappers for River Cluster Analyzers
+====================================
+
+.. image:: images/MLPro-Int-River-Cluster_Analyzers.drawio.png
+   :scale: 50%
+
+
+.. automodule:: mlpro_int_river.wrappers.clusteranalyzers
+    :members:
+    :undoc-members:
+    :private-members:
+    :show-inheritance:
+    :private-members:
+
diff --git a/doc/rtd/_build/html/_sources/content/02_api/03_anomaly_detection.rst.txt b/doc/rtd/_build/html/_sources/content/02_api/03_anomaly_detection.rst.txt
@@ -0,0 +1,15 @@
+.. _api_ad:
+Wrappers for River Anomaly Detectors
+====================================
+
+.. image:: images/MLPro-Wrappers-River-Anomaly_Detectors.drawio.png
+   :scale: 50%
+
+
+.. automodule:: mlpro_int_river.wrappers.anomalydetectors
+    :members:
+    :undoc-members:
+    :private-members:
+    :show-inheritance:
+    :private-members:
+
diff --git a/doc/rtd/_build/html/_sources/content/02_example_pool/custom_section1/main.rst.txt b/doc/rtd/_build/html/_sources/content/02_example_pool/custom_section1/main.rst.txt
diff --git a/...d/html/_sources/content/02_example_pool/custom_section1/sub/01_overview.rst.txt b/...d/html/_sources/content/02_example_pool/custom_section1/sub/01_overview.rst.txt
diff --git a/doc/rtd/_build/html/_sources/content/03_about/01_versions.rst.txt b/doc/rtd/_build/html/_sources/content/03_about/01_versions.rst.txt
@@ -0,0 +1,10 @@
+Release Notes
+=============
+
+Release Notes on GitHub:
+    - `Latest release <https://github.com/fhswf/MLPro-Int-River/releases/latest>`_
+    - `Release history <https://github.com/fhswf/MLPro-Int-River/releases>`_
+
+
+Upcoming:
+    - `Upcoming release <https://github.com/fhswf/MLPro-Int-River/issues?q=is%3Aissue+label%3A%22next+release%22>`_    
diff --git a/...dices/appendix1/sub/04_disclaimer.rst.txt → ...es/content/03_about/02_disclaimer.rst.txt b/...dices/appendix1/sub/04_disclaimer.rst.txt → ...es/content/03_about/02_disclaimer.rst.txt
diff --git a/doc/rtd/_build/html/_sources/content/03_api/custom_section2/main.rst.txt b/doc/rtd/_build/html/_sources/content/03_api/custom_section2/main.rst.txt
diff --git a/...rtd/_build/html/_sources/content/03_api/custom_section2/sub/01_overview.rst.txt b/...rtd/_build/html/_sources/content/03_api/custom_section2/sub/01_overview.rst.txt
diff --git a/doc/rtd/_build/html/_sources/content/04_appendices/appendix1/main.rst.txt b/doc/rtd/_build/html/_sources/content/04_appendices/appendix1/main.rst.txt
diff --git a/...td/_build/html/_sources/content/04_appendices/appendix1/sub/01_versions.rst.txt b/...td/_build/html/_sources/content/04_appendices/appendix1/sub/01_versions.rst.txt
diff --git a/...build/html/_sources/content/04_appendices/appendix1/sub/02_publications.rst.txt b/...build/html/_sources/content/04_appendices/appendix1/sub/02_publications.rst.txt