This package is a Python implementation of the Behaverse API. It allows you to interact with the Behaverse datasets in Python.

To install the package, you can use pip:

pip install behaverse

See the Behaverse website for more information on how to use the package.

TODO

Before starting development, you need to install the dependencies. You can do this by creating a new conda environment as defined in the environment.yml file:

mamba env create -f environment.yml
mamba activate behaverse

To generate documentations and API reference, run the following commands from the main directory of the project:

cd docs
quartodoc build && quartodoc interlinks && quarto preview

The documentation will be available in the docs/_site/ directory.

TODO

TODO