| Name | pyentrp JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | A Python library for computing entropy measures for time series analysis. |
| upload_time | 2024-07-06 20:10:56 |
| maintainer | None |
| docs_url | None |
| author | Nikolay Donets |
| requires_python | <4.0,>=3.9 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyEntropy (pyEntrp)
1. [Quick start](#quick-start)
2. [Usage](#usage)
3. [Contributors and participation](#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](https://github.com/nikdon/pyEntropy) using pip:
```
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!
Raw data
{
"_id": null,
"home_page": null,
"name": "pyentrp",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Nikolay Donets",
"author_email": "nd@donets.org",
"download_url": "https://files.pythonhosted.org/packages/f5/6a/de6bffe13e5fdb577fad1d2c992488bd0c64fca43c8e7f02bbc92d9d2cd7/pyentrp-1.0.0.tar.gz",
"platform": null,
"description": "# pyEntropy (pyEntrp)\n\n\n\n\n\n\n1. [Quick start](#quick-start)\n2. [Usage](#usage)\n3. [Contributors and participation](#contributors-and-participation)\n\npyEntropy is a lightweight library built on top of NumPy\nthat provides functions for computing various types of entropy for time series analysis.\n\nThe library currently supports the following types of entropy computation:\n\n+ Shannon Entropy ```shannon_entropy```\n+ Sample Entropy ```sample_entropy```\n+ Multiscale Entropy ```multiscale_entropy```\n+ Composite Multiscale Entropy ```composite_multiscale_entropy```\n+ Permutation Entropy ```permutation_entropy```\n+ Multiscale Permutation Entropy ```multiscale_permutation_entropy```\n+ Weighted Permutation Entropy ```weighted_permutation_entropy```\n\n## Quick start\n\nInstall [pyEntropy](https://github.com/nikdon/pyEntropy) using pip:\n\n```\npip install pyentrp\n```\n\nInstall [pyEntropy](https://github.com/nikdon/pyEntropy) using poetry:\n\n```\npoetry add pyentrp\n```\n\n## Usage\n\n```python\nfrom pyentrp import entropy as ent\nimport numpy as np\n\nts = [1, 4, 5, 1, 7, 3, 1, 2, 5, 8, 9, 7, 3, 7, 9, 5, 4, 3]\nstd_ts = np.std(ts)\nsample_entropy = ent.sample_entropy(ts, 4, 0.2 * std_ts)\n```\n\n## Contributors and participation\n\n[pyEntropy](https://github.com/nikdon/pyEntropy) is an open-source project, and contributions are highly encouraged.\nIf you would like to contribute, you can:\n\n- [Fork the repository](https://github.com/nikdon/pyEntropy/fork) and submit pull requests with your improvements, bug\n fixes, or new features.\n- Report any issues or bugs you encounter on the [issue tracker](https://github.com/nikdon/pyEntropy/issues).\n- Help improve the documentation by\n submitting [documentation improvements or corrections](https://github.com/nikdon/pyEntropy/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation).\n- Participate in discussions and share your ideas.\n\nThe following contributors have made significant contributions to pyEntropy:\n\n* [Nikolay Donets](https://github.com/nikdon)\n* [Jakob Dreyer](https://github.com/jakobdreyer)\n* [Raphael Vallat](https://github.com/raphaelvallat)\n* [Christopher Sch\u00f6lzel](https://github.com/CSchoel)\n* [Sam Dotson](https://github.com/samgdotson)\n\nContributions are very welcome, documentation improvements/corrections, bug reports, even feature requests :)\n\nIf you find [pyEntropy](https://github.com/nikdon/pyEntropy) useful, please consider giving it a star.\n\nYour support is greatly appreciated!\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Python library for computing entropy measures for time series analysis.",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "04af8d1fc63db0f4e56a410ca8e8368c26c6840f5d95729a7db149aaaba89785",
"md5": "cf9a4f7be22d500f543ab26d96122b42",
"sha256": "9bf8fa278c56dbe68833c703e9edb042f8b2a8850cc3a9a3d76070984e5c7c00"
},
"downloads": -1,
"filename": "pyentrp-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cf9a4f7be22d500f543ab26d96122b42",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 10820,
"upload_time": "2024-07-06T20:10:55",
"upload_time_iso_8601": "2024-07-06T20:10:55.194441Z",
"url": "https://files.pythonhosted.org/packages/04/af/8d1fc63db0f4e56a410ca8e8368c26c6840f5d95729a7db149aaaba89785/pyentrp-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f56ade6bffe13e5fdb577fad1d2c992488bd0c64fca43c8e7f02bbc92d9d2cd7",
"md5": "85e01ca66b85cbb51719dfdc349edee6",
"sha256": "afefcb02278bdf4dc167aa0c4887ab298dbedd9bc159ec4f47079f11f56dfe22"
},
"downloads": -1,
"filename": "pyentrp-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "85e01ca66b85cbb51719dfdc349edee6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 10525,
"upload_time": "2024-07-06T20:10:56",
"upload_time_iso_8601": "2024-07-06T20:10:56.672106Z",
"url": "https://files.pythonhosted.org/packages/f5/6a/de6bffe13e5fdb577fad1d2c992488bd0c64fca43c8e7f02bbc92d9d2cd7/pyentrp-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-06 20:10:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyentrp"
}
