Installation

Before installing the package, make sure you have Python 3.12 or higher installed on your system.

To avoid any conflicts with your system’s Python packages, it is recommended to create and activate a dedicated virtual environment:

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:

pip install beeoptimal

Installing from source

Clone the repository:

git clone https://github.com/giuliofantuzzi/BeeOptimal.git

Move into the repository directory and install the package with:
```
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:

pip install beeoptimal[docs]

To use the tutorials and their required dependencies, install the package with the tutorials extra:

pip install beeoptimal[tutorials]

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

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, as unquoted square brackets ([ ]) are used for pattern matching in zsh.