Skip to content

Commit 3649993

Browse files
committed
updated README
1 parent 3e37231 commit 3649993

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ $ cd pyslam
129129

130130
Then, under **Ubuntu** and **MacOs** you can simply run:
131131
```bash
132-
#$ pixi shell # if you want to use pixi
132+
#$ pixi shell # If you want to use pixi, this prepares the installation.
133133
$ ./install_all.sh
134134
```
135135

@@ -180,7 +180,8 @@ If you prefer docker or you have an OS that is not supported yet, you can use [r
180180

181181
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:
182182
```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.
184185
$ ./scripts/opencv_check.py
185186
```
186187
Otherwise, run the following commands:
@@ -199,7 +200,8 @@ If you run into issues or errors during the installation process or at run-time,
199200

200201
Open a new terminal and start experimenting with the scripts. In each new terminal, you are supposed to start with this command:
201202
```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.
203205
```
204206
If you are using `pixi` then just run `pixi shell` to activate the `pyslam` environment.
205207
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
210212

211213
The basic **Visual Odometry** (VO) can be run with the following commands:
212214
```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.
214217
$ ./main_vo.py
215218
```
216219
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
221224

222225
Similarly, you can test the **full SLAM** by running `main_slam.py`:
223226
```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.
225229
$ ./main_slam.py
226230
```
227231

@@ -247,7 +251,8 @@ You can use the section `GLOBAL_PARAMETERS` of the file [config.yaml](./config.y
247251

248252
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
249253
```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.
251256
$ ./main_feature_matching.py
252257
```
253258

@@ -372,7 +377,7 @@ Refer to the file `depth_estimation/depth_estimator_factory.py` for further deta
372377
373378
374379
<p style="text-align: center;">
375-
<img src="./images/semantic_mapping_from_david.jpeg" alt="Semantic Mapping" height="300"/>
380+
<img src="./images/semantic_mapping_from_david.jpeg" alt="Semantic Mapping" style="height: 300px; width: auto;"/>
376381
</p>
377382
378383
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

Comments
 (0)