caerus 0.1.3

Python package caerus

caerus

In Greek mythology, Caerus (same as kairos) was the personification of opportunity, luck and favorable moments. He was shown with only one lock of hair. His Roman equivalent was Occasio or Tempus. Caerus was the youngest child of Zeus.

caerus is a python package providing that determines the local-minima with the corresponding local-maxima within the given time-frame. The method is build using a forward rolling window to iteratively evaluate thousands of windows. For each window a score of percentages is computed from the start-to-stop position. The resulting matrix is a [window x length dataframe] for which only the high scoring percentages, e.g. those above a certain value (minperc) are used. The best scoring percentages is then aggregated by sum per time-point followed by a cut using the threshold. The resulting regions are subsequently detected, and represent the starting-locations of the trade. The stop-locations are determined based on the distance and percentage of te start-locations. As an example, if you want to have best regions, use threshold=1, minperc=high and nlargest=1 (small).

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.

Contents

• Installation
• Contribute
• Citation
• Maintainers
• License

Installation

• Install caerus from PyPI (recommended). caerus is compatible with Python 3.6+ and runs on Linux, MacOS X and Windows.
• A new environment can be created as following:

conda create -n env_caerus python=3.7
conda activate env_caerus

pip install caerus

• Alternatively, install caerus from the GitHub source:

# Directly install from github source
pip install -e git://github.com/erdogant/caerus.git@0.1.0#egg=master
pip install git+https://github.com/erdogant/caerus#egg=master

Import caerus package

from caerus import caerus

Example 1:

cs = caerus()
X = cs.download_example()
cs.fit(X)
cs.plot()

Example 2:

cs = caerus()
X = cs.download_example(name='facebook')
cs.fit(X)
cs.plot()

Example gridsearch:

cs = caerus()
X = cs.download_example(name='facebook')
cs.gridsearch(X)
cs.plot()

# Change some gridsearch parameters
cs.gridsearch(X, window=np.arange(50,550,100), minperc=np.arange(1,20,5))
cs.plot()

Citation

Please cite caerus in your publications if this is useful for your research. Here is an example BibTeX entry:

@misc{erdogant2020caerus,
  title={caerus},
  author={Erdogan Taskesen},
  year={2020},
  howpublished={\url{https://github.com/erdogant/caerus}},
}

References

• https://github.com/erdogant/caerus

Maintainer

Erdogan Taskesen, github: [erdogant](https://github.com/erdogant/caerus)
Contributions are welcome.
This work is created and maintained in my free time. If you wish to buy me a <a href="https://erdogant.github.io/donate/?currency=USD&amount=5">Coffee</a> for this work, it is very appreciated.