Installation Guide

This document provides a step-by-step guide on how to install and set up the project. Please follow the instructions carefully.

---

LiGuard is tested on Windows 11 with Python 3.10.0. However, it should work on any OS that support following dependencies:

keyboard==0.13.5
pyyaml==6.0.1
open3d==0.18.0
opencv-python==4.9.0.80
dbscan==0.0.12

We recommend using a virtual environment (like Conda) to install the LiGuard.

First create a new virtual environment and activate it:

conda create -n liguard python=3.10
conda activate liguard

Then, clone the repository:

git clone https://github.com/m-shahbaz-kharal/LiGuard-JOSS.git
cd LiGuard-JOSS

Lastly, install the dependencies:

pip install -r requirements.txt