Skip to content

About

GitBook documentation for pyspi

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

cover .gitbook/assets/pyspi_banner2 (1).png
coverY 0
layout
width cover title description tableOfContents outline pagination metadata tags actions anchors
default
visible size mask
true
hero
none
visible
true
visible
true
visible
true
visible
true
visible
true
visible
true
visible
true
visible
true
visible
true

Welcome to pyspi

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

pyspi features

  • Easy access to over 250 statistics for quantifying the relationship between a pair of time series.
  • Open source, easy-to-use framework.
  • Comprehensive across statistics for pairwise interactions, including information theoretic, causal inference, distance similarity, and spectral measures.
  • Compute hundreds of SPIs on your multivariate time-series data in just a few lines of code.

Getting Started

InstallationInstall pyspi on your system.install_light.pnginstallation
Start HereGet started using pyspi quickly.getting_started_light.pnggetting-started-a-simple-demonstration.md
Examplespyspi usage examples and tutorials.examples_light.pngwalkthrough-tutorials

SPI Descriptions

Want to know what each SPI in pyspi computes? Access a high level summary of SPIs with the summary table or delve into the specifics with detailed descriptions fo each.

Summary TableA table of SPIs included in pyspi.table_of_spis_light.pngtable-of-spis.md
SPI DescriptionsDetailed descriptions of SPIs included in pyspi. got_light (1).pngspi-descriptions

Publications using pyspi

An ever-growing list of publications that use pyspi.

List of Publicationsspi_descriptions_light.pngpublications-using-pyspi.md

Additional Pages

Advanced UsageAdvanced functionality in pyspi. adv_usage_light.pngadvanced-usage
FAQ

Frequently asked

questions.

FAQ_light.pngfaq.md
DevelopmentDevelopers guide and contributions.dev_light.pngdevelopment
APIA technical manual for pyspi functions and classes.API_light.pngapi-reference
TroubleshootingTroubleshooting guide for pyspi installation.troubleshooting_vector_icon (1).pngtroubleshooting.md

About

GitBook documentation for pyspi

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages