caerus's documentation!
==============================

|python| |pypi| |docs| |stars| |LOC| |downloads_month| |downloads_total| |license| |forks| |open issues| |project status| |colab| |repo-size| |donate|


.. |fig1| image:: ../figs/figure_btc_last_300days.png

.. table::
   :align: center

   +----------+
   | |fig1|   |
   +----------+

-----------------------------------

``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:**

	* Detects peaks and valleys in complex trends.
	* Insightful plots. 
	* Parameter gridsearch.
	* Designed for trend movements such as as in stockmarket data.




-----------------------------------

.. note::
	**Your ❤️ is important to keep maintaining this package.** You can `support <https://erdogant.github.io/caerus/pages/html/Documentation.html>`_ in various ways, have a look at the `sponser page <https://erdogant.github.io/caerus/pages/html/Documentation.html>`_.
	Report bugs, issues and feature extensions at `github <https://github.com/erdogant/caerus/>`_ page.

	.. code-block:: console

	   pip install caerus

-----------------------------------



Content
=======

.. toctree::
   :maxdepth: 1
   :caption: Background
   
   Background

.. toctree::
   :maxdepth: 1
   :caption: Installation
   
   Installation


.. toctree::
  :maxdepth: 1
  :caption: Tutorials

  Tutorials


.. toctree::
  :maxdepth: 1
  :caption: Examples

  Examples

.. toctree::
  :maxdepth: 1
  :caption: Documentation
  
  Documentation
  Coding quality
  caerus.caerus





Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. |python| image:: https://img.shields.io/pypi/pyversions/caerus.svg
    :alt: |Python
    :target: https://erdogant.github.io/caerus/

.. |pypi| image:: https://img.shields.io/pypi/v/caerus.svg
    :alt: |Python Version
    :target: https://pypi.org/project/caerus/

.. |docs| image:: https://img.shields.io/badge/Sphinx-Docs-blue.svg
    :alt: Sphinx documentation
    :target: https://erdogant.github.io/caerus/

.. |stars| image:: https://img.shields.io/github/stars/erdogant/caerus
    :alt: Stars
    :target: https://img.shields.io/github/stars/erdogant/caerus

.. |LOC| image:: https://sloc.xyz/github/erdogant/caerus/?category=code
    :alt: lines of code
    :target: https://github.com/erdogant/caerus

.. |downloads_month| image:: https://static.pepy.tech/personalized-badge/caerus?period=month&units=international_system&left_color=grey&right_color=brightgreen&left_text=PyPI%20downloads/month
    :alt: Downloads per month
    :target: https://pepy.tech/project/caerus

.. |downloads_total| image:: https://static.pepy.tech/personalized-badge/caerus?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads
    :alt: Downloads in total
    :target: https://pepy.tech/project/caerus

.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
    :alt: License
    :target: https://github.com/erdogant/caerus/blob/master/LICENSE

.. |forks| image:: https://img.shields.io/github/forks/erdogant/caerus.svg
    :alt: Github Forks
    :target: https://github.com/erdogant/caerus/network

.. |open issues| image:: https://img.shields.io/github/issues/erdogant/caerus.svg
    :alt: Open Issues
    :target: https://github.com/erdogant/caerus/issues

.. |project status| image:: http://www.repostatus.org/badges/latest/active.svg
    :alt: Project Status
    :target: http://www.repostatus.org/#active

.. |donate| image:: https://img.shields.io/badge/Support%20this%20project-grey.svg?logo=github%20sponsors
    :alt: donate
    :target: https://erdogant.github.io/caerus/pages/html/Documentation.html#

.. |colab| image:: https://colab.research.google.com/assets/colab-badge.svg
    :alt: Colab example
    :target: https://erdogant.github.io/caerus/pages/html/Documentation.html#colab-notebook


.. |repo-size| image:: https://img.shields.io/github/repo-size/erdogant/caerus
    :alt: repo-size
    :target: https://img.shields.io/github/repo-size/erdogant/caerus

.. include:: add_bottom.add