Skip to content

valeman/pyspi

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

146 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Python Toolkit of Statistics for Pairwise Interactions (pyspi)

DOI

pyspi is a comprehensive python library for computing statistics of pairwise interactions (SPIs) from multivariate time-series (MTS) data.

The code provides easy access to hundreds of methods for evaluating the relationship between pairs of time series, from simple statistics (like correlation) to advanced multi-step algorithms (like Granger causality). The code is licensed under the GNU GPL v3 license (or later).

Feel free to email me for help with real-world applications. Feedback is much appreciated through email, issues, or pull requests.

Acknowledgement

If you use this code, please cite the following preprint:

Oliver M. Cliff, Joseph T. Lizier, Naotsugu Tsuchiya, Ben D. Fulcher, "Unifying Pairwise Interactions in Complex Dynamics," arXiv preprint, arXiv:2201.11941 (2022).

Getting started

See the documentation for installing and setting up pyspi. Once you're done, check out the tutorial and simple demo to learn how to use the package.

If you have access to a PBS cluster and are processing MTS with many processes (or are analyzing many MTS), then you may find the pyspi distribute repository helpful.

If your data is quite large (i.e., there are many processes or observations), you can use a reduced set of statistics by instantiating the calculator with the fast=True parameter (see the simple demo).

Related resources

hctsa

hctsa, the highly comparative time-series analysis toolkit, computes over 7000 time-series features from univariate time series.

hcga

hcga, a highly comparative graph analysis toolkit, computes several thousands of graph features directly from any given network.

About

Comparative analysis of pairwise interactions in multivariate time series.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 80.2%
  • MATLAB 19.8%