You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-7Lines changed: 12 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -129,7 +129,7 @@ $ cd pyslam
129
129
130
130
Then, under **Ubuntu** and **MacOs** you can simply run:
131
131
```bash
132
-
#$ pixi shell # if you want to use pixi
132
+
#$ pixi shell # If you want to use pixi, this prepares the installation.
133
133
$ ./install_all.sh
134
134
```
135
135
@@ -180,7 +180,8 @@ If you prefer docker or you have an OS that is not supported yet, you can use [r
180
180
181
181
The provided install scripts take care of installing a recent opencv version (>=**4.10**) with non-free modules enabled (see [install_pip3_packages.sh](./install_pip3_packages.sh) and [install_opencv_python.sh](./install_opencv_python.sh)). To quickly verify your installed opencv version run:
182
182
```bash
183
-
$ . pyenv-activate.sh # Activate pyslam python virtual environment. This is only needed once in a new terminal.
183
+
#$ pixi shell # If you use pixi, this activate the pyslam environment.
184
+
$ . pyenv-activate.sh # Activate `pyslam` python environment. Only needed once in a new terminal. Not needed under pixi.
184
185
$ ./scripts/opencv_check.py
185
186
```
186
187
Otherwise, run the following commands:
@@ -199,7 +200,8 @@ If you run into issues or errors during the installation process or at run-time,
199
200
200
201
Open a new terminal and start experimenting with the scripts. In each new terminal, you are supposed to start with this command:
201
202
```bash
202
-
$ . pyenv-activate.sh # Activate pyslam python virtual environment. This is only needed once in a new terminal.
203
+
#$ pixi shell # If you use pixi, this activate the pyslam environment.
204
+
$ . pyenv-activate.sh # Activate `pyslam` python environment. Only needed once in a new terminal. Not needed under pixi.
203
205
```
204
206
If you are using `pixi` then just run `pixi shell` to activate the `pyslam` environment.
205
207
The file [config.yaml](./config.yaml) can be used as a unique entry-point to configure the system and its global configuration parameters contained in [config_parameters.py](./config_parameters.py). Further information on how to configure pySLAM are provided [here](#selecting-a-dataset-and-different-configuration-parameters).
@@ -210,7 +212,8 @@ The file [config.yaml](./config.yaml) can be used as a unique entry-point to con
210
212
211
213
The basic **Visual Odometry** (VO) can be run with the following commands:
212
214
```bash
213
-
$ . pyenv-activate.sh # Activate pyslam python virtual environment. This is only needed once in a new terminal.
215
+
#$ pixi shell # If you use pixi, this activate the pyslam environment.
216
+
$ . pyenv-activate.sh # Activate `pyslam` python environment. Only needed once in a new terminal. Not needed under pixi.
214
217
$ ./main_vo.py
215
218
```
216
219
By default, this processes a [KITTI](http://www.cvlibs.net/datasets/kitti/eval_odometry.php) video (available in the folder `data/videos`) by using its corresponding camera calibration file (available in the folder `settings`), and its groundtruth (available in the same `data/videos` folder). If matplotlib windows are used, you can stop `main_vo.py` by focusing/clicking on one of them and pressing the key 'Q'. As explained above, this very *basic* script `main_vo.py`**strictly requires a ground truth**.
@@ -221,7 +224,8 @@ Now, with RGBD datasets, you can also test the **RGBD odometry** with the classe
221
224
222
225
Similarly, you can test the **full SLAM** by running `main_slam.py`:
223
226
```bash
224
-
$ . pyenv-activate.sh # Activate pyslam python virtual environment. This is only needed once in a new terminal.
227
+
#$ pixi shell # If you use pixi, this activate the pyslam environment.
228
+
$ . pyenv-activate.sh # Activate `pyslam` python environment. Only needed once in a new terminal. Not needed under pixi.
225
229
$ ./main_slam.py
226
230
```
227
231
@@ -247,7 +251,8 @@ You can use the section `GLOBAL_PARAMETERS` of the file [config.yaml](./config.y
247
251
248
252
If you just want to test the basic feature tracking capabilities (*feature detector* + *feature descriptor* + *feature matcher*) and get a taste of the different available local features, run
249
253
```bash
250
-
$ . pyenv-activate.sh # Activate pyslam python virtual environment. This is only needed once in a new terminal.
254
+
#$ pixi shell # If you use pixi, this activate the pyslam environment.
255
+
$ . pyenv-activate.sh # Activate `pyslam` python environment. Only needed once in a new terminal. Not needed under pixi.
251
256
$ ./main_feature_matching.py
252
257
```
253
258
@@ -372,7 +377,7 @@ Refer to the file `depth_estimation/depth_estimator_factory.py` for further deta
The semantic mapping pipeline can be enabled by setting the parameter `kDoSemanticMapping=True` in `config_parameters.py`. The best way of configuring the semantic mapping module used is to modify it in `semantic_mapping_configs.py`.
0 commit comments