Skip to content

Commit

Permalink
refine docs
Browse files Browse the repository at this point in the history
  • Loading branch information
koide3 committed Jul 10, 2024
1 parent 9069af2 commit 41f8aba
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 13 deletions.
7 changes: 4 additions & 3 deletions docs/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@

## Prebuilt docker images

We provide the following docker images for ROS1 and ROS2 environments on docker hub ([koide3/glim_ros](https://hub.docker.com/repository/docker/koide3/glim_ros)).
We provide the following docker images for ROS1 and ROS2 environments on docker hub ([koide3/glim_ros](https://hub.docker.com/repository/docker/koide3/glim_ros)).

- koide3/glim_ros:noetic
- koide3/glim_ros:noetic_cuda11.2
- koide3/glim_ros:noetic_cuda12.2
- koide3/glim_ros:humble
- koide3/glim_ros:humble_cuda11.2
- koide3/glim_ros:humble_cuda12.2
- koide3/glim_ros:jazzy

### Example use

Expand Down
12 changes: 9 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
- RGB-D camera (e.g., Microsoft Azure Kinect)
- ***Extensibility:*** GLIM provides the global callback slot mechanism that allows to access the internal states of the mapping process and insert additional constraints to the factor graph. We also release [glim_ext](https://github.com/koide3/glim_ext) that offers example implementations of several extension functions (e.g., explicit loop detection, LiDAR-Visual-Inertial odometry estimation).

Tested on Ubuntu 22.04 with CUDA 12.2 / NVIDIA Jetson Orin.
Tested on Ubuntu 22.04 / 24.04 with CUDA 12.2, and NVIDIA Jetson Orin.

[![Build test status](assets/build.svg)](https://github.com/koide3/glim/actions/workflows/build.yml)
[![ROS1](assets/ros1.svg)](https://github.com/koide3/glim_ros1/actions/workflows/docker_push.yml)
Expand All @@ -31,12 +31,18 @@ Tested on Ubuntu 22.04 with CUDA 12.2 / NVIDIA Jetson Orin.
### Mapping with various range sensors

<div class="youtube">
<iframe width="560" height="315" src="https://www.youtube.com/embed/rLqYo42eDTQ" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube.com/embed/_fwK4awbW18?si=R5m5502i7sKTbopg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
</div>

### Outdoor driving test with Livox MID360

<div class="youtube">
<iframe width="560" height="315" src="https://www.youtube.com/embed/CIfRqeV0irE?si=WT-knUxMuGWjYcxQ" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
</div>

See more in [Extension modules](extensions.md) and [Demo](demo.md) pages.

## Contact

Kenji Koide [:material-home:](https://staff.aist.go.jp/k.koide/) [:material-mail:](mailto:[email protected]) [:material-twitter:](https://twitter.com/k_koide3)
Kenji Koide [:material-home:](https://staff.aist.go.jp/k.koide/) [:material-mail:](mailto:[email protected]) [:material-twitter:](https://twitter.com/k_koide3) <br>
National Institute of Advanced Industrial Science and Technology (AIST), Japan
6 changes: 3 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

GLIM is tested on Ubuntu 22.04 with CUDA 12.2 / NVIDIA Jetson Orin (JetPack 6.0).
GLIM is tested on Ubuntu 22.04 / 24.04 with CUDA 12.2, and NVIDIA Jetson Orin (JetPack 6.0).

## Install from source

Expand All @@ -9,7 +9,7 @@ GLIM is tested on Ubuntu 22.04 with CUDA 12.2 / NVIDIA Jetson Orin (JetPack 6.0)
sudo apt install libomp-dev libboost-all-dev libmetis-dev \
libfmt-dev libspdlog-dev \
libglm-dev libglfw3-dev libpng-dev libjpeg-dev

# Install GTSAM
git clone https://github.com/borglab/gtsam
cd gtsam && git checkout 4.2a9
Expand Down Expand Up @@ -62,7 +62,7 @@ catkin_make
cd ~/ros2_ws/src
git clone https://github.com/koide3/glim
git clone https://github.com/koide3/glim_ros2

cd ~/ros2_ws
colcon build

Expand Down
7 changes: 3 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ repo_url: https://github.com/koide3/glim
site_url: https://glim.github.io/site
site_description: "GLIM: Versatile and Extensible Open-Source 3D Range-based Mapping Framework"

theme:
theme:
name: material
palette:
primary: indigo
Expand All @@ -25,9 +25,8 @@ markdown_extensions:
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- fontawesome_markdown
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg

copyright: Copyright &copy; 2021 - 2022 Kenji Koide
extra:
Expand Down

0 comments on commit 41f8aba

Please sign in to comment.