Skip to main content

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

Project description

pyEntropy (pyEntrp)

codecov py38 status py39 status py310 status

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

This is a small set of functions on top of NumPy that help to compute different types of entropy for time series analysis.

The library provides functions for computing the following types of entropy:

  • 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

pip install pyentrp

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

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

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-0.8.2.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyentrp-0.8.2-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyentrp-0.8.2.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.11 Linux/5.15.0-1038-azure

File hashes

Hashes for pyentrp-0.8.2.tar.gz
Algorithm Hash digest
SHA256 19f6178ed3da2237dd18dee27adb8085cfea607b55de8f003df3be9e13c1d904
MD5 6041cd217337e3356cf1e212b08339ad
BLAKE2b-256 02a9d4145253726d1658392cc5b4bd1df348e50607d8e0924f544afc5f324eee

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyentrp-0.8.2-py3-none-any.whl
  • Upload date:
  • Size: 10.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.11 Linux/5.15.0-1038-azure

File hashes

Hashes for pyentrp-0.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3410e50d613928e55ddc5e161ac3819fbbeb53e2248d964dc986d9746ee1e9fb
MD5 889404d94351f6052a7c912fb677574f
BLAKE2b-256 6d9a8e263eb596113b114d01a3e94bc854b08e5d8ac8d11e8c794a2fa1c67dca

See more details on using hashes here.

Supported by

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