Metadata-Version: 2.1
Name: beeoptimal
Version: 0.1.0
Summary: A Python implementation of the Artificial Bee Colony (ABC) optimization algorithm
Author-email: Giulio Fantuzzi <giulio.fantuzzi01@gmail.com>
License: MIT License
        
        Copyright (c) 2024 Giulio Fantuzzi
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Documentation, https://readthedocs.org
Project-URL: Repository, https://github.com/giuliofantuzzi/BeeOptimal
Project-URL: Issues, https://github.com/giuliofantuzzi/BeeOptimal/issues
Keywords: metahueristic,optimization,artificial bee colony,swarm intelligence
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12.1
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy<2.0.0,>=1.26.4
Requires-Dist: plotly>=5.24.1
Requires-Dist: tqdm>=4.66.4
Requires-Dist: pillow>=10.3.0
Requires-Dist: kaleido>=0.2.1
Provides-Extra: docs
Requires-Dist: sphinx>=4.0.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: nbsphinx-link; extra == "docs"
Requires-Dist: sphinx-rtd-dark-mode; extra == "docs"
Provides-Extra: tutorials
Requires-Dist: ipython>=8.12.3; extra == "tutorials"
Requires-Dist: torchvision>=0.18.1; extra == "tutorials"
Requires-Dist: matplotlib>=3.8.4; extra == "tutorials"

<div align="center">
  <img src="https://github.com/giuliofantuzzi/BeeOptimal/raw/main/assets/logo_BeeOptimal.png" alt="Logo" width="250">
  <h3 align="center">BeeOptimal</h3>
  <p align="center">
    A Python implementation of the Artificial Bee Colony (ABC) optimization algorithm
    <br />
      <a href="https://beeoptimal.readthedocs.io/en/latest"><strong>Explore the docs »</strong></a>
    <br />
  </p>
</div>

# About

**`BeeOptimal`** is an open-source Python package that implements the **Artificial Bee Colony (ABC)** algorithm, a population-based optimization method 
inspired by the foraging behavior of honeybee swarms and 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.

# Installation

Before installing the package, make sure you have **`Python 3.12` or higher** installed on your system. 
In case you want to avoid any conflicts with your system's Python packages, you might want to create (and activate) a dedicated virtual environment:

```bash
python -m venv /path/to/beeoptimal_env
source /path/to/beeoptimal_env/bin/activate
```

## Installing via PIP

You can install the package from the `Python Package Index (PyPI)` via pip:

```bash
pip install beeoptimal
```

## Installing from source

1. Clone the repository:
   
   ```bash
   git clone https://github.com/giuliofantuzzi/BeeOptimal.git
   ```

2. Move into the repository directory and install the package with:
   
   ```bash
   cd BeeOptimal/
   pip install .
   ```

## Optional Dependencies

In addition to the core functionalities, this package offers optional dependencies for specific use cases.

To build and work with the documentation, you can install the package with the docs extra:

```bash
pip install beeoptimal[docs]
```
To use the tutorials and their required dependencies, install the package with the tutorials extra:
  
```bash
pip install beeoptimal[tutorials]
```

To install both the documentation and the tutorials, you can use directly:

```bash
pip install beeoptimal[docs,tutorials]
```

> [!NOTE]
> The same syntax can be followed when installing from source. Moreover, if you're using the `zsh` shell, you will need to wrap the extras in quotes to prevent conflicts with shell globbing (unquoted square brackets ([ ]) are used for pattern matching in `zsh`).
