# 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": "https://erdogant.github.io/caerus",
"name": "caerus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": null,
"author": "Erdogan Taskesen",
"author_email": "erdogant@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d3/66/c16490b7f4a0478193a51483f7d97cf87c53b068b3b1a8d758f8890e654f/caerus-0.1.10.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": "Python package caerus",
"version": "0.1.10",
"project_urls": {
"Download": "https://github.com/erdogant/caerus/archive/0.1.10.tar.gz",
"Homepage": "https://erdogant.github.io/caerus"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "80c7999981ad964078ca19d3441b3ffc822d211bf6dc5f49bf265ed709664a85",
"md5": "c9b6561e0a2935bf6d9fb099fb7ff4c5",
"sha256": "2c5ab577a7c2e445c06cd926b4ed99676b0997549b48700db0fc241ae5203aee"
},
"downloads": -1,
"filename": "caerus-0.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c9b6561e0a2935bf6d9fb099fb7ff4c5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 17500,
"upload_time": "2024-05-17T14:39:50",
"upload_time_iso_8601": "2024-05-17T14:39:50.666674Z",
"url": "https://files.pythonhosted.org/packages/80/c7/999981ad964078ca19d3441b3ffc822d211bf6dc5f49bf265ed709664a85/caerus-0.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d366c16490b7f4a0478193a51483f7d97cf87c53b068b3b1a8d758f8890e654f",
"md5": "6adb1e87f11c3493389c205abfcb58ac",
"sha256": "e2cac5a1f1c5cbdebfa687ccb969a64630510f597724a6590049d1ee79452353"
},
"downloads": -1,
"filename": "caerus-0.1.10.tar.gz",
"has_sig": false,
"md5_digest": "6adb1e87f11c3493389c205abfcb58ac",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 16404,
"upload_time": "2024-05-17T14:39:52",
"upload_time_iso_8601": "2024-05-17T14:39:52.330435Z",
"url": "https://files.pythonhosted.org/packages/d3/66/c16490b7f4a0478193a51483f7d97cf87c53b068b3b1a8d758f8890e654f/caerus-0.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-17 14:39:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "erdogant",
"github_project": "caerus",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "caerus"
}
JSON
