Merge pull request #38 from seeq12/develop

Develop
seeq12 · Dec 11, 2023 · 0cec8ff · 0cec8ff
2 parents a2d9817 + d15136f
commit 0cec8ff
Show file tree

Hide file tree

Showing 58 changed files with 470 additions and 203 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 <br>
 <p>
   <a href="https://www.seeq.com" rel="nofollow">
-    <img src="https://www.seeq.com/sites/default/files/seeq-content/seeq-logo-blue-web-33h.svg" alt="seeq" width="22%">
+    <img src="https://support.seeq.com/__assets-afb914a3-20be-451d-8157-92db51387860/image/seeq_logo.png" alt="seeq" width="22%">
   </a>
 </p>
 

diff --git a/addon.json b/addon.json
@@ -3,9 +3,10 @@
     "name": "Correlation Analysis",
     "description": "Determine cross correlations and time shifts to maximize correlations among signals",
     "version": "Input version here",
+    "maintainer":"Seeq Corporation https://seeq.com/",
     "license": "Apache-2.0 license",
     "icon": "fa fa-th",
-    "tags": {"maintainer":"Seeq"},
+    "tags": {"documentation":"Documentation website here https://seeq12.github.io/seeq-correlation/introduction.html" },
     "previews": [
       "additional_content/LargeMatrixExample.png"
     ],
@@ -14,6 +15,7 @@
         "name": "Correlation Analysis",
         "description": "Determine cross correlations and time shifts to maximize correlations among signals",
         "identifier": "com.seeq.addon.correlation.correlation",
+        "known_aliases": ["Correlation"],
         "type": "AddOnTool",
         "path": "data-lab-functions",
         "notebook_file_path": "correlation_analysis_master.ipynb",

diff --git a/docs/.buildinfo b/docs/.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: 88a6b7e57b24bdbe7e73d954fc7a4080
+config: e4910fd82dab3730886dc65e1965925c
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/add_on_installation.doctree b/docs/.doctrees/add_on_installation.doctree
diff --git a/docs/.doctrees/backend_calculations.doctree b/docs/.doctrees/backend_calculations.doctree
diff --git a/docs/.doctrees/changelog.doctree b/docs/.doctrees/changelog.doctree
diff --git a/docs/.doctrees/citation.doctree b/docs/.doctrees/citation.doctree
diff --git a/docs/.doctrees/cross_correlations.doctree b/docs/.doctrees/cross_correlations.doctree
diff --git a/docs/.doctrees/docstrings.doctree b/docs/.doctrees/docstrings.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/examples.doctree b/docs/.doctrees/examples.doctree
diff --git a/docs/.doctrees/github.doctree b/docs/.doctrees/github.doctree
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/installation.doctree b/docs/.doctrees/installation.doctree
diff --git a/docs/.doctrees/introduction.doctree b/docs/.doctrees/introduction.doctree
diff --git a/docs/.doctrees/license.doctree b/docs/.doctrees/license.doctree
diff --git a/docs/.doctrees/preprocessor.doctree b/docs/.doctrees/preprocessor.doctree
diff --git a/docs/.doctrees/seeq_server_interactions.doctree b/docs/.doctrees/seeq_server_interactions.doctree
diff --git a/docs/.doctrees/user_guide.doctree b/docs/.doctrees/user_guide.doctree
diff --git a/docs/.doctrees/user_interface.doctree b/docs/.doctrees/user_interface.doctree
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -3,13 +3,16 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; seeq-correlation 0.1.9 documentation</title>
+  <title>Overview: module code &mdash; seeq-correlation 0.1.95 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="shortcut icon" href="../_static/seeq-favicon.ico"/>
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
+        <script src="../_static/jquery.js"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
         <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
         <script src="../_static/doctools.js"></script>
         <script src="../_static/sphinx_highlight.js"></script>
@@ -23,14 +26,19 @@
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
-            <a href="../index.html" class="icon icon-home"> seeq-correlation
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            seeq-correlation
+              <img src="../_static/Seeq_logo_darkBlue_sm.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0.1.9
+                0.1.95
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
-    <input type="text" name="q" placeholder="Search docs" />
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
@@ -62,8 +70,8 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>Overview: module code</li>
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
       <li class="wy-breadcrumbs-aside">
       </li>
   </ul>

diff --git a/docs/_modules/seeq/addons/correlation/_cross_correlations.html b/docs/_modules/seeq/addons/correlation/_cross_correlations.html
@@ -3,13 +3,16 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>seeq.addons.correlation._cross_correlations &mdash; seeq-correlation 0.1.9 documentation</title>
+  <title>seeq.addons.correlation._cross_correlations &mdash; seeq-correlation 0.1.95 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="shortcut icon" href="../../../../_static/seeq-favicon.ico"/>
   <!--[if lt IE 9]>
     <script src="../../../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
+        <script src="../../../../_static/jquery.js"></script>
+        <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
         <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
         <script src="../../../../_static/doctools.js"></script>
         <script src="../../../../_static/sphinx_highlight.js"></script>
@@ -23,14 +26,19 @@
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
-            <a href="../../../../index.html" class="icon icon-home"> seeq-correlation
+
+
+
+          <a href="../../../../index.html" class="icon icon-home">
+            seeq-correlation
+              <img src="../../../../_static/Seeq_logo_darkBlue_sm.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0.1.9
+                0.1.95
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
-    <input type="text" name="q" placeholder="Search docs" />
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
@@ -62,9 +70,9 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../../../../index.html" class="icon icon-home"></a> &raquo;</li>
-          <li><a href="../../../index.html">Module code</a> &raquo;</li>
-      <li>seeq.addons.correlation._cross_correlations</li>
+      <li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
+      <li class="breadcrumb-item active">seeq.addons.correlation._cross_correlations</li>
       <li class="wy-breadcrumbs-aside">
       </li>
   </ul>
@@ -152,8 +160,13 @@ <h1>Source code for seeq.addons.correlation._cross_correlations</h1><div class="
 
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">_validate_df</span><span class="p">(</span><span class="n">df</span><span class="p">)</span>
-    <span class="n">grid</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">to_timedelta</span><span class="p">(</span><span class="n">to_offset</span><span class="p">(</span><span class="n">pd</span><span class="o">.</span><span class="n">infer_freq</span><span class="p">(</span><span class="n">df</span><span class="o">.</span><span class="n">index</span><span class="p">)))</span><span class="o">.</span><span class="n">total_seconds</span><span class="p">()</span>
-    <span class="n">sampling</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">Timedelta</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">grid</span><span class="si">}</span><span class="s1">s&#39;</span><span class="p">)</span>
+
+    <span class="k">try</span><span class="p">:</span>
+        <span class="n">grid</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">to_timedelta</span><span class="p">(</span><span class="n">to_offset</span><span class="p">(</span><span class="n">pd</span><span class="o">.</span><span class="n">infer_freq</span><span class="p">(</span><span class="n">df</span><span class="o">.</span><span class="n">index</span><span class="p">)))</span><span class="o">.</span><span class="n">total_seconds</span><span class="p">()</span>
+        <span class="n">sampling</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">Timedelta</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">grid</span><span class="si">}</span><span class="s1">s&#39;</span><span class="p">)</span>
+    <span class="k">except</span><span class="p">:</span>
+        <span class="n">grid</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">to_timedelta</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">diff</span><span class="p">(</span><span class="n">df</span><span class="o">.</span><span class="n">index</span><span class="p">)</span><span class="o">.</span><span class="n">min</span><span class="p">())</span><span class="o">.</span><span class="n">total_seconds</span><span class="p">()</span>
+        <span class="n">sampling</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">Timedelta</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">grid</span><span class="si">}</span><span class="s1">s&#39;</span><span class="p">)</span>
 
     <span class="k">if</span> <span class="ow">not</span> <span class="n">df</span><span class="o">.</span><span class="n">spy</span><span class="o">.</span><span class="n">grid</span><span class="p">:</span>
         <span class="n">df</span><span class="o">.</span><span class="n">spy</span><span class="o">.</span><span class="n">grid</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">grid</span><span class="si">}</span><span class="s1">s&#39;</span>

diff --git a/docs/_modules/seeq/addons/correlation/_seeq_add_on.html b/docs/_modules/seeq/addons/correlation/_seeq_add_on.html
@@ -3,13 +3,16 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>seeq.addons.correlation._seeq_add_on &mdash; seeq-correlation 0.1.9 documentation</title>
+  <title>seeq.addons.correlation._seeq_add_on &mdash; seeq-correlation 0.1.95 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="shortcut icon" href="../../../../_static/seeq-favicon.ico"/>
   <!--[if lt IE 9]>
     <script src="../../../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
+        <script src="../../../../_static/jquery.js"></script>
+        <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
         <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
         <script src="../../../../_static/doctools.js"></script>
         <script src="../../../../_static/sphinx_highlight.js"></script>
@@ -23,14 +26,19 @@
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
-            <a href="../../../../index.html" class="icon icon-home"> seeq-correlation
+
+
+
+          <a href="../../../../index.html" class="icon icon-home">
+            seeq-correlation
+              <img src="../../../../_static/Seeq_logo_darkBlue_sm.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0.1.9
+                0.1.95
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
-    <input type="text" name="q" placeholder="Search docs" />
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
@@ -62,9 +70,9 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../../../../index.html" class="icon icon-home"></a> &raquo;</li>
-          <li><a href="../../../index.html">Module code</a> &raquo;</li>
-      <li>seeq.addons.correlation._seeq_add_on</li>
+      <li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
+      <li class="breadcrumb-item active">seeq.addons.correlation._seeq_add_on</li>
       <li class="wy-breadcrumbs-aside">
       </li>
   </ul>
@@ -132,6 +140,7 @@ <h1>Source code for seeq.addons.correlation._seeq_add_on</h1><div class="highlig
 
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sdl_notebook_url</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">df</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">datasource</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">seeq_url</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
         <span class="n">display</span><span class="p">(</span><span class="n">HTML</span><span class="p">(</span><span class="s2">&quot;&lt;style&gt;#appmode-leave {display: none;}&quot;</span><span class="p">))</span>
+        <span class="n">spy</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">compatibility</span> <span class="o">=</span> <span class="mf">188.3</span>
         <span class="k">if</span> <span class="n">sdl_notebook_url</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">):</span>
             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Need either the SDL url or a pd.DataFrame with the signals to analyze&#39;</span><span class="p">)</span>
         <span class="k">if</span> <span class="n">sdl_notebook_url</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">):</span>

diff --git a/docs/_sources/changelog.md.txt b/docs/_sources/changelog.md.txt
@@ -1,4 +1,7 @@
 # Changelog
+v0.1.95
+---
+Minor updates to addon manager packaging
 
 v0.1.9
 ---

diff --git a/docs/_sources/installation.md.txt b/docs/_sources/installation.md.txt
@@ -2,22 +2,49 @@
 
 The backend of **seeq-correlation** requires **Python 3.7** or later.
 
-## Dependencies
+### Dependencies
 
 See [`requirements.txt`](https://github.com/seeq12/seeq-correlation/tree/master/requirements.txt) file for a list of
 dependencies and versions. Additionally, you will need to install the `seeq` module with the appropriate version that
 matches your Seeq server. For more information on the `seeq` module see [seeq at pypi](https://pypi.org/project/seeq/)
 
-## User Installation Requirements (Seeq Data Lab)
+
+### User Installation Requirements (Seeq Data Lab)
 
 If you want to install **seeq-correlation** as a Seeq Add-on Tool, you will need:
 
-- Seeq Data Lab (>= R52.1.5, >=R53.0.2, or >=R54)
+- Seeq Data Lab (>=R56)
 - `seeq` module whose version matches the Seeq server version
 - Seeq administrator access
 - Enable Add-on Tools in the Seeq server
 
-## User Installation (Seeq Data Lab)
+
+## Installation Steps
+### Seeq Add-on Installation via Add-on Manager (Recommended Method)
+
+The **seeq-correlation** Add-on can be installed via the Add-on Manager in the home page of the Seeq server. 
+Please refer to our knowledge base for more details on Add-on Manager [here](https://support.seeq.com/kb/latest/cloud/add-on-packaging).
+
+From the Seeq home page, click on the "Add-on" icon at the left of the screen and then click the "Add-on Manager" 
+icon in the new buttons displayed.
+
+<br>
+<td><img alt="image" src="_static/addon_manager_1.png"></td>
+<br>
+
+Now your in the Add-on Manager you will get a list of all the Add-ons available to you. Click on the "Install" button 
+next to the **seeq-correlation** Add-on.
+
+<br>
+<td><img alt="image" src="_static/addon_manager_2.png"></td>
+<br>
+
+After some time the "Install" button will change to "Installed" with a tick next to it and the Add-on will be available to use in Seeq Workbench. 
+
+### Upgrading the **seeq-correlation** Add-on 
+If there is a new version of the **seeq-correlation** Add-on available, you will see an "Upgrade" button next to the add-on in the Add-on Manager. Click on the "Upgrade" button to upgrade the add-on to the latest version.
+
+### Seeq Add-on Installation via Terminal Window (Depreciated Method)
 
 The latest build of the project can be found [here](https://pypi.org/project/seeq-correlation/) as a wheel file. The
 file is published as a courtesy to the user, and it does not imply any obligation for support from the publisher.

diff --git a/docs/_static/_sphinx_javascript_frameworks_compat.js b/docs/_static/_sphinx_javascript_frameworks_compat.js
@@ -1,20 +1,9 @@
-/*
- * _sphinx_javascript_frameworks_compat.js
- * ~~~~~~~~~~
- *
- * Compatability shim for jQuery and underscores.js.
- *
- * WILL BE REMOVED IN Sphinx 6.0
- * xref RemovedInSphinx60Warning
+/* Compatability shim for jQuery and underscores.js.
  *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
  */
 
-/**
- * select a different prefix for underscore
- */
-$u = _.noConflict();
-
-
 /**
  * small helper function to urldecode strings
  *

diff --git a/docs/_static/addon_manager_1.png b/docs/_static/addon_manager_1.png
diff --git a/docs/_static/addon_manager_2.png b/docs/_static/addon_manager_2.png