Entropy for Python
Branch: master
Clone or download
Latest commit ae2bf71 Oct 21, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
pyentrp np.emtpy instead of np.zeros Oct 16, 2018
tests Improved doc and code of permutation_entropy Oct 12, 2018
.gitignore add requirements.txt and travis-ci Dec 20, 2016
.travis.yml fix travis-ci Apr 28, 2017
CAHNGELOG.md prepare release 0.5.0 Oct 21, 2018
LICENSE add license Mar 18, 2015
NOTICE add license Mar 18, 2015
README.md prepare release 0.5.0 Oct 21, 2018
requirements.txt update repo for packaging Apr 28, 2017
setup.cfg update repo for packaging Apr 28, 2017
setup.py prepare release 0.5.0 Oct 21, 2018

README.md

pyEntropy (pyEntrp)

pypi Build Status codecov py27 status py36 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.

Currently available:

  • 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

Quick start

pip install 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)

Requirements:

  • >numpy-1.7.0

Contributors and participation

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

Analytics