Skip to content

Commit

Permalink
fix PPA link (#42)
Browse files Browse the repository at this point in the history
* fix PPA link

* add prerequiresite

* add wiki links

* add dependencies
  • Loading branch information
koide3 authored Jul 24, 2024
1 parent 01fca4d commit 3d65b3b
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 38 deletions.
2 changes: 2 additions & 0 deletions docs/demo.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Demo data

See more videos at [Video Gallery](https://github.com/koide3/glim/wiki/Video-Gallery).

## Mapping with various range sensors

- [Download dataset](https://zenodo.org/record/6864654)
Expand Down
34 changes: 1 addition & 33 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,3 @@
# FAQ

## IMU-related issues

If you face troubles, which may be related to IMU (e.g., estimation gets degraded when the LiDAR rotates), try the [imu_validator](https://github.com/koide3/glim_ext/tree/master/modules/odometry/imu_validator) module to see if the LiDAR-IMU transformation is properly calibrated.

This module plots the linear acceleration vector in the world frame (which should be around [0, 0, +g] regardless of the LiDAR pose) and the angular velocity estimated by LiDAR and IMU (they should be similar and synchronized).

<div class="youtube">
<iframe width="560" height="315" src="https://www.youtube.com/embed/tsOJHTObuqY" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

!!!tip
To enable this extension module, you need to build [glim_ext](https://github.com/koide3/glim_ext) along with GLIM and add ```"libimu_validator.so"``` to [```"glim_ros/extension_modules"```](https://github.com/koide3/glim/blob/36cccb3851100f8d351874f81720dbe577b0cc81/config/config_ros.json#L11) in [```config_ros.json```](https://github.com/koide3/glim/blob/master/config/config_ros.json). The validation GUI will appear on the standard viewer of GLIM.

You can also check if IMU velocity and bias are properly estimated by clicking the Status button in the standard viewer. If the bias values are too large (> 0.5) or too frequently changed, the IMU may not be well synchronized and calibrated with the LiDAR.

![frontend](assets/frontend_status.png)


## The created map is tilted

Because the initial upward direction (gravity direction) of the map frame is estimated through a loose-coupling-based LiDAR-IMU fusion that may fail in dynamic motion. Try to keep the sensor at rest for the first a few seconds.

!!!tip
You can manually provide an initial gravity-aligned sensor pose by specifying ```odometry_estimation/init_T_world_imu``` in ```config_odometry_*.json``` to skip the initial state estimation.


## failed to load (modulename) module or (modulename).so

This error indicates that the shared library of the module is not visible to the current environment.

1. Reload ROS-related paths : ```source ros2_ws/install/setup.bash```.
2. `echo $LD_LIBRARY_PATH` and see if the library paths of related packages are contained (e.g., `/home/user/ros2_ws/install/glim/lib`). If not, re-install ROS and all packages from scratch.

Moved to [wiki/FAQ](https://github.com/koide3/glim/wiki/FAQ).
16 changes: 11 additions & 5 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,25 +46,31 @@ sudo make install
sudo ldconfig
```

#### From [PPA](https://github.com/koide3/gtsam_points) [Ubuntu 24.04 , 22.04, 20.04 / AMD64, ARM64]
#### From [PPA](https://koide3.github.io/ppa/) [Ubuntu 24.04 , 22.04, 20.04 / AMD64, ARM64]

##### Setup PPA for Ubuntu 24.04
##### Prequiresite

```bash
sudo apt install curl gpg
```

##### Setup PPA for Ubuntu 24.04

```bash
curl -s --compressed "https://koide3.github.io/ppa/ubuntu2404/KEY.gpg" | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/koide3_ppa.gpg >/dev/null
echo "deb [signed-by=/etc/apt/trusted.gpg.d/koide3_ppa.gpg] https://koide3.github.io/ppa/ubuntu2404 ./" | sudo tee /etc/apt/sources.list.d/koide3_ppa.list
```

##### Setup PPA for Ubuntu 22.04

```
```bash
curl -s --compressed "https://koide3.github.io/ppa/ubuntu2204/KEY.gpg" | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/koide3_ppa.gpg >/dev/null
echo "deb [signed-by=/etc/apt/trusted.gpg.d/koide3_ppa.gpg] https://koide3.github.io/ppa/ubuntu2204 ./" | sudo tee /etc/apt/sources.list.d/koide3_ppa.list
```

##### Setup PPA for Ubuntu 20.04

```
```bash
curl -s --compressed "https://koide3.github.io/ppa/ubuntu2004/KEY.gpg" | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/koide3_ppa.gpg >/dev/null
echo "deb [signed-by=/etc/apt/trusted.gpg.d/koide3_ppa.gpg] https://koide3.github.io/ppa/ubuntu2004 ./" | sudo tee /etc/apt/sources.list.d/koide3_ppa.list
```
Expand All @@ -73,7 +79,7 @@ echo "deb [signed-by=/etc/apt/trusted.gpg.d/koide3_ppa.gpg] https://koide3.githu

```bash
sudo apt update
sudo apt install -y libiridescence-dev
sudo apt install -y libiridescence-dev libboost-all-dev libglfw3-dev libmetis-dev

# Choose one of the follows
sudo apt install -y libgtsam-points-dev # without CUDA
Expand Down
4 changes: 4 additions & 0 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,3 +199,7 @@ ros2 run glim_ros offline_viewer

#### Export map point cloud (PLY format)
- ```File``` -> ```Save``` -> ```Export Points```

## Setup your own sensor

See [Sensor setup guide](https://github.com/koide3/glim/wiki/Sensor-setup-guide).

0 comments on commit 3d65b3b

Please sign in to comment.