r3w0p/bobocep

View on GitHub
docs/index.rst

Summary

Maintainability
Test Coverage
=======
BoboCEP
=======

.. rubric:: About

:code:`BoboCEP` is a
`Complex Event Processing <https://en.wikipedia.org/wiki/Complex_event_processing>`_
(CEP) engine designed for
`edge computing <https://en.wikipedia.org/wiki/Edge_computing>`_
in
`Internet of Things <https://en.wikipedia.org/wiki/Internet_of_things>`_
(IoT) systems to facilitate inferential reasoning and decision-making on streaming data.
It provides
`fault tolerance <https://en.wikipedia.org/wiki/Fault_tolerance>`_
(FT) via the
`active replication <https://en.wikipedia.org/wiki/Replication_(computing)>`_
of partially-completed complex events across multiple instances of the software.

.. rubric:: License

It is an open source project, as per the
`Open Source Definition <https://opensource.org/osd>`_.
The
`source code <https://github.com/r3w0p/bobocep>`_
can be redistributed and/or modified under the terms of the
`MIT License <https://github.com/r3w0p/bobocep/blob/main/LICENSE>`_.

.. rubric:: Documentation

Documentation is hosted by `Read the Docs <https://bobocep.readthedocs.io>`_,
which also provides a
`PDF version <https://bobocep.readthedocs.io/_/downloads/en/latest/pdf/>`_.


.. toctree::
   :caption: Contents
   :maxdepth: 0
   :hidden:


.. toctree::
   :caption: Introduction
   :maxdepth: 1
   :hidden:

   installation
   getting_started
   examples
   use_cases


.. toctree::
   :caption: Learning
   :maxdepth: 1
   :hidden:

   phenomena
   actions
   distributed
   publications
   glossary


.. toctree::
   :caption: Development
   :maxdepth: 1
   :hidden:

   source_code
   developer_guide
   contributing