Skip to content

Install

BoxJelly requires Python 3.8 or later; see python.org/downloads.

Installing BoxJelly from PyPI

BoxJelly is available on the Python Package Index (PyPI) as boxjelly. To install, run:

pip install boxjelly

You can check which version of BoxJelly you have installed with:

pip show boxjelly

Updating BoxJelly is easy:

pip install --upgrade boxjelly

Installing Cthulhu

BoxJelly uses the Cthulhu video player, which is available at github.com/mbari-media-management/cthulhu.


Building BoxJelly from source

BoxJelly is built with Poetry. If you would like to build from source, clone the repository:

git clone git@bitbucket.org:mbari/boxjelly

and then run the build command:

poetry build