> For the complete documentation index, see [llms.txt](https://time-series-features.gitbook.io/pyspi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://time-series-features.gitbook.io/pyspi/welcome-to-pyspi.md). # 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


Installation	Install pyspi on your system.	install_light.png	Installation
Start Here	Get started using pyspi quickly.	getting_started_light.png	Getting Started: A Simple Demonstration
Examples	pyspi usage examples and tutorials.	examples_light.png	Walkthrough 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 Table	A table of SPIs included in pyspi.	table_of_spis_light.png	Table of SPIs
SPI Descriptions	Detailed descriptions of SPIs included in pyspi.	got_light.png	SPI Descriptions

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


List of Publications	spi_descriptions_light.png	Publications using pyspi

*** ## Additional Pages


Advanced Usage	Advanced functionality in pyspi.	adv_usage_light.png	Advanced Usage
FAQ	Frequently asked questions.	FAQ_light.png	FAQ
Development	Developers guide and contributions.	dev_light.png	Development
API	A technical manual for pyspi functions and classes.	API_light.png	API Reference
Troubleshooting	Troubleshooting guide for pyspi installation.	troubleshooting_vector_icon.png	Troubleshooting

*** --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://time-series-features.gitbook.io/pyspi/welcome-to-pyspi.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.