Skip to main content

A Python library for computing entropy measures for time series analysis.

Project description

pyEntropy (pyEntrp)

py39 status py310 status py311 status py312 status

  1. Quick start
  2. Usage
  3. Contributors and participation

pyEntropy is a lightweight library built on top of NumPy that provides functions for computing various types of entropy for time series analysis.

The library currently supports the following types of entropy computation:

  • Shannon Entropy shannon_entropy
  • Sample Entropy sample_entropy
  • Multiscale Entropy multiscale_entropy
  • Composite Multiscale Entropy composite_multiscale_entropy
  • Permutation Entropy permutation_entropy
  • Multiscale Permutation Entropy multiscale_permutation_entropy
  • Weighted Permutation Entropy weighted_permutation_entropy

Quick start

Install pyEntropy using pip:

pip install pyentrp

Install pyEntropy using poetry:

poetry add pyentrp

Usage

from pyentrp import entropy as ent
import numpy as np

ts = [1, 4, 5, 1, 7, 3, 1, 2, 5, 8, 9, 7, 3, 7, 9, 5, 4, 3]
std_ts = np.std(ts)
sample_entropy = ent.sample_entropy(ts, 4, 0.2 * std_ts)

Contributors and participation

pyEntropy is an open-source project, and contributions are highly encouraged. If you would like to contribute, you can:

The following contributors have made significant contributions to pyEntropy:

Contributions are very welcome, documentation improvements/corrections, bug reports, even feature requests :)

If you find pyEntropy useful, please consider giving it a star.

Your support is greatly appreciated!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyentrp-2.0.0.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

pyentrp-2.0.0-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file pyentrp-2.0.0.tar.gz.

File metadata

  • Download URL: pyentrp-2.0.0.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.10.18 Linux/6.11.0-1015-azure

File hashes

Hashes for pyentrp-2.0.0.tar.gz
Algorithm Hash digest
SHA256 4528a4861bb72007f81bae265f619bc85b76ea2e5729b26cf75a2815a8340386
MD5 ab289c33ef31a8cfc35c4252d7edae9e
BLAKE2b-256 779a30d131bf8992c8b1e5c2f42075732dc9ad632082e0b5d1c0cb385e0caad4

See more details on using hashes here.

File details

Details for the file pyentrp-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: pyentrp-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.10.18 Linux/6.11.0-1015-azure

File hashes

Hashes for pyentrp-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c2b157e86341377dc1188b8ab9d89737f23ad9de493c8efb22952cd1bd752986
MD5 3b674aae05e3c9998801be36fa5a8a81
BLAKE2b-256 69ef210ef28339a6f267a48a3f0a33365bc106e70af4d957b48c1941c0a28952

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page