EntropyHub：用于熵时间序列分析的开源工具包

蟒蛇版

     ___  _   _  _____  _____  ____  ____  _     _          
    |  _|| \ | ||_   _||     \|    ||    || \   / |   ___________ 
    | \_ |  \| |  | |  |   __/|    ||  __| \ \_/ /   /  _______  \
    |  _|| \ \ |  | |  |   \  |    || |     \   /   |  /  ___  \  |
    | \_ | |\  |  | |  | |\ \ |    || |      | |    | |  /   \  | | 
    |___||_| \_|  |_|  |_| \_||____||_|      |_|   _|_|__\___/  | | 
     _   _  _   _  ____                           / |__\______\/  | 
    | | | || | | ||    \     An open-source      |  /\______\__|_/ 
    | |_| || | | ||    |     toolkit for         | |  /   \  | | 
    |  _  || | | ||    \     entropic time-      | |  \___/  | |          
    | | | || |_| ||     \    series analysis     |  \_______/  |
    |_| |_|\_____/|_____/                         \___________/ 

关于

信息和不确定性可以被视为同一枚硬币的两个方面：不确定性越多，我们通过消除不确定性获得的信息就越多。在信息和概率论的背景下，熵 量化了这种不确定性。

熵的概念起源于 热力学第二定律的 经典物理学，该定律被认为是我们对物理学时间的基本理解 的基础。试图分析我们周围的模拟世界需要我们以离散的步骤测量时间，但这样做会损害我们准确测量熵的能力。已经衍生出各种测量方法来估计离散时间序列的熵（不确定性），每一种方法都试图最好地捕捉被检查系统的不确定性。这导致了从近似熵和样本熵到多尺度样本熵和细化复合多尺度交叉样本熵的许多熵统计。

随着统计熵度量的数量增加，识别、对比和比较每个度量的性能变得更加困难。为了克服这个问题，我们开发了 EntropyHub - 一个开源工具包，旨在将许多已建立的熵方法集成到一个包中。EntropyHub 的目标是提供一套全面的函数，其语法简单且一致，允许用户在命令行中增加参数，从而轻松实现从基本到高级熵方法的范围。

重要的是要澄清这里描述的熵函数在香农定义的概率论和信息论的背景下估计熵，而不是热力学或经典物理学的其他熵。

安装

有两种方法可以安装 EntropyHub for Python。强烈推荐方法 1。

方法一：

1. pip在你的 python IDE 中 使用，输入：pip install EntropyHub

方法二：

1. 下载上面的文件夹（EntropyHub.xxx.tar.gz ）并解压。
2. 如果您使用 Anaconda 作为您的 python 包分发，请打开命令终端（Windows上的cmd ， Mac 上的终端）或使用Anaconda 提示符。
3. 在命令提示符/终端中，导航到您保存和解压缩 .tar.gz 文件夹的目录。
4. 在命令行中输入以下内容： python setup.py install

系统要求和依赖性

有几个包依赖项将与 EntropyHub 一起安装：Numpy、Scipy、Matplotlib、PyEMD

EntropyHub 是使用 Python 3 设计的，因此不适合与 Python 2 一起使用。使用 EntropyHub 需要 Python 版本 > 3.6。

文档和帮助

EntropyHub 的一个关键优势是可帮助用户充分利用工具包的综合文档。可以通过在命令行中键入来简单地访问函数的文档字符串（就像任何 Python 函数一样）help FunctionName，这将打印文档字符串。

EntropyHub 包的所有信息都在EntropyHub 指南中有详细说明，这里是一个 .pdf 文档。

功能

EntropyHub 函数分为 5 类：

* Base                functions for estimating the entropy of a single univariate time series.
* Cross               functions for estimating the entropy between two univariate time series.
* Bidimensional       functions for estimating the entropy of a two-dimensional univariate matrix.
* Multiscale          functions for estimating the multiscale entropy of a single univariate time series using any of the Base entropy functions.
* Multiscale Cross    functions for estimating the multiscale entropy between two univariate time series using any of the Cross-entropy functions.

下表概述了 EntropyHub 包中可用的功能。

当新的熵在科学文献中发表时，将努力将它们合并到未来的版本中。

基本熵：

交叉熵：

二维熵

多尺度熵函数

多尺度交叉熵函数

许可和使用条款

EntropyHub 在 Apache 许可证（2.0 版）下获得许可，所有人都可以免费使用，条件是在使用该软件实现的任何输出中包含以下参考：

    Matthew W. Flood and Bernd Grimm (2021), 
    EntropyHub: An Open-Source Toolkit for Entropic Time Series Analysis,
    PLoS ONE 16(11):e0259448
    DOI: 10.1371/journal.pone.0259448
    www.EntropyHub.xyz

    © Copyright 2021 Matthew W. Flood, EntropyHub
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

             http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

    For Terms of Use see https://www.EntropyHub.xyz

接触

如果你觉得这个包有用，请考虑在 GitHub、MatLab 文件交换、PyPI 或 Julia 包上加注星标，因为这有助于我们衡量用户满意度。

有关 EntropyHub 的一般查询和信息，请联系： info@entropyhub.xyz 如果您有任何问题或需要帮助使用该软件包，请通过以下方式联系我们： help@entropyhub.xyz 如果您发现或发现任何问题，请随时联系联系我们： fix@entropyhub.xyz

感谢您使用 EntropyHub。

你在研究中，

马特