Skip to content

Commit

Permalink
docs(tutorial,installation,workspace): update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
taikitanaka3 committed Jun 11, 2024
1 parent 4517299 commit 2bc328d
Show file tree
Hide file tree
Showing 8 changed files with 170 additions and 135 deletions.
Binary file added docs/development/images/AWSIM&Autoware.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
92 changes: 12 additions & 80 deletions docs/development/installation.ja.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# 環境構築

こちらのページはチュートリアルの項目を簡素にしたものになります。
初参加の方は[チュートリアル](../tutorial.ja.md)のページをご参照ください。

## ワークスペースのダウンロード

任意のディレクトリにて下記コマンドを実行し、ワークスペースをダウンロードします。
Expand All @@ -8,35 +11,13 @@
git clone https://github.com/AutomotiveAIChallenge/aichallenge-2024.git
```

## NVIDIAドライバのインストール
## 必要なパッケージのインストール

```bash
# リポジトリの追加
sudo add-apt-repository ppa:graphics-drivers/ppa

# パッケージリストの更新
sudo apt update

# インストール
sudo apt -y upgrade
sudo apt install -y git python3-pip ca-certificates curl gnupg libvulkan1
sudo ubuntu-drivers autoinstall

# 再起動
reboot

# 再起動の後、インストールできていることを確認
nvidia-smi
```

![nvidia-smi](./images/installation/nvidia-smi.png)

## Vulkunのインストール

```bash
# パッケージリストの更新
sudo apt update

# libvulkan1をインストール
sudo apt install libvulkan1
```

## AWSIMのダウンロード・起動確認
Expand All @@ -45,25 +26,20 @@ sudo apt install libvulkan1

AWSIM は現在準備中です。

1. [Google Drive](https://drive.google.com/drive/) から最新の `AWSIM_GPU.zip` をダウンロードし、`aichallenge-2024/aichallenge/simulator` に展開します。
1. [Google Drive](https://drive.google.com/drive/) から最新の `AWSIM.zip` をダウンロードし、`aichallenge-2024/aichallenge/simulator` に展開します。

2. パーミッションを図のように変更します。

![パーミッション変更の様子](./images/installation/permmision.png)

3. ファイルをダブルクリックで起動します。

4. 下記のような画面が表示されることを確認します。

![awsim](./images/installation/awsim.png)

## Docker環境のインストール

下記のインストールを行います。

- [Docker](https://docs.docker.com/engine/install/ubuntu/)
- [rocker](https://github.com/osrf/rocker)(Dockerコンテナ内でRviz、rqtなどのGUIを使用するために用います。)
- [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html)(GPU非搭載の方はスキップ)


### Dockerのインストール

Expand Down Expand Up @@ -130,54 +106,6 @@ pip install rocker
# rocker実行ファイルへのPATHを通します。
echo export PATH='$HOME/.local/bin:$PATH' >> ~/.bashrc
source ~/.bashrc

# 以下コマンドはROS依存があるため非推奨としています。
# sudo sh -c 'echo "deb http://packages.ros.org/ros2/ubuntu $(lsb_release -sc) main" > /etc/apt/sources.list.d/ros2.list'
# curl -s https://raw.githubusercontent.com/ros/rosdistro/master/ros.asc | sudo apt-key add -
# sudo apt update
# sudo apt-get install python3-rocker
```

### (GPU非搭載の方はスキップ) NVIDIA Container Toolkit

```bash
# インストールの下準備
distribution=$(. /etc/os-release;echo $ID$VERSION_ID) \
&& curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | sudo gpg --dearmor -o /usr/share/keyrings/nvidia-container-toolkit-keyring.gpg \
&& curl -s -L https://nvidia.github.io/libnvidia-container/$distribution/libnvidia-container.list | \
sed 's#deb https://#deb [signed-by=/usr/share/keyrings/nvidia-container-toolkit-keyring.gpg] https://#g' | \
sudo tee /etc/apt/sources.list.d/nvidia-container-toolkit.list

# インストール
sudo apt-get update
sudo apt-get install -y nvidia-container-toolkit
sudo nvidia-ctk runtime configure --runtime=docker
sudo systemctl restart docker

#インストールできているかをテスト
sudo docker run --rm --runtime=nvidia --gpus all nvidia/cuda:11.6.2-base-ubuntu20.04 nvidia-smi

#最後のコマンドで以下のように出力されれば成功です。
#(下記はNVIDIAウェブサイトからの引用です)
#
# +-----------------------------------------------------------------------------+
# | NVIDIA-SMI 450.51.06 Driver Version: 450.51.06 CUDA Version: 11.0 |
# |-------------------------------+----------------------+----------------------+
# | GPU Name Persistence-M| Bus-Id Disp.A | Volatile Uncorr. ECC |
# | Fan Temp Perf Pwr:Usage/Cap| Memory-Usage | GPU-Util Compute M. |
# | | | MIG M. |
# |===============================+======================+======================|
# | 0 Tesla T4 On | 00000000:00:1E.0 Off | 0 |
# | N/A 34C P8 9W / 70W | 0MiB / 15109MiB | 0% Default |
# | | | N/A |
# +-------------------------------+----------------------+----------------------+
# +-----------------------------------------------------------------------------+
# | Processes: |
# | GPU GI CI PID Type Process name GPU Memory |
# | ID ID Usage |
# |=============================================================================|
# | No running processes found |
# +-----------------------------------------------------------------------------+
```

## Dockerイメージの準備
Expand All @@ -196,3 +124,7 @@ docker images
# REPOSITORY TAG IMAGE ID CREATED SIZE
# ghcr.io/automotiveaichallenge/autoware-universe humble-latest 30c59f3fb415 13 days ago 8.84GB
```

ここまでできたら最低限必要な環境構築は**完了**です。
次のページにいきましょう。

31 changes: 5 additions & 26 deletions docs/development/requirements.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,8 @@
本大会で使用していただくPCの動作環境として以下を推奨しております。

- OS: Ubuntu 22.04
- CPU: Intel Corei7 (8 cores) or higher
- GPU: NVIDIA Geforce RTX 3080 (VRAM 12 GB) or higher
- Memory: 32 GB or more
- Storage: SSD 30 GB or higher

上記のスペックを満たすPCをご用意できない方は、AutowareとAWSIMを別のPCで動かすことも可能です。下記の「PC2台で参加する方向け」のスペックをご参照ください。

## 2台のPCを使用する方向け

### Autoware PC

- OS: Ubuntu 22.04
- CPU: Intel Corei7 (8 cores) or higher
- GPU: NVIDIA Geforce GTX 1080 or higher
- Memory: 16 GB or higher
- Storage: SSD 10 GB or higher
- 詳細は [Autoware Documentation](https://autowarefoundation.github.io/autoware-documentation/main/installation/) を参照してください

### AWSIM PC

- OS: Ubuntu 22.04 or Windows 10/11
- CPU: Intel Corei7 (6 cores and 12 threads) or higher
- GPU: NVIDIA Geforce RTX 2080 Ti or higher
- 詳細は [AWSIM document](https://tier4.github.io/AWSIM/) を参照してください

Autoware動作PCとAWSIM動作PCは、同じネットワーク内に配置してください。配置できていれば、基本的には追加設定をすることなく、PC間のトピック通信は可能です。万が一、トピック通信ができなかった場合はファイアーウォールの解除、もしくはルールの見直しをお願いします。また、Autoware Documentation の [Troubleshooting](https://autowarefoundation.github.io/autoware-documentation/main/support/troubleshooting/performance-troubleshooting/)も参考になるかもしれません。
- CPU: Intel Core i5(4コア)以上(推奨)
- メモリ:
- 8GB以上(最低)
- 16GB以上(推奨)
- SSD: 60GB以上
Empty file.
135 changes: 135 additions & 0 deletions docs/development/visible-simulation.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
# 描画有りのシミュレーション(非推奨)

## 描画有りのシミュレーション環境(環境構築上級者向け)

デフォルトで描画無しのAWSIMを配布しておりますが、描画有りを希望される方の環境構築方法も記載しております。GPUを使用する環境構築では詰まって進まなくなる事例が多々ありましたので、初めてのご参加の方はあくまでも参考程度でとしてください。

- OS: Ubuntu 22.04
- CPU: Intel Corei7 (8 cores) or higher
- GPU: NVIDIA Geforce VRAM 8 GB
- Memory: 16 GB or more
- Storage: SSD 60 GB or higher

## 描画有りのシミュレーション環構築手順(WIP)

基本的に描画無しのAWSIMを配布しておりますが、描画有りを希望される方の環境構築方法も記載しております。GPUを使用する環境構築では詰まって進まなくなる事例が多々ありましたので、おすすめはいたしません。要求性能のページのスペックのPCが用意できない方や初めてのご参加の方はあくまでも参考程度としてください。

- [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html)(GPU非搭載の方はスキップ)

### NVIDIAドライバのインストール

```bash
# リポジトリの追加
sudo add-apt-repository ppa:graphics-drivers/ppa

# パッケージリストの更新
sudo apt update

# インストール
sudo ubuntu-drivers autoinstall

# 再起動
reboot

# 再起動の後、インストールできていることを確認
nvidia-smi
```

![nvidia-smi](./images/installation/nvidia-smi.png)

#### NVIDIA Container Toolkit

```bash
# インストールの下準備
distribution=$(. /etc/os-release;echo $ID$VERSION_ID) \
&& curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | sudo gpg --dearmor -o /usr/share/keyrings/nvidia-container-toolkit-keyring.gpg \
&& curl -s -L https://nvidia.github.io/libnvidia-container/$distribution/libnvidia-container.list | \
sed 's#deb https://#deb [signed-by=/usr/share/keyrings/nvidia-container-toolkit-keyring.gpg] https://#g' | \
sudo tee /etc/apt/sources.list.d/nvidia-container-toolkit.list

# インストール
sudo apt-get update
sudo apt-get install -y nvidia-container-toolkit
sudo nvidia-ctk runtime configure --runtime=docker
sudo systemctl restart docker

#インストールできているかをテスト
sudo docker run --rm --runtime=nvidia --gpus all nvidia/cuda:11.6.2-base-ubuntu20.04 nvidia-smi

#最後のコマンドで以下のように出力されれば成功です。
#(下記はNVIDIAウェブサイトからの引用です)
#
# +-----------------------------------------------------------------------------+
# | NVIDIA-SMI 450.51.06 Driver Version: 450.51.06 CUDA Version: 11.0 |
# |-------------------------------+----------------------+----------------------+
# | GPU Name Persistence-M| Bus-Id Disp.A | Volatile Uncorr. ECC |
# | Fan Temp Perf Pwr:Usage/Cap| Memory-Usage | GPU-Util Compute M. |
# | | | MIG M. |
# |===============================+======================+======================|
# | 0 Tesla T4 On | 00000000:00:1E.0 Off | 0 |
# | N/A 34C P8 9W / 70W | 0MiB / 15109MiB | 0% Default |
# | | | N/A |
# +-------------------------------+----------------------+----------------------+
# +-----------------------------------------------------------------------------+
# | Processes: |
# | GPU GI CI PID Type Process name GPU Memory |
# | ID ID Usage |
# |=============================================================================|
# | No running processes found |
# +-----------------------------------------------------------------------------+
```

## AWSIMのダウンロード・起動確認

!!! info

AWSIM は現在準備中です。

1. [Google Drive](https://drive.google.com/drive/) から最新の `AWSIM_GPU.zip` をダウンロードし、`aichallenge-2024/aichallenge/simulator` に展開します。

2. パーミッションを図のように変更します。

![パーミッション変更の様子](./images/installation/permmision.png)


実行ファイルが`aichallenge-2024/aichallenge/simulator/AWSIM_GPU/AWSIM.x86_64`に存在していることを確認してください。

# Dockerコンテナの起動

描画有りのシミュレーション推奨環境を満たしており、
NVIDIA関連のinstallが済んでいる方は上記のコマンドではなく、以下のコマンドでコンテナを起動してください。
```bash
cd aichallenge-2024
./docker_run.sh dev gpu
```

### AutowareのビルドとSimulatorの起動

コンテナを起動したターミナル(コンテナ内)で以下を実行します。

```bash
cd /aichallenge
./build_autoware.bash
```

Autowareのビルド後、run_simulator.bashを変更します
```bash
#!/bin/bash

# shellcheck disable=SC1091
source /aichallenge/workspace/install/setup.bash
sudo ip link set multicast on lo
/aichallenge/simulator/AWSIM_GPU/AWSIM.x86_64
```

※実行ファイルが`aichallenge-2024/aichallenge/simulator/AWSIM_GPU/AWSIM.x86_64`に存在していることを確認してください。

以下のコマンドを実行します。

```bash
./run_evaluation.bash
```

以下のような画面が現れたら成功です。

![](./images/AWSIM%26Autoware.png)
Loading

0 comments on commit 2bc328d

Please sign in to comment.