Installation Guide#

BEEhaviourLab is distributed as a Python package.

Using pip#

To install the latest stable release from PyPI:

pip install beehaviourlab

Alternatively, install with packages to generate docs or to run tests:

pip install "beehaviourlab[docs]"
pip install "beehaviourlab[test]"

To install with all extras (docs + tests):

pip install "beehaviourlab[dev]"

To install an editable package from source (recommended for development):

git clone https://github.com/BEEhaviourLab/BEEhaviourLab.git
cd BEEhaviourLab
pip install -e .

Installation from source with packages for generating docs:

pip install -e ".[docs]"

This will install Sphinx and other dependencies required to build the documentation.

To build the docs locally:

sphinx-build -b html docs docs/_build/html

The generated HTML can be found in docs/_build/html.

To install with test dependencies, or both docs and test dependencies:

pip install -e ".[test]"
pip install -e ".[dev]"