diff --git a/README.md b/README.md index be8f34e..ec88fc4 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,98 @@ -A python wrapper around M3T tracker from https://github.com/DLR-RM/3DObjectTracking/tree/master +# PYM3T -# Installation +A python wrapper around M3T tracker from [DLR-RM/3DObjectTracking](https://github.com/DLR-RM/3DObjectTracking/tree/master). -`git clone git@github.com:MedericFourmy/pym3t.git --recursive` +## Installation -Install dependencies with conda: -`conda env create --name pym3t --file environment.yaml` +To install pym3t, you can use pip or poetry. -Then -`pip install .` +We strongly suggest to install it in either a +[venv](https://docs.python.org/fr/3/library/venv.html) or a +[conda environment](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html). + +### Example with conda + +``` +git clone https://github.com/agimus-project/pym3t +cd pym3t +conda env create -f environment.yml +conda activate pym3t +pip install . +``` + +### Example with venv + +> [!NOTE] +> M3T relies on [GLFW](https://www.glfw.org/). Before building ensure it is installed. +> For Ubuntu run `apt-get install libglfw3 libglfw3-dev` + + +``` +git clone https://github.com/agimus-project/pym3t +cd pym3t +python -m venv .venv +source .venv/bin/activate +pip install . +``` # Example scripts -As example of usage of the library, scripts are provided: -* `run_image_dir_example.py`: single object tracking using color and depth images from filesystem -* `run_webcam_example.py`: single object tracking with first camera device detected by the system (webcam or other usb camera usually) -* `run_realsense_example.py`: single object tracking with realsense camera +As example usage of the library, we provide several scripts: +* `run_image_dir_example.py`: single object tracking using color and depth images from filesystem; +* `run_webcam_example.py`: single object tracking with first camera device detected by the system (webcam or other usb camera usually); +* `run_realsense_example.py`: single object tracking with realsense camera. -:question:: check available options with `python