Skip to content

Commit

Permalink
prepare release 0.7.1, add long_description
Browse files Browse the repository at this point in the history
  • Loading branch information
nikdon committed Jun 24, 2021
1 parent c326d07 commit 9320bcc
Showing 1 changed file with 77 additions and 2 deletions.
79 changes: 77 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,82 @@
from distutils.core import setup

with open("README.md", "r", encoding="utf-8") as fh:
long_description = fh.read()
long_description = """pyEntropy (pyEntrp)
===================
|pypi| |Build Status| |codecov| |py27 status| |py36 status| |image1|
|image2| |image3|
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.
- 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``
Usage
-----
.. code:: python
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
------------------------------
- `Nikolay Donets`_
- `Jakob Dreyer`_
- `Raphael Vallat`_
- `Christopher Schölzel`_
- `Sam Dotson`_
Contributions are very welcome, documentation improvements/corrections,
bug reports, even feature requests :)
.. _Quick start: #quick-start
.. _Usage: #usage
.. _Contributors and participation: #contribution-and-participation
.. _Nikolay Donets: https://github.com/nikdon
.. _Jakob Dreyer: https://github.com/jakobdreyer
.. _Raphael Vallat: https://github.com/raphaelvallat
.. _Christopher Schölzel: https://github.com/CSchoel
.. _Sam Dotson: https://github.com/samgdotson
.. |pypi| image:: https://img.shields.io/badge/pypi-0.7.1-green.svg
:target: https://pypi.python.org/pypi/pyentrp/0.7.1
.. |Build Status| image:: https://travis-ci.org/nikdon/pyEntropy.svg?branch=master
:target: https://travis-ci.org/nikdon/pyEntropy
.. |codecov| image:: https://codecov.io/gh/nikdon/pyEntropy/branch/master/graph/badge.svg
:target: https://codecov.io/gh/nikdon/pyEntropy
.. |py27 status| image:: https://img.shields.io/badge/python2.7-supported-green.svg
.. |py36 status| image:: https://img.shields.io/badge/python3.6-supported-green.svg
.. |image1| image:: https://img.shields.io/badge/python3.7-supported-green.svg
.. |image2| image:: https://img.shields.io/badge/python3.8-supported-green.svg
.. |image3| image:: https://img.shields.io/badge/python3.9-supported-green.svg
"""

setup(
name='pyentrp',
Expand Down

0 comments on commit 9320bcc

Please sign in to comment.