stbachinger / TigramiteGui

A graphic user interface module for the causal time series analysis tool tigramite.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TigramiteGui

This repostory contains the prototype for a graphic user interface for the causal time series analysis tool tigramite.

Prerequisites

This prototype is a module for JupyterNotebooks, so make sure to have a running version. Also, before using it, make sure to install tigramite on your device. Tigramite depends on Python v3.7, to ensure compatibility, use also Python 3.7. Also, it is necessary to have mpi.h. For ubuntu systems, sudo apt install libopenmpi-dev mpi.

In the past, using a conda environment for the prototype did not open the module. If your window looks like this after running the cell, install the package in your base python. prototype_wrong Here, only numpy arrays with the ending .npy can be loaded in.

Setup

Follow these steps:

  • clone this repository on your computer (e.g. <root>).
  • in <root> pip install .

How to use it

After installation, open a new Jupyter Notebook or open the existing in the project. The following code will import and open the prototype.

from PrototypeWidgets import ProjectWindow

ProjectWindow().show()

It should look like this: With the lower left corner showing the algorith output and the lower right corner the plot output. To use it, just put your .npy data in \path and load it in. All defaults are set and can be changed through the accordion view.

prototype_example

Examples

Go to the directory examples, and open ExampleNotebook.ipynb. The .npy files in the same directory can be used to get to know the workflow.

License

Copyright (c) 2020-2021 Sarah Bachinger

See the LICENSE.txt file for more information. Also check the tigramite repository for their license.

References for Tigramite

About

A graphic user interface module for the causal time series analysis tool tigramite.

License:GNU General Public License v3.0


Languages

Language:Python 100.0%