Installation

Installation#

Instructions#

You can install the package locally or use our docker image.

  • Install the package locally:

To install it using pip, you can run the following command:

pip install paidiverpy

You can also build the package from source. To do so, you need to clone the repository and install the package using the following commands:

  1. Clone the repository:

# ssh
git clone git@github.com:paidiver/paidiverpy.git

# you can also clone using https
# git clone https://github.com/paidiver/paidiverpy.git

cd paidiverpy

  1. (Optional) Create a Python virtual environment to manage dependencies separately from other projects. For example, using conda:

conda env create -f environment.yml
conda activate Paidiverpy

  1. Install the paidiverpy package:

Finally, you can install the paidiverpy package:

pip install -e .

  • Use the Docker image:

You can run Paidiverpy using Docker by either building the container locally or pulling a pre-built image from GitHub Container Registry (GHCR) or Docker Hub.

  1. Option 1: Build the container locally:

Clone the repository and build the image:

git clone git@github.com:paidiver/paidiverpy.git
cd paidiverpy
docker build -t paidiverpy -f dockerfiles/Dockerfile .

  1. Option 2: Pull from GitHub Container Registry (GHCR):

Fetch the latest image from GitHub:

docker pull ghcr.io/paidiver/paidiverpy:latest
docker tag ghcr.io/paidiver/paidiverpy:latest paidiverpy:latest

Required and additional dependencies#

Requirement dependencies details can be found here. These dependencies will be installed automatically when you install the package.

You may also need to install the following packages (required by opencv-python):

  • libgl

  • libegl

  • libopengl

On Ubuntu/Debian, you can install these packages using the following command:

sudo apt install -y libgl1 libegl1 libopengl0

If you want to use the GUI features of Paidiverpy, you will need to install the panel package. You can do this by running the following command:

pip install panel