# caerus
[](https://img.shields.io/pypi/pyversions/caerus)
[](https://pypi.org/project/caerus/)
[](https://github.com/erdogant/caerus/blob/master/LICENSE)
[](https://pepy.tech/project/caerus)
[](https://pepy.tech/project/caerus/month)
[](https://erdogant.github.io/caerus/)
<!---[](https://www.buymeacoffee.com/erdogant)-->
<!---[](https://erdogant.github.io/donate/?currency=USD&amount=5)-->
``caerus`` is Python package to compute the local-minima with the corresponding local-maxima within the given time-frame. This approach is designed to for stock-market valley and peak detection.
Here are just a few of the things that caerus does well:
- Ouput contains detected start-stop regions of local minima and maxima.
- Figures are created.
- Parameter gridsearch.
- Designed for the detection of complex trend movements.
#
**⭐️ Star this repo if you like it ⭐️**
#
#### Install caerus from PyPI
```bash
pip install caerus
```
#### Import caerus package
```python
from caerus import caerus
```
#
### [Documentation pages](https://erdogant.github.io/caerus/)
On the [documentation pages](https://erdogant.github.io/caerus/) you can find detailed information about the working of the ``caerus`` with examples.
<hr>
### Examples
#
* [Example: Detect peak and valleys in Bitcoin](https://erdogant.github.io/caerus/pages/html/Examples.html)
<p align="left">
<a href="https://erdogant.github.io/caerus/pages/html/Examples.html">
<img src="https://github.com/erdogant/caerus/blob/master/docs/figs/figure_btc.png" width="600" />
<img src="https://github.com/erdogant/caerus/blob/master/docs/figs/figure_btc_last_300days.png" width="600" />
</a>
</p>
#
* [Example: Detect peak and valleys in Facebook](https://erdogant.github.io/caerus/pages/html/Examples.html)
<p align="left">
<a href="https://erdogant.github.io/caerus/pages/html/Examples.html">
<img src="https://github.com/erdogant/caerus/blob/master/docs/figs/figure_fb.png" width="600" />
</a>
</p>
* [Example: Gridsearch](https://erdogant.github.io/caerus/pages/html/Examples.html#gridsearch)
<p align="left">
<a href="https://erdogant.github.io/caerus/pages/html/Examples.html#gridsearch">
<img src="https://github.com/erdogant/caerus/blob/master/docs/figs/figure_gridsearch_btc.png" width="600" />
</a>
</p>
<hr>
### Support
This project needs some love! ❤️
Contribute to this project by feature requests, idea discussions, reporting bugs, opening pull requests, or through Github Sponsors. Your help is highly appreciated.
* If you wish to buy me a <a href="https://www.buymeacoffee.com/erdogant">Coffee</a> for this work, it is very appreciated :)
[](https://github.com/sponsors/erdogant)
### Maintainers
* Erdogan Taskesen, github: [erdogant](https://github.com/erdogant)
Raw data
{
"_id": null,
"home_page": null,
"name": "caerus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "Python, peak detection, signal processing, stocks, TA, Technical Analysis",
"author": null,
"author_email": "Erdogan Taskesen <erdogant@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/3e/75/8c0d4683cda7f103ca0a0b555325e51e6134bef871d5cdbdeb620e40d7d8/caerus-1.0.1.tar.gz",
"platform": null,
"description": "# caerus\r\n\r\n[](https://img.shields.io/pypi/pyversions/caerus)\r\n[](https://pypi.org/project/caerus/)\r\n[](https://github.com/erdogant/caerus/blob/master/LICENSE)\r\n[](https://pepy.tech/project/caerus)\r\n[](https://pepy.tech/project/caerus/month)\r\n[](https://erdogant.github.io/caerus/)\r\n<!---[](https://www.buymeacoffee.com/erdogant)-->\r\n<!---[](https://erdogant.github.io/donate/?currency=USD&amount=5)-->\r\n\r\n``caerus`` is Python package to compute the local-minima with the corresponding local-maxima within the given time-frame. This approach is designed to for stock-market valley and peak detection.\r\n\r\nHere are just a few of the things that caerus does well:\r\n - Ouput contains detected start-stop regions of local minima and maxima.\r\n - Figures are created.\r\n - Parameter gridsearch.\r\n - Designed for the detection of complex trend movements.\r\n\r\n# \r\n**\u2b50\ufe0f Star this repo if you like it \u2b50\ufe0f**\r\n#\r\n\r\n#### Install caerus from PyPI\r\n\r\n```bash\r\npip install caerus\r\n```\r\n\r\n#### Import caerus package\r\n\r\n```python\r\nfrom caerus import caerus\r\n```\r\n# \r\n\r\n\r\n### [Documentation pages](https://erdogant.github.io/caerus/)\r\n\r\nOn the [documentation pages](https://erdogant.github.io/caerus/) you can find detailed information about the working of the ``caerus`` with examples. \r\n\r\n<hr> \r\n\r\n### Examples\r\n\r\n# \r\n\r\n* [Example: Detect peak and valleys in Bitcoin](https://erdogant.github.io/caerus/pages/html/Examples.html)\r\n\r\n<p align=\"left\">\r\n <a href=\"https://erdogant.github.io/caerus/pages/html/Examples.html\">\r\n <img src=\"https://github.com/erdogant/caerus/blob/master/docs/figs/figure_btc.png\" width=\"600\" />\r\n <img src=\"https://github.com/erdogant/caerus/blob/master/docs/figs/figure_btc_last_300days.png\" width=\"600\" />\r\n </a>\r\n</p>\r\n\r\n\r\n# \r\n\r\n* [Example: Detect peak and valleys in Facebook](https://erdogant.github.io/caerus/pages/html/Examples.html)\r\n\r\n<p align=\"left\">\r\n <a href=\"https://erdogant.github.io/caerus/pages/html/Examples.html\">\r\n <img src=\"https://github.com/erdogant/caerus/blob/master/docs/figs/figure_fb.png\" width=\"600\" />\r\n </a>\r\n</p>\r\n\r\n\r\n* [Example: Gridsearch](https://erdogant.github.io/caerus/pages/html/Examples.html#gridsearch)\r\n\r\n<p align=\"left\">\r\n <a href=\"https://erdogant.github.io/caerus/pages/html/Examples.html#gridsearch\">\r\n <img src=\"https://github.com/erdogant/caerus/blob/master/docs/figs/figure_gridsearch_btc.png\" width=\"600\" />\r\n </a>\r\n</p>\r\n\r\n\r\n<hr>\r\n\r\n\r\n### Support\r\n\r\nThis project needs some love! \u2764\ufe0f\r\n\r\nContribute to this project by feature requests, idea discussions, reporting bugs, opening pull requests, or through Github Sponsors. Your help is highly appreciated.\r\n\r\n* If you wish to buy me a <a href=\"https://www.buymeacoffee.com/erdogant\">Coffee</a> for this work, it is very appreciated :)\r\n\r\n[](https://github.com/sponsors/erdogant)\r\n \r\n### Maintainers\r\n* Erdogan Taskesen, github: [erdogant](https://github.com/erdogant)\r\n\r\n\r\n",
"bugtrack_url": null,
"license": null,
"summary": "caerus is a Python library for peak detection.",
"version": "1.0.1",
"project_urls": {
"Download": "https://github.com/erdogant/caerus/archive/{version}.tar.gz",
"Homepage": "https://erdogant.github.io/caerus"
},
"split_keywords": [
"python",
" peak detection",
" signal processing",
" stocks",
" ta",
" technical analysis"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "589530a94a8660b46c50959e3380d657cbff3ca42eeeab963e78949c86ccea21",
"md5": "3ba981826c805175cc8566d34f58a8f5",
"sha256": "213656ce7717b9b5a093ab5ebceacc6e892baebb4760a3df9ef6b7705e446ff6"
},
"downloads": -1,
"filename": "caerus-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3ba981826c805175cc8566d34f58a8f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 17524,
"upload_time": "2025-08-30T11:36:01",
"upload_time_iso_8601": "2025-08-30T11:36:01.854587Z",
"url": "https://files.pythonhosted.org/packages/58/95/30a94a8660b46c50959e3380d657cbff3ca42eeeab963e78949c86ccea21/caerus-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3e758c0d4683cda7f103ca0a0b555325e51e6134bef871d5cdbdeb620e40d7d8",
"md5": "f20ae40f1cb70bbabbb10fa8f563110e",
"sha256": "193843e50977930569e4070f7d28b1f550df20699b2e048762348d03f0a29f43"
},
"downloads": -1,
"filename": "caerus-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "f20ae40f1cb70bbabbb10fa8f563110e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 21521,
"upload_time": "2025-08-30T11:36:02",
"upload_time_iso_8601": "2025-08-30T11:36:02.774239Z",
"url": "https://files.pythonhosted.org/packages/3e/75/8c0d4683cda7f103ca0a0b555325e51e6134bef871d5cdbdeb620e40d7d8/caerus-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-30 11:36:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "erdogant",
"github_project": "caerus",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "tqdm",
"specs": []
}
],
"lcname": "caerus"
}
JSON
