# 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

<table data-view="cards"><thead><tr><th align="center"></th><th align="center"></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><strong>Installation</strong></td><td align="center">Install <em>pyspi</em> on your system.</td><td><a href="https://636746764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIw3ORxNbDkeyBcdB5svU%2Fuploads%2FA4eFEFHy0kykFL2NRryO%2Finstall_light.png?alt=media&#x26;token=53c64f2d-9c72-4619-9556-5c062a127920">install_light.png</a></td><td><a href="installing-and-using-pyspi/installation">installation</a></td></tr><tr><td align="center"><strong>Start Here</strong></td><td align="center">Get started using <em>pyspi</em> quickly.</td><td><a href="https://636746764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIw3ORxNbDkeyBcdB5svU%2Fuploads%2FXHRXpyjHYK5JXL3fuR5I%2Fgetting_started_light.png?alt=media&#x26;token=9a06e27b-f191-4323-9365-ba66e2c3805f">getting_started_light.png</a></td><td><a href="installing-and-using-pyspi/usage/walkthrough-tutorials/getting-started-a-simple-demonstration">getting-started-a-simple-demonstration</a></td></tr><tr><td align="center"><strong>Examples</strong></td><td align="center"><em>pyspi</em> usage examples and tutorials.</td><td><a href="https://636746764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIw3ORxNbDkeyBcdB5svU%2Fuploads%2FFna7gvwPadZWqAPB3tXy%2Fexamples_light.png?alt=media&#x26;token=7551a748-3fcc-4067-ad0e-17cc4e38200d">examples_light.png</a></td><td><a href="installing-and-using-pyspi/usage/walkthrough-tutorials">walkthrough-tutorials</a></td></tr></tbody></table>

## 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.&#x20;

<table data-view="cards"><thead><tr><th align="center"></th><th align="center"></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><strong>Summary Table</strong></td><td align="center">A table of SPIs included in <em>pyspi</em>.</td><td><a href="https://636746764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIw3ORxNbDkeyBcdB5svU%2Fuploads%2F1ambUsMQubpCbvigK87y%2Ftable_of_spis_light.png?alt=media&#x26;token=bb8f44ef-2dbe-4ebd-814c-a52559949204">table_of_spis_light.png</a></td><td><a href="information-about-pyspi/spis/table-of-spis">table-of-spis</a></td></tr><tr><td align="center"><strong>SPI Descriptions</strong></td><td align="center">Detailed descriptions of SPIs included in <em>pyspi</em>. </td><td><a href="https://636746764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIw3ORxNbDkeyBcdB5svU%2Fuploads%2FkuyxKnGB6zp9RSlCcOBe%2Fgot_light.png?alt=media&#x26;token=6806aa66-f799-47de-84d4-0f38eaec6dfd">got_light.png</a></td><td><a href="information-about-pyspi/spis/spi-descriptions">spi-descriptions</a></td></tr></tbody></table>

## Publications using *pyspi*

An ever-growing list of publications that use *pyspi.*

<table data-view="cards"><thead><tr><th align="center"></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><strong>List of Publications</strong></td><td><a href="https://636746764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIw3ORxNbDkeyBcdB5svU%2Fuploads%2F49rxtR9XWTwONUm54cSV%2Fspi_descriptions_light.png?alt=media&#x26;token=3ab75171-cc53-47d3-adc8-f3fed8767ab0">spi_descriptions_light.png</a></td><td><a href="information-about-pyspi/publications-using-pyspi">publications-using-pyspi</a></td></tr></tbody></table>

***

## Additional Pages

<table data-view="cards"><thead><tr><th align="center"></th><th align="center"></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><strong>Advanced Usage</strong></td><td align="center">Advanced functionality in <em>pyspi.</em> </td><td><a href="https://636746764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIw3ORxNbDkeyBcdB5svU%2Fuploads%2F0JhvQKE78RreySej26oP%2Fadv_usage_light.png?alt=media&#x26;token=e9f3b942-f761-4357-bd73-1ad866e79e15">adv_usage_light.png</a></td><td><a href="installing-and-using-pyspi/usage/advanced-usage">advanced-usage</a></td></tr><tr><td align="center"><strong>FAQ</strong></td><td align="center"><p>Frequently asked </p><p>questions.</p></td><td><a href="https://636746764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIw3ORxNbDkeyBcdB5svU%2Fuploads%2FHJwemK1ouwxtgW3FRaxL%2FFAQ_light.png?alt=media&#x26;token=a743ce6c-7953-4900-a185-646ca87da9ff">FAQ_light.png</a></td><td><a href="installing-and-using-pyspi/usage/faq">faq</a></td></tr><tr><td align="center"><strong>Development</strong></td><td align="center">Developers guide and contributions.</td><td><a href="https://636746764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIw3ORxNbDkeyBcdB5svU%2Fuploads%2FBs64rVVnZi5KVRE8I6Jh%2Fdev_light.png?alt=media&#x26;token=33ad453d-7d76-49c5-8d10-f658b23276ce">dev_light.png</a></td><td><a href="development/development">development</a></td></tr><tr><td align="center"><strong>API</strong></td><td align="center">A technical manual for <em>pyspi</em> functions and classes.</td><td><a href="https://636746764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIw3ORxNbDkeyBcdB5svU%2Fuploads%2FfUS7GmMTNnBRqhWJRiuc%2FAPI_light.png?alt=media&#x26;token=1124caae-ee52-40b6-b92b-fef7a65ef4e1">API_light.png</a></td><td><a href="information-about-pyspi/api-reference">api-reference</a></td></tr><tr><td align="center"><strong>Troubleshooting</strong></td><td align="center">Troubleshooting guide for <em>pyspi</em> installation.</td><td><a href="https://636746764-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIw3ORxNbDkeyBcdB5svU%2Fuploads%2F1w7aPmEDoHaEzIlf2jnL%2Ftroubleshooting_vector_icon.png?alt=media&#x26;token=efa7387a-bae2-4ab1-8631-5dc1cc0deedc">troubleshooting_vector_icon.png</a></td><td><a href="installing-and-using-pyspi/installation/troubleshooting">troubleshooting</a></td></tr></tbody></table>

***


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://time-series-features.gitbook.io/pyspi/welcome-to-pyspi.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.