Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Develop #38

Merged
merged 3 commits into from
Dec 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
4 changes: 3 additions & 1 deletion addon.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
],
Expand All @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -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
Binary file added docs/.doctrees/add_on_installation.doctree
Binary file not shown.
Binary file added docs/.doctrees/backend_calculations.doctree
Binary file not shown.
Binary file added docs/.doctrees/changelog.doctree
Binary file not shown.
Binary file added docs/.doctrees/citation.doctree
Binary file not shown.
Binary file added docs/.doctrees/cross_correlations.doctree
Binary file not shown.
Binary file added docs/.doctrees/docstrings.doctree
Binary file not shown.
Binary file added docs/.doctrees/environment.pickle
Binary file not shown.
Binary file added docs/.doctrees/examples.doctree
Binary file not shown.
Binary file added docs/.doctrees/github.doctree
Binary file not shown.
Binary file added docs/.doctrees/index.doctree
Binary file not shown.
Binary file added docs/.doctrees/installation.doctree
Binary file not shown.
Binary file added docs/.doctrees/introduction.doctree
Binary file not shown.
Binary file added docs/.doctrees/license.doctree
Binary file not shown.
Binary file added docs/.doctrees/preprocessor.doctree
Binary file not shown.
Binary file added docs/.doctrees/seeq_server_interactions.doctree
Binary file not shown.
Binary file added docs/.doctrees/user_guide.doctree
Binary file not shown.
Binary file added docs/.doctrees/user_interface.doctree
Binary file not shown.
20 changes: 14 additions & 6 deletions docs/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
31 changes: 22 additions & 9 deletions docs/_modules/seeq/addons/correlation/_cross_correlations.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
23 changes: 16 additions & 7 deletions docs/_modules/seeq/addons/correlation/_seeq_add_on.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
3 changes: 3 additions & 0 deletions docs/_sources/changelog.md.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Changelog
v0.1.95
---
Minor updates to addon manager packaging

v0.1.9
---
Expand Down
35 changes: 31 additions & 4 deletions docs/_sources/installation.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
17 changes: 3 additions & 14 deletions docs/_static/_sphinx_javascript_frameworks_compat.js
Original file line number Diff line number Diff line change
@@ -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
*
Expand Down
Binary file added docs/_static/addon_manager_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/addon_manager_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading