An Open-Source Toolkit For Entropic Time Series Analysis
Welcome to EntropyHub.jl!
This is a toolkit that provides a wide range of functions to calculate different entropy statistics.
There is an ever-growing range of information-theoretic entropy measures presented in the scientific literature. Although many functions for estimating these entropies can be found in various corners of the internet, there is currently no toolkit to perform entropic time-series analysis in Julia with an extensive documentation and consistent syntax, that is also accessible in multiple programming languages (Matlab, Python).
The goal of EntropyHub.jl is to integrate the many established entropy methods into one package that is available for users of Julia.
Information and uncertainty can be regarded as two sides of the same coin: the more uncertainty there is, the more information we gain by removing that uncertainty. In the context of information and probability theory, Entropy quantifies that uncertainty.
The concept of entropy has its origins in classical physics under the second law of thermodynamics, a law considered to underpin our fundamental understanding of time in physics. Attempting to analyse the analog world around us requires that we measure time in discrete steps, but doing so compromises our ability to measure entropy accurately. Various measures have been derived to estimate entropy (uncertainty) from discrete time series, each seeking to best capture the uncertainty of the system under examination. This has resulted in many entropy statistics from approximate entropy and sample entropy, to multiscale sample entropy and refined-composite multiscale cross-sample entropy.
As the number of statisitcal entropy measures grows, it becomes more difficult to identify, contrast and compare the performance of each measure. To overcome this, we have developed EntropyHub - an open-source toolkit designed to integrate the many established entropy methods into one package. The goal of EntropyHub is to provide a comprehensive set of functions with a simple and consistent syntax that allows the user to augment parameters at the command line, enabling a range from basic to advanced entropy methods to be implemented with ease.
It is important to clarify that the entropy functions herein described estimate entropy in the context of probability theory and information theory as defined by Shannon, and not thermodynamic or other entropies from classical physics.
Using the Julia REPL:
julia> using Pkg; Pkg.add("EntropyHub")
julia> ] pkg> add EntropyHub
To get the latest version of EntropyHub directly from GitHub:
julia> ] pkg> add https://github.com/MattWillFlood/EntropyHub.jl
EntropyHub is licensed under the Apache License (Version 2.0) and is free to use by all on condition that the following reference be included on any outputs realized using the software:
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
If you find this package useful, please consider starring it on GitHub and Julia Packages (or MatLab File Exchange and PyPI). This helps us to gauge user satisfaction.
EntropyHub functions fall into 5 categories:
Basefunctions for estimating the entropy of a single univariate time series.
Crossfunctions for estimating the entropy between two univariate time series.
Bidimensionalfunctions for estimating the entropy of a two-dimensional univariate matrix.
Multiscalefunctions for estimating the multiscale entropy of a single univariate time series using any of the Base entropy functions.
Multiscale Crossfunctions for estimating the multiscale entropy between two univariate time series using any of the Cross-entropy functions.
For general queries and information about EntropyHub, contact:
email@example.com If you have any questions or need help using the package, please contact us at:
firstname.lastname@example.org If you notice or identify any issues, please do not hesitate to contact us at:
We will do our best to help you with any relevant issues that you may have.
If you come across any errors or technical issues, you can raise these under the issues tab on the EntropyHub.jl GitHub page. Similarly, if you have any suggestions or recommendations on how this package can be improved, please let us know.
Thank you for using EntropyHub,
___ _ _ _____ _____ ____ ____ _ _ | _|| \ | ||_ _|| \| || || \ / | ___________ | \_ | \| | | | | __/| || __| \ \_/ / / _______ \ | _|| \ \ | | | | \ | || | \ / | / ___ \ | | \_ | |\ | | | | |\ \ | || | | | | | / \ | | |___||_| \_| |_| |_| \_||____||_| |_| _|_|__\___/ | | _ _ _ _ ____ / |__\______\/ | | | | || | | || \ An open-source | /\______\__|_/ | |_| || | | || | toolkit for | | / \ | | | _ || | | || \ entropic time- | | \___/ | | | | | || |_| || \ series analysis | \_______/ | |_| |_|\_____/|_____/ \___________/
Documentation for EntropyHub.