pyspi

<p align="center"> <picture> <source srcset="img/pyspi_logo_darkmode.png" media="(prefers-color-scheme: dark)"> <img src="https://yellow-cdn.veclightyear.com/0a4dffa0/2df0563f-2536-42c8-93f1-f7d48652a21d.png" alt="pyspi标志" height="200"/> </picture> </p> <h1 align="center"><em>pyspi</em>：成对交互统计的Python工具包</h1> <p align="center"> <a href="https://zenodo.org/badge/latestdoi/601919618"><img src="https://yellow-cdn.veclightyear.com/0a4dffa0/ab187bc3-dd07-4c77-b747-4a268d38c792.svg" height="20"/></a> <a href="https://www.gnu.org/licenses/gpl-3.0"><img src="https://yellow-cdn.veclightyear.com/0a4dffa0/dabd4812-a918-428e-a8bb-756a87bded82.svg" height="20"/></a> <a href="https://github.com/DynamicsAndNeuralSystems/pyspi/actions/workflows/run_unit_tests.yaml"><img src="https://yellow-cdn.veclightyear.com/0a4dffa0/63dc1e5a-25c0-434f-8dd7-45c056076964.svg" height="20"/></a> <a href="https://twitter.com/compTimeSeries"><img src="https://yellow-cdn.veclightyear.com/0a4dffa0/930f9653-3aba-4f7d-b4cf-fc20e3332a5c.svg?style=social&label=Follow%20%40compTimeSeries" height="20"/></a><br> <a href="https://www.python.org"><img src="https://yellow-cdn.veclightyear.com/0a4dffa0/7f05f8a4-9f87-4349-bbb9-cd6ae330cc08.svg?style=flat&logo=python&logoColor=white" alt="Python 3.8 | 3.9 | 3.10 | 3.11 | 3.12"></a> </p>

pyspi 是一个全面的Python库，用于计算多变量时间序列（MTS）数据中的成对交互统计（SPIs）。该工具箱提供了数百种评估时间序列对之间关系的方法，从简单的统计（如相关性）到高级的多步算法（如格兰杰因果关系）。该代码基于GNU GPL v3许可证（或更高版本）授权。

如果您在实际应用中需要帮助，请随时联系我们。 我们非常感谢您通过问题或拉取请求提供反馈。

章节	描述
安装	安装_pyspi_及其依赖项
入门	快速介绍如何开始使用_pyspi_
SPI描述	完整的SPI表格和详细描述的链接
文档	API参考和完整文档的GitBooks链接
为_pyspi_贡献	社区成员愿意为_pyspi_贡献的指南
致谢	学术文章中引用_pyspi_的方式
我们的贡献者	主要贡献者概述

安装 📥

安装_pyspi_包最简单的方法是使用pip install。为了访问完整的SPI库，代码需要在您的系统上安装GNU的Octave。

1. 预安装Octave（可选）

虽然您可以安全地安装_pyspi_而不需要先安装Octave，但您将无法访问完整的SPI库

2. 创建conda环境（可选，推荐）

虽然您也可以在conda环境之外安装_pyspi_，但它依赖于许多用户包，这可能会使依赖项管理变得相当困难。因此，我们也建议在conda环境中安装pyspi。首先，创建一个新的conda环境：

conda create -n pyspi python=3.9.0

创建环境后，使用conda activate pyspi激活它。

3. 使用_pip_安装

使用pip安装pyspi：

pip install pyspi

有关如何安装_pyspi_的更详细指南，以及如何在不先安装Octave的情况下使用_pyspi_，请查看完整文档。此外，我们为遇到安装_pyspi_问题的用户提供了全面的故障排除指南，以及替代安装选项。

入门 🚀

一旦您安装了_pyspi_，您可以通过查看我们文档中的演练教程来学习如何应用该包。点击以下任何示例以访问我们完整文档中的教程：

高级用法

对于高级用户，我们在完整文档中提供了几个额外的指南，介绍如何在PBS集群上分配_pyspi_作业，以及如何构建自己的SPI子集。

SPI描述 📋

要访问_pyspi_ SPI库的高级概述表格，包括它们相关的标识符，请参阅完整文档中的SPI表格。有关每个SPI的详细描述及其相关估计器，我们在文档的SPI描述页面中提供了完整的分解。

文档

完整文档托管在GitBooks上。使用以下链接快速访问一些关键部分：

为_pyspi_做贡献 👨‍👨‍👦‍👦

贡献在_pyspi_的持续发展和改进中起着至关重要的作用，这个项目是通过社区协作而构建和丰富的。如果您想为_pyspi_做出贡献，或探索您可以参与项目的多种方式，请查看我们详细的贡献指南了解如何进行。在为_pyspi_做贡献时，所有参与者都应遵守我们的行为准则。

SPI愿望清单

我们致力于提供最全面的SPI工具包。如果您对新的SPI有想法或对现有SPI有改进建议，我们非常希望听到您的意见并与您合作！任何成对依赖性度量，只要附有已发表的研究论文，通常都在_pyspi_库考虑的范围内。您可以通过本仓库的项目标签访问我们的SPI愿望清单并提出请求。

致谢 👍

如果您使用此软件，请阅读并引用以下文章：

📗 O.M. Cliff, A.G. Bryant, J.T. Lizier, N. Tsuchiya, B.D. Fulcher. 统一复杂动力学中的成对交互，自然计算科学 (2023)。

注意：本文有预印本和免费阅读版本可用。

<details closed> <summary>点击此处查看BibTex引用：</summary>

@article{Cliff2023:UnifyingPairwiseInteractions,
	title = {Unifying pairwise interactions in complex dynamics},
	volume = {3},
	issn = {2662-8457},
	url = {https://www.nature.com/articles/s43588-023-00519-x},
	doi = {10.1038/s43588-023-00519-x},
	number = {10},
	journal = {Nature Computational Science},
	author = {Cliff, Oliver M. and Bryant, Annie G. and Lizier, Joseph T. and Tsuchiya, Naotsugu and Fulcher, Ben D.},
	month = oct,
	year = {2023},
	pages = {883--893},
}

</details>