Skip to content
This repository was archived by the owner on Oct 9, 2023. It is now read-only.

DynamicsAndNeuralSystems/pyspi_tmp

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 reach out for help with real-world applications. Feedback is much appreciated through issues, or pull requests.

Acknowledgement

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

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

Getting Started

See the documentation for installing and setting up pyspi. Once you're done, you can learn how to use the package by checking out the:

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 dataset is large (containing many processes and/or observations), you can use a pre-configured set of reduced statistics or create your own subsets (cf. the documentation guide).

Other highly comparative toolboxes

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.

SPI Wishlist

As pyspi is under active development, we are always open to suggestions for new SPIs to be added via the projects tab in this repo.

About

Comparative analysis of pairwise interactions in multivariate time series.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 79.9%
  • MATLAB 19.6%
  • Dockerfile 0.5%