From 7dd8c168fd04b78c08a31a8e4a5e4773e8a9d135 Mon Sep 17 00:00:00 2001 From: "Takagi, Isamu" <43976882+isamu-takagi@users.noreply.github.com> Date: Thu, 30 May 2024 21:14:34 +0900 Subject: [PATCH] feat: update installation/workspace document (#10) Signed-off-by: Takagi, Isamu --- docs/development/images/docker/dev.drawio.svg | 312 +++++++++++++ .../development/images/docker/eval.drawio.svg | 437 ++++++++++++++++++ docs/development/installation.ja.md | 88 ++-- docs/development/workspace.ja.md | 95 ++-- 4 files changed, 825 insertions(+), 107 deletions(-) create mode 100644 docs/development/images/docker/dev.drawio.svg create mode 100644 docs/development/images/docker/eval.drawio.svg diff --git a/docs/development/images/docker/dev.drawio.svg b/docs/development/images/docker/dev.drawio.svg new file mode 100644 index 0000000..336b3f0 --- /dev/null +++ b/docs/development/images/docker/dev.drawio.svg @@ -0,0 +1,312 @@ + + + + + + + +
+
+
+ docker container (aichallege-dev) +
+
+
+ + + docker container (aichallege-dev) + + + + + + + +
+
+
+ host +
+
+
+ + + host + + + + + + + +
+
+
+ aichallenge +
+
+
+ + + aichallenge + + + + + + + +
+
+
+ aichallenge_submit +
+
+
+ + + aichallenge_submit + + + + + + + +
+
+
+ aichallenge_system +
+
+
+ + + aichallenge_system + + + + + + + +
+
+
+ main.bash +
+
+
+ + + main.bash + + + + + + + +
+
+
+ simulator +
+
+
+ + + simulator + + + + + + + + + + + +
+
+
+ /aichallenge +
+
+
+ + + /aichallenge + + + + + + + +
+
+
+ mount +
+
+
+ + + mount + + + + + + + +
+
+
+ clone +
+
+
+ + + clone + + + + + + + +
+
+
+ output +
+
+
+ + + output + + + + + + + + + +
+
+
+ /output +
+
+
+ + + /output + + + + + + + +
+
+
+ copy result +
+
+
+ + + copy result + + + + + + + +
+
+
+ /autoware +
+
+
+ + + /autoware + + + + + + + + + + + +
+
+
+ github / google drive +
+
+
+ + + github / google drive + + + + + + + +
+
+
+ download +
+
+
+ + + download + + + + + + + +
+
+
+ mount +
+
+
+ + + mount + + + + + + + + + Text is not SVG - cannot display + + + + diff --git a/docs/development/images/docker/eval.drawio.svg b/docs/development/images/docker/eval.drawio.svg new file mode 100644 index 0000000..930c1d3 --- /dev/null +++ b/docs/development/images/docker/eval.drawio.svg @@ -0,0 +1,437 @@ + + + + + + + +
+
+
+ host +
+
+
+ + + host + + + + + + + +
+
+
+ docker container (aichallege-eval) +
+
+
+ + + docker container (aichallege-eval) + + + + + + + + + +
+
+
+ /aichallenge +
+
+
+ + + /aichallenge + + + + + + + +
+
+
+ aichallenge_submit +
+
+
+ + + aichallenge_submit + + + + + + + +
+
+
+ aichallenge_system +
+
+
+ + + aichallenge_system + + + + + + + +
+
+
+ main.bash +
+
+
+ + + main.bash + + + + + + + +
+
+
+ simulator +
+
+
+ + + simulator + + + + + + + +
+
+
+ /autoware +
+
+
+ + + /autoware + + + + + + + +
+
+
+ aichallenge +
+
+
+ + + aichallenge + + + + + + + + + +
+
+
+ aichallenge_submit +
+
+
+ + + aichallenge_submit + + + + + + + +
+
+
+ aichallenge_system +
+
+
+ + + aichallenge_system + + + + + + + +
+
+
+ main.bash +
+
+
+ + + main.bash + + + + + + + + + +
+
+
+ simulator +
+
+
+ + + simulator + + + + + + + +
+
+
+ output +
+
+
+ + + output + + + + + + + + + +
+
+
+ /output +
+
+
+ + + /output + + + + + + + +
+
+
+ mount +
+
+
+ + + mount + + + + + + + +
+
+
+ copy +
+
+
+ + + copy + + + + + + + +
+
+
+ copy +
+
+
+ + + copy + + + + + + + +
+
+
+ copy result +
+
+
+ + + copy result + + + + + + + + + + + + + +
+
+
+ github / google drive +
+
+
+ + + github / google drive + + + + + + + +
+
+
+ clone +
+
+
+ + + clone + + + + + + + +
+
+
+ download +
+
+
+ + + download + + + + + + + +
+
+
+ clone +
+
+
+ + + clone + + + + + + + + + +
+
+
+ submit +
+
+
+ + + submit + + + + + + + + + Text is not SVG - cannot display + + + + \ No newline at end of file diff --git a/docs/development/installation.ja.md b/docs/development/installation.ja.md index cc64466..e261680 100644 --- a/docs/development/installation.ja.md +++ b/docs/development/installation.ja.md @@ -1,19 +1,29 @@ # 環境構築 -ここでは、AWSIMの環境構築から起動まで行います。 +## ワークスペースのダウンロード + +任意のディレクトリにて下記コマンドを実行し、ワークスペースをダウンロードします。 + +```bash +git clone https://github.com/AutomotiveAIChallenge/aichallenge-2024.git +``` ## NVIDIAドライバのインストール ```bash -#リポジトリの追加 +# リポジトリの追加 sudo add-apt-repository ppa:graphics-drivers/ppa -#パッケージリストの更新 + +# パッケージリストの更新 sudo apt update -#インストール + +# インストール sudo ubuntu-drivers autoinstall -#再起動 + +# 再起動 reboot -#再起動の後、インストールできていることを確認 + +# 再起動の後、インストールできていることを確認 nvidia-smi ``` @@ -22,39 +32,30 @@ nvidia-smi ## Vulkunのインストール ```bash -#パッケージリストの更新 +# パッケージリストの更新 sudo apt update -#libvulkan1をインストール + +# libvulkan1をインストール sudo apt install libvulkan1 ``` -## Git LFSのインストール +## AWSIMのダウンロード・起動確認 -```bash -curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | sudo bash -sudo apt-get install git-lfs -git lfs install -``` +!!! info -## 大会データのダウンロード + AWSIM は現在準備中です。 -```bash -cd -git lfs clone https://github.com/AutomotiveAIChallenge/aichallenge-2024.git -``` +1. [Google Drive](https://drive.google.com/drive/) から最新の `AWSIM_GPU.zip` をダウンロードし、`aichallenge-2024/aichallenge/simulator` に展開します。 -## AWSIMのダウンロード・起動確認 - - +2. パーミッションを図のように変更します。 -1. [GoogleDrive](https://drive.google.com/drive/folders/)から最新の`AWSIM_GPU.zip`をダウンロードし、`aichallenge-2024/aichallenge/simulator`に解凍してください。 -2. パーミッションを図のように変更してください。 ![パーミッション変更の様子](./images/installation/permmision.png) -3. ファイルをダブルクリックで起動 -4. 下記のような画面が表示されることを確認 - ![awsim](./images/installation/awsim.png) ---- +3. ファイルをダブルクリックで起動します。 + +4. 下記のような画面が表示されることを確認します。 + + ![awsim](./images/installation/awsim.png) ## Docker環境のインストール @@ -62,7 +63,6 @@ git lfs clone https://github.com/AutomotiveAIChallenge/aichallenge-2024.git - [Docker](https://docs.docker.com/engine/install/ubuntu/) - [rocker](https://github.com/osrf/rocker)(Dockerコンテナ内でRviz、rqtなどのGUIを使用するために用います。) -- [Git LFS](https://packagecloud.io/github/git-lfs/install) - [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html)(GPU非搭載の方はスキップ) ### Dockerのインストール @@ -86,8 +86,8 @@ sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin # インストールできているかをテスト sudo docker run hello-world -#以下の様なメッセージが出ればインストール完了です。 - +# 以下の様なメッセージが出ればインストール完了です。 +# # Hello from Docker! # This message shows that your installation appears to be working correctly. # @@ -109,14 +109,17 @@ sudo docker run hello-world # For more examples and ideas, visit: # https://docs.docker.com/get-started/ -#User Groupに自分のアカウントを追加し、sudo権限が無くてもDockerを利用可能にします。 +# User Groupに自分のアカウントを追加し、sudo権限が無くてもDockerを利用可能にします。 sudo usermod -aG docker $USER -#Groupsにdockerが追加されていることを確認 +# Groupsにdockerが追加されていることを確認 groups $USER -# $ USERNAME : USERNAME adm cdrom sudo ... docker + +# 以下の様なメッセージが出れば設定完了です。 +# USERNAME : USERNAME adm cdrom sudo ... docker # ここまで確認できたらLoginし直してください。 +reboot ``` ### rockerのインストール @@ -151,9 +154,9 @@ sudo systemctl restart docker #インストールできているかをテスト sudo docker run --rm --runtime=nvidia --gpus all nvidia/cuda:11.6.2-base-ubuntu20.04 nvidia-smi -#最後のコマンドで以下のような出力が出れば成功です。 -#（下記はNVIDIAウェブサイトからのコピペです） - +#最後のコマンドで以下のように出力されれば成功です。 +#（下記はNVIDIAウェブサイトからの引用です） +# # +-----------------------------------------------------------------------------+ # | NVIDIA-SMI 450.51.06 Driver Version: 450.51.06 CUDA Version: 11.0 | # |-------------------------------+----------------------+----------------------+ @@ -174,18 +177,19 @@ sudo docker run --rm --runtime=nvidia --gpus all nvidia/cuda:11.6.2-base-ubuntu2 # +-----------------------------------------------------------------------------+ ``` ---- - -## Dockerイメージの準備・起動 +## Dockerイメージの準備 -### Dockerイメージを入手 +Dockerイメージは10GB程度のサイズがあり、ダウンロードには時間が掛かります。 ```bash +# Dockerイメージのダウンロード docker pull ghcr.io/automotiveaichallenge/autoware-universe:humble-latest +# Dockerイメージの確認 docker images -##下記メッセージを確認し、Dockerイメージがダウンロードできていることを確認する。。 +# Dockerイメージがダウンロードできていれば以下のような出力が得られます。 +# # REPOSITORY TAG IMAGE ID CREATED SIZE # ghcr.io/automotiveaichallenge/autoware-universe humble-latest 30c59f3fb415 13 days ago 8.84GB ``` diff --git a/docs/development/workspace.ja.md b/docs/development/workspace.ja.md index 0196e34..192dffb 100644 --- a/docs/development/workspace.ja.md +++ b/docs/development/workspace.ja.md @@ -1,110 +1,76 @@ # ワークスペース -### 大会用Dockerイメージのビルド +## 大会用Dockerイメージの準備 + +### Dockerイメージのビルド + +以下のコマンドで大会用のDockerイメージをビルドします。 ```bash cd aichallenge2024 -bash docker_build.sh dev -``` +./docker_build.sh dev -### 大会用Dockerコンテナの起動 +# ビルドできたか確認 +docker images -ターミナルを2つ用意します。 +# 以下のような行が含まれていれば成功しています。 +# aichallenge-2024-dev latest df2e83a20349 33 minutes ago 8.9GB +``` -- コンテナを起動します。 +### Dockerコンテナの起動 ```bash # GPU搭載の方は以下 cd aichallenge-2024 -bash docker_run.sh dev gpu +./docker_run.sh dev gpu # GPU非搭載の方は以下 cd aichallenge-2024 -bash docker_run.sh dev cpu +./docker_run.sh dev cpu ``` -- コンテナが起動できているか、別ターミナルで確認します。 +### Dockerコンテナの停止 -```bash -docker images - -#以下が出ていれば作成ができています。 -#aichallenge-2024-dev latest df2e83a20349 33 minutes ago 8.9GB -``` - -### 大会Dockerコンテナを停止する - -コンテナが起動しているターミナルで下記コマンドを実行します。 +コンテナが起動しているターミナルで下記コマンドを実行します。以上でセットアップは終了となります。 ```bash exit ``` -以上でセットアップは終了となります。 - ## 大会環境の起動 -本節では大会環境を起動します。 +本節では大会環境を実行方法を解説します。以下のコマンドはすべてコンテナ内から実行するため、まずは「Dockerコンテナの起動」に従い大会用のコンテナを起動してください。 ### Autoware -コンテナを起動します。 - -```bash -# GPU搭載の方は以下 -cd aichallenge-2024 -bash docker_run.sh dev gpu - -# GPU非搭載の方は以下 -cd aichallenge-2024 -bash docker_run.sh dev cpu -``` - -- Autowareのビルド - -コンテナを開いたターミナル(コンテナ内)で以下を実行します。 +コンテナを起動したターミナル(コンテナ内)で以下を実行します。 ```bash cd /aichallenge -bash build_autoware.bash +./build_autoware.bash ``` -- Autowareの起動 +Autowareのビルド後、以下のコマンドを実行します。 ```bash -bash run_autoware.sh +./run_autoware.sh ``` -下記の様な画面が表示されたら起動完了です。 +下記の様な画面が表示されたら起動完了です。終了するにはターミナル上でCTRL + Cを入力します。 ![autoware](./images/installation/autoware.png) -終了するにはターミナル上でCTRL + Cを入力します。 - ### AWSIM in Docker -コンテナを起動します。 - -```bash -# GPU搭載の方は以下 -cd aichallenge-2024 -bash docker_run.sh dev gpu - -# GPU非搭載の方は以下 -cd aichallenge-2024 -bash docker_run.sh dev cpu -``` - -コンテナを開いたターミナル(コンテナ内)で以下を実行します。 +コンテナを起動したターミナル(コンテナ内)で以下を実行します。 ```bash cd /aichallenge -bash run_simulator.bash +./run_simulator.bash ``` -下記の様な画面が表示されたら起動完了です。 +下記の様な画面が表示されたら起動完了です。終了するにはターミナル上でCTRL + Cを入力します。 ![awsim](./images/installation/awsim.png) -終了するにはターミナル上でCTRL + Cを入力します。 ## 変更点の取り込み @@ -124,8 +90,6 @@ cd aichallenge2024 # path to aichallenge2024 git pull origin/main ``` -
- ## TroubleShooting Q. `docker_run.sh: 行 35: rocker: コマンドが見つかりません` @@ -136,11 +100,12 @@ Q. `WARNING unable to detect os for base image 'aichallenge-2024-dev', maybe the A. Dockerイメージのビルドをお願いします。 +## ワークスペースの構成 -## docker-dev +### docker-dev -![dev](./docker/dev.drawio.svg) +![dev](./images/docker/dev.drawio.svg) -## docker-eval +### docker-eval -![eval](./docker/eval.drawio.svg) +![eval](./images/docker/eval.drawio.svg)