Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(README.md): new section about the ways to contribute #29

Merged
merged 1 commit into from
Jun 18, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 29 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# pyEntropy (pyEntrp)

[![codecov](https://codecov.io/gh/nikdon/pyEntropy/branch/master/graph/badge.svg)](https://codecov.io/gh/nikdon/pyEntropy)
![py38 status](https://img.shields.io/badge/python3.8-supported-green.svg)
![py39 status](https://img.shields.io/badge/python3.9-supported-green.svg)
![py310 status](https://img.shields.io/badge/python3.10-supported-green.svg)
Expand All @@ -9,9 +8,10 @@
2. [Usage](#usage)
3. [Contributors and participation](#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.
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 provides functions for computing the following types of entropy:
The library currently supports the following types of entropy computation:

+ Shannon Entropy ```shannon_entropy```
+ Sample Entropy ```sample_entropy```
Expand All @@ -23,28 +23,51 @@ The library provides functions for computing the following types of entropy:

## Quick start

`pip install pyentrp`
Install [pyEntropy](https://github.com/nikdon/pyEntropy) using pip:

`poetry add pyentrp`
```
pip install pyentrp
```

Install [pyEntropy](https://github.com/nikdon/pyEntropy) using poetry:

```
poetry add pyentrp
```

## Usage

```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)
```

## Contributors and participation

[pyEntropy](https://github.com/nikdon/pyEntropy) is an open-source project, and contributions are highly encouraged.
If you would like to contribute, you can:

- [Fork the repository](https://github.com/nikdon/pyEntropy/fork) and submit pull requests with your improvements, bug
fixes, or new features.
- Report any issues or bugs you encounter on the [issue tracker](https://github.com/nikdon/pyEntropy/issues).
- Help improve the documentation by
submitting [documentation improvements or corrections](https://github.com/nikdon/pyEntropy/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation).
- Participate in discussions and share your ideas.

The following contributors have made significant contributions to pyEntropy:

* [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)

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

If you find [pyEntropy](https://github.com/nikdon/pyEntropy) useful, please consider giving it a star.

Your support is greatly appreciated!