An open API service indexing awesome lists of open source software.

https://github.com/erdogant/caerus

Detection of favorable moments in time series data
https://github.com/erdogant/caerus

optimization-algorithms peak-analysis peak-detection python stock-data time-series time-series-analysis trading trading-strategies

Last synced: over 1 year ago
JSON representation

Detection of favorable moments in time series data

Awesome Lists containing this project

README

          

# caerus

[![Python](https://img.shields.io/pypi/pyversions/caerus)](https://img.shields.io/pypi/pyversions/caerus)
[![PyPI Version](https://img.shields.io/pypi/v/caerus)](https://pypi.org/project/caerus/)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/erdogant/caerus/blob/master/LICENSE)
[![Downloads](https://pepy.tech/badge/caerus)](https://pepy.tech/project/caerus)
[![Downloads](https://pepy.tech/badge/caerus/month)](https://pepy.tech/project/caerus/month)
[![Sphinx](https://img.shields.io/badge/Sphinx-Docs-Green)](https://erdogant.github.io/caerus/)

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


### Examples

#

* [Example: Detect peak and valleys in Bitcoin](https://erdogant.github.io/caerus/pages/html/Examples.html)






#

* [Example: Detect peak and valleys in Facebook](https://erdogant.github.io/caerus/pages/html/Examples.html)





* [Example: Gridsearch](https://erdogant.github.io/caerus/pages/html/Examples.html#gridsearch)






### 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 Coffee for this work, it is very appreciated :)

[![Github Sponsors](https://img.shields.io/github/sponsors/erdogant?label=github%20sponsors&logo=github%20sponsors&style=for-the-badge)](https://github.com/sponsors/erdogant)

### Maintainers
* Erdogan Taskesen, github: [erdogant](https://github.com/erdogant)