Package: seeq-correlation
seeq-correlationis a Python module to calculate and monitor cross-correlations among time-series signals. It also
calculates the time shifts (lead or lag) that maximize the cross-correlations of each signal pair. The module includes a
user interface (UI) designed to interact with the Seeq server. Specifically, the UI can be installed as an Add-on Tool
in Seeq Workbench.DocumentationThe documentation forseeq-correlationcan be foundhere.User Guideseeq-correlation User Guideprovides a more in-depth explanation of correlation analysis and how seeq-correlation works. Examples of typical types
of analyses usingseeq-correlationcan be found in the
sectionUse Cases.InstallationThe backend ofseeq-correlationrequiresPython 3.7or later.DependenciesSeerequirements.txtfile for a list of
dependencies and versions. Additionally, you will need to install theseeqmodule with the appropriate version that
matches your Seeq server. For more information on theseeqmodule seeseeq at pypiUser Installation Requirements (Seeq Data Lab)If you want to installseeq-correlationas a Seeq Add-on Tool, you will need:Seeq Data Lab (>= R52.1.5, >=R53.0.2, or >=R54)seeqmodule whose version matches the Seeq server versionSeeq administrator accessEnable Add-on Tools in the Seeq serverUser Installation (Seeq Data Lab)The latest build of the project can be foundhereas 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.Create anewSeeq Data Lab project and open theTerminalwindowRunpip install seeq-correlationRunpython -m seeq.addons.correlation [--users <users_list> --groups <groups_list>]DevelopmentWe welcome new contributors of all experience levels. TheDevelopment Guidehas detailed information about
contributing code, documentation, tests, etc.Important linksOfficial source code repo:https://github.com/seeq12/seeq-correlationIssue tracker:https://github.com/seeq12/seeq-correlation/issuesSource codeYou can get started by cloning the repository with the command:gitclonegit@github.com:seeq12/seeq-correlation.gitInstallation from sourceFor development work, it is highly recommended creating a python virtual environment and install the package in that
working environment. If you are not familiar with python virtual environments, you can take a
lookhereOnce your virtual environment is activated, you can installseeq-correlationfrom source with:pythonsetup.pyinstallTestingThere are several types of testing available forseeq-correlationAutomatic TestingAfter installation, you can launch the test suite from the root directory of the project (i.e.seeq-correlationdirectory). You will need to have pytest >= 5.0.1 installedTo run all tests:pytestThere are several pytest markers set up in the project. You can find the description of the marks in thepytest.inifile. You can use the-mflag to run only a subset of tests. For example, to run only thebackendtests, you can
use:pytest-mbackendThe integration tests requires a connection to a Seeq server. The tests are configured to try to access a local Seeq
server with the data directory set up inProgramData/Seeq/dataof the local drive. However, you can set theseeq_url,credentials_fileconfiguration options in thetest_config.inifile to run the integration tests on a
remote Seeq server, or change the local seeq data directory withdata_dir.Note:Remember that theseeqmodule version in your local environment should match the Seeq server versionUser Interface TestingTo test the UI, use thedeveloper_notebook.ipynbin thedevelopmentfolder of the project. This notebook can also be
used while debugging from your IDE. You can also create a whl first, install it on your virtual environment, and then
rundeveloper_notebook.ipynbnotebook there.ChangelogThe changelog can be foundhereSupportCode related issues (e.g. bugs, feature requests) can be created in theissue trackerMaintainer: Alberto RivasCitationPlease cite this work as:seeq-correlation
SeeqCorporation,2021https://github.com/seeq12/seeq-correlation