PySINDy

|BuildCI| |RTD| |PyPI| |Codecov| |JOSS1| |JOSS2| |DOI|

PySINDy 是一个用于系统辨识的软件包，主要围绕 Brunton 等人（2016a）提出的非线性动力系统的稀疏辨识方法（SINDy）展开。它还包含了来自相关文献的其他方法。

系统辨识 是指利用测量数据推断系统支配动力学的过程。一旦这些方程被发现，它们就可以用来预测未来的状态、指导控制输入，或者通过解析技术进行理论研究。由此得到的模型本质上是 可解释的 和 可泛化的。

第一步

安装 ^^^^^^^^^^^^^^

推荐使用 pip 或 conda 进行安装，例如 pip install pysindy。你可能需要添加 --user 选项。Pysindy 还提供了多个附加组件，例如 pip install pysindy[miosr]：

cvxpy 凸优化器 SR3 及其子类

miosr 用于 L0 约束的分支定界优化器 MIOSR

sbr 贝叶斯回归优化器，可得到后验分布 SBR。

示例 ^^^^^^^^^^^^^ 假设我们有一组粒子在不同时刻的位置测量值，该粒子遵循以下动力系统：

.. math::

x' &= -2 x \ y' &= y

请注意，这个微分方程组可以分解为两个独立的微分方程，其解分别为：

.. math::

x(t) &= x_0 * exp(-2 * t) \ y(t) &= y_0 * exp(t)

本示例使用初始条件 x_0 = 3 和 y_0 = 0.5。然后拟合并打印出所发现的模型：

.. code-block:: python

import numpy as np import pysindy as ps

t = np.linspace(0, 1, 100) x = 3 * np.exp(-2 * t) y = 0.5 * np.exp(t) X = np.stack((x, y), axis=-1) # 第一列是 x，第二列是 y

model = ps.SINDy() model.fit(X, t=t, feature_names=["x", "y"]) model.print()

结果正确地输出：

.. code-block:: text

x' = -2.000 x y' = 1.000 y

PySINDy 还提供了许多此处未展示的功能。我们有各种教程和示例，从 生成数据和拟合模型 <examples/tutorial_1/example.html>_ 开始。

获取帮助

• 如果您有任何 问题 或发现了 bug，请在 GitHub 上提交一个 issue <https://github.com/dynamicslab/pysindy/issues>_。
• PySINDy 的 文档 网站可以在 这里 <https://pysindy.readthedocs.io/en/latest/>__ 找到。关于 PySINDy 的视频概述可以在 Youtube <https://www.youtube.com/watch?v=DvbbXX8Bd90>__ 上观看。我们还创建了一个包含实用 PySINDy 技巧的 视频播放列表 <https://www.youtube.com/playlist?list=PLN90bHJU-JLoOfEk0KyBs2qLTV7OkMZ25>__。
• 若要深入了解 pysindy 中的 对象类型，请参阅 对象模型 <https://pysindy.readthedocs.io/en/latest/objects>_。
• 如果您想修复问题、添加功能或分享示例，请查看 **贡献者** 指南 <https://pysindy.readthedocs.io/en/latest/contributing.html>_。
• 如果您在 学术 工作中使用了 pysindy，请参阅 学术使用 <https://pysindy.readthedocs.io/en/latest/academic.html>_，其中包含建议，包括 引用。

相关软件包

• Deeptime <https://github.com/deeptime-ml/deeptime>_ - 一个用于时间序列数据分析的 Python 库，提供降维、聚类和马尔可夫模型估计等方法。
• PyDMD <https://github.com/mathLab/PyDMD/>_ - 一个基于动态模态分解（DMD）的 Python 包，用于基于时空相干结构的数据驱动模型简化。DMD 是 SINDy 的一个很好的替代方案。
• PySINDyGUI <https://github.com/hyumo/pysindy-gui>_ - 一个界面美观的 PySINDy 图形用户界面。
• SEED <https://github.com/M-Vause/SEED2.0>_ - 数据方程提取软件：一个为 PySINDy 提供的多种方法设计的图形用户界面。
• SymINDy <https://github.com/andreikitaitsev/SymINDy/>_ - 一个结合了 SINDy 与基于遗传编程的符号回归的 Python 包，用于函数库的优化。
• derivative <https://derivative.readthedocs.io/en/latest/>_ - 一个用于对数据进行微分（并可选平滑处理）的 Python 包，被 pysindy 使用。

.. |BuildCI| image:: https://github.com/dynamicslab/pysindy/actions/workflows/main.yml/badge.svg :target: https://github.com/dynamicslab/pysindy/actions/workflows/main.yml?query=branch%3Amain

.. |RTD| image:: https://readthedocs.org/projects/pysindy/badge/?version=latest :target: https://pysindy.readthedocs.io/en/latest/?badge=latest :alt: 文档状态

.. |PyPI| image:: https://badge.fury.io/py/pysindy.svg :target: https://badge.fury.io/py/pysindy

.. |Codecov| image:: https://codecov.io/gh/dynamicslab/pysindy/branch/main/graph/badge.svg :target: https://codecov.io/gh/dynamicslab/pysindy

.. |JOSS1| image:: https://joss.theoj.org/papers/82d080bbe10ac3ab4bc03fa75f07d644/status.svg :target: https://joss.theoj.org/papers/82d080bbe10ac3ab4bc03fa75f07d644

.. |JOSS2| image:: https://joss.theoj.org/papers/10.21105/joss.03994/status.svg :target: https://doi.org/10.21105/joss.03994

.. |DOI| image:: https://zenodo.org/badge/186055899.svg :target: https://zenodo.org/badge/latestdoi/186055899

PySINDy 快速上手指南

PySINDy 是一个用于系统辨识的 Python 包，核心基于稀疏非线性动力学系统识别（SINDy）方法。它能够通过测量数据推断控制动态系统的方程，生成的模型具有可解释性和泛化能力。

环境准备

• Python 版本：建议使用 Python 3.7 或更高版本。
• 前置依赖：主要依赖 NumPy 和 SciPy 进行数值计算。
• 可选优化器依赖：根据需求，你可能需要安装额外的优化库：
  • cvxpy：用于凸优化器 SR3。
  • miosr：用于 L0 约束的分支定界优化器 MIOSR。
  • sbr：用于贝叶斯回归优化器 SBR。

安装步骤

推荐使用 pip 或 conda 进行安装。

基础安装

pip install pysindy

如果遇到权限问题，可以添加 --user 选项：

pip install --user pysindy

安装额外功能（Extras）

如果你需要使用特定的优化器，可以通过以下命令安装对应扩展：

• 安装 SR3 支持：

  pip install pysindy[cvxpy]
  

• 安装 MIOSR 支持：

  pip install pysindy[miosr]
  

• 安装 SBR 支持：

  pip install pysindy[sbr]
  

提示：国内用户若下载速度较慢，可使用清华源或阿里源加速，例如： pip install pysindy -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

以下示例演示如何从粒子位置的时间序列数据中恢复其动力学方程。

假设系统遵循以下微分方程： $$ x' = -2 x $$ $$ y' = 1 y $$

其解析解为 $x(t) = x_0 e^{-2t}$ 和 $y(t) = y_0 e^{t}$。我们将使用初始条件 $x_0 = 3$ 和 $y_0 = 0.5$ 生成数据并拟合模型。

import numpy as np
import pysindy as ps

# 1. 生成模拟数据
t = np.linspace(0, 1, 100)
x = 3 * np.exp(-2 * t)
y = 0.5 * np.exp(t)
X = np.stack((x, y), axis=-1)  # 第一列为 x，第二列为 y

# 2. 初始化并拟合模型
model = ps.SINDy()
model.fit(X, t=t, feature_names=["x", "y"])

# 3. 打印发现的动力学方程
model.print()

预期输出：

x' = -2.000 x
y' = 1.000 y

模型成功识别出了正确的系数和结构。更多高级用法（如自定义函数库、不同优化器等）请参考官方文档中的教程部分。