.. BeeOptimal documentation master file

Welcome to BeeOptimal's Documentation 🐝🍯
==========================================

.. .. image:: _static/logo_BeeOptimal.png
..    :alt: BeeOptimal Logo
..    :align: center
..    :width: 200px

**BeeOptimal** is a Python package that implements the *Artificial Bee Colony (ABC)* algorithm, a nature-inspired optimization technique 
designed to solve complex optimization problems efficiently. Whether you are tackling high-dimensional search spaces, multi-modal objective functions, 
or simply need a reliable optimizer, **BeeOptimal** offers a user-friendly and customizable solution for your needs.

This documentation provides installation instructions and API details, as well as tutorials and examples to help you get started with the package.

.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   about
   installation
   

.. toctree::
   :maxdepth: 1
   :caption: API Reference

   abc
   bee
   benchmarks
   plotting

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

   tutorials/tutorial1
   tutorials/tutorial2
   tutorials/tutorial3
   tutorials/tutorial4
   tutorials/tutorial5

.. toctree::
   :maxdepth: 1
   :caption: References

   references