From 4bfbb00b897b57fb5ab69ba6fd2a1a6f7a760d7c Mon Sep 17 00:00:00 2001 From: knorrrr Date: Wed, 3 Jul 2024 16:16:38 +0900 Subject: [PATCH 1/2] style(setup): Add a next step and Delete AWSIM permission setting. --- docs/setup/docker.ja.md | 8 ++++++++ docs/setup/headless-simulation.ja.md | 8 +++++--- docs/setup/requirements.ja.md | 2 ++ docs/setup/visible-simulation.ja.md | 12 ++++++++---- docs/setup/workspace-setup.ja.md | 2 ++ 5 files changed, 25 insertions(+), 7 deletions(-) diff --git a/docs/setup/docker.ja.md b/docs/setup/docker.ja.md index e96168b..0d37eed 100644 --- a/docs/setup/docker.ja.md +++ b/docs/setup/docker.ja.md @@ -75,3 +75,11 @@ Dockerイメージがダウンロードできていれば以下のような出 REPOSITORY TAG IMAGE ID CREATED SIZE ghcr.io/automotiveaichallenge/autoware-universe humble-latest 30c59f3fb415 13 days ago 8.84GB ``` +## Next Step +2種類のAWSIMを提供しています。 + +初めての方は描画なしAWSIMへ、GPU搭載のPCをお持ちの方でよりリッチな開発環境をご用意されたい方は描画ありAWSIMのドキュメントにお進み下さい。 + +[描画なしAWSIMのダウンロード](./headless-simulation.ja.md) + +[描画ありAWSIMのダウンロード](./visible-simulation.ja.md) diff --git a/docs/setup/headless-simulation.ja.md b/docs/setup/headless-simulation.ja.md index ac0be4e..e093507 100644 --- a/docs/setup/headless-simulation.ja.md +++ b/docs/setup/headless-simulation.ja.md @@ -4,8 +4,10 @@ 1. [Google Drive](https://drive.google.com/drive/folders/1ftIoamNGAet90sXeG48lKa89dkpVy45y) から最新の `AWSIM.zip` をダウンロードし、`aichallenge-2024/aichallenge/simulator` に展開します。 - 実行ファイルが`aichallenge-2024/aichallenge/simulator/AWSIM/AWSIM.x86_64`に存在していることを確認してください。 +2. 実行ファイルが`aichallenge-2024/aichallenge/simulator/AWSIM/AWSIM.x86_64`に存在していることを確認してください。 -2. パーミッションを図のように変更します。 +以上で環境構築は終了となります！ - ![パーミッション変更の様子](./images/awsim-permmision.png) +## Next Step: 動かし、開発をしてみる + +[はじめ方](../getting-started.ja.md)から大会用のリポジトリをビルド・実行し、開発をしてみましょう！ \ No newline at end of file diff --git a/docs/setup/requirements.ja.md b/docs/setup/requirements.ja.md index 347e3d9..7f6c7da 100644 --- a/docs/setup/requirements.ja.md +++ b/docs/setup/requirements.ja.md @@ -26,3 +26,5 @@ - GPU: NVIDIA Geforce VRAM 8 GB - Memory: 16 GB or more - Storage: SSD 60 GB or higher + +## [Next Step: ワークスペースのクローン](./workspace-setup.ja.md) \ No newline at end of file diff --git a/docs/setup/visible-simulation.ja.md b/docs/setup/visible-simulation.ja.md index b819c68..0274bd4 100644 --- a/docs/setup/visible-simulation.ja.md +++ b/docs/setup/visible-simulation.ja.md @@ -76,13 +76,10 @@ sudo apt install -y libvulkan1 ## AWSIMのダウンロード -1. [Google Drive](https://drive.google.com/drive/folders/1ftIoamNGAet90sXeG48lKa89dkpVy45y) から最新の `AWSIM_GPU_**.zip` をダウンロードし、`aichallenge-2024/aichallenge/simulator` に展開します。 +[Google Drive](https://drive.google.com/drive/folders/1ftIoamNGAet90sXeG48lKa89dkpVy45y) から最新の `AWSIM_GPU_**.zip` をダウンロードし、`aichallenge-2024/aichallenge/simulator` に展開します。 実行ファイルが`aichallenge-2024/aichallenge/simulator/AWSIM_GPU_**/AWSIM.x86_64`に存在していることを確認してください。 -2. パーミッションを図のように変更します。 - - ![パーミッション変更の様子](./images/awsim-permmision.png) ## AWSIMの起動確認 @@ -90,6 +87,7 @@ sudo apt install -y libvulkan1 ```bash cd aichallenge-2024 +./docker_build.sh dev ./docker_run.sh dev gpu ``` @@ -127,3 +125,9 @@ AWSIM_DIRECTORY=/aichallenge/simulator/AWSIM_GPU_** 以下のような画面が現れたら成功です。 ![AWSIM-Autoware](./images/awsim-and-autoware.png) + +以上で環境構築は終了となります！ + +## Next Step: 開発をしてみる + +[はじめ方](../getting-started.ja.md)から開発をしてみましょう！ \ No newline at end of file diff --git a/docs/setup/workspace-setup.ja.md b/docs/setup/workspace-setup.ja.md index f936e54..216b2dd 100644 --- a/docs/setup/workspace-setup.ja.md +++ b/docs/setup/workspace-setup.ja.md @@ -17,3 +17,5 @@ sudo apt install -y git cd ~ git clone https://github.com/AutomotiveAIChallenge/aichallenge-2024.git ``` + +## [Next Step: 仮想環境のインストール](./docker.ja.md) \ No newline at end of file From 364898cef0fd6cf2488d95e5c2798979f21e4c55 Mon Sep 17 00:00:00 2001 From: knorrrr Date: Wed, 3 Jul 2024 16:25:17 +0900 Subject: [PATCH 2/2] chore: add pre-commit --- docs/setup/docker.ja.md | 2 ++ docs/setup/headless-simulation.ja.md | 2 +- docs/setup/requirements.ja.md | 2 +- docs/setup/visible-simulation.ja.md | 3 +-- docs/setup/workspace-setup.ja.md | 2 +- 5 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/setup/docker.ja.md b/docs/setup/docker.ja.md index 0d37eed..e815870 100644 --- a/docs/setup/docker.ja.md +++ b/docs/setup/docker.ja.md @@ -75,7 +75,9 @@ Dockerイメージがダウンロードできていれば以下のような出 REPOSITORY TAG IMAGE ID CREATED SIZE ghcr.io/automotiveaichallenge/autoware-universe humble-latest 30c59f3fb415 13 days ago 8.84GB ``` + ## Next Step + 2種類のAWSIMを提供しています。 初めての方は描画なしAWSIMへ、GPU搭載のPCをお持ちの方でよりリッチな開発環境をご用意されたい方は描画ありAWSIMのドキュメントにお進み下さい。 diff --git a/docs/setup/headless-simulation.ja.md b/docs/setup/headless-simulation.ja.md index e093507..35fecd7 100644 --- a/docs/setup/headless-simulation.ja.md +++ b/docs/setup/headless-simulation.ja.md @@ -10,4 +10,4 @@ ## Next Step: 動かし、開発をしてみる -[はじめ方](../getting-started.ja.md)から大会用のリポジトリをビルド・実行し、開発をしてみましょう！ \ No newline at end of file +[はじめ方](../getting-started.ja.md)から大会用のリポジトリをビルド・実行し、開発をしてみましょう！ diff --git a/docs/setup/requirements.ja.md b/docs/setup/requirements.ja.md index 7f6c7da..9644081 100644 --- a/docs/setup/requirements.ja.md +++ b/docs/setup/requirements.ja.md @@ -27,4 +27,4 @@ - Memory: 16 GB or more - Storage: SSD 60 GB or higher -## [Next Step: ワークスペースのクローン](./workspace-setup.ja.md) \ No newline at end of file +## [Next Step: ワークスペースのクローン](./workspace-setup.ja.md) diff --git a/docs/setup/visible-simulation.ja.md b/docs/setup/visible-simulation.ja.md index 0274bd4..90925a3 100644 --- a/docs/setup/visible-simulation.ja.md +++ b/docs/setup/visible-simulation.ja.md @@ -80,7 +80,6 @@ sudo apt install -y libvulkan1 実行ファイルが`aichallenge-2024/aichallenge/simulator/AWSIM_GPU_**/AWSIM.x86_64`に存在していることを確認してください。 - ## AWSIMの起動確認 描画ありのAWSIMを使用する場合は、以下のコマンドでコンテナを起動してください。 @@ -130,4 +129,4 @@ AWSIM_DIRECTORY=/aichallenge/simulator/AWSIM_GPU_** ## Next Step: 開発をしてみる -[はじめ方](../getting-started.ja.md)から開発をしてみましょう！ \ No newline at end of file +[はじめ方](../getting-started.ja.md)から開発をしてみましょう！ diff --git a/docs/setup/workspace-setup.ja.md b/docs/setup/workspace-setup.ja.md index 216b2dd..9f07d8c 100644 --- a/docs/setup/workspace-setup.ja.md +++ b/docs/setup/workspace-setup.ja.md @@ -18,4 +18,4 @@ cd ~ git clone https://github.com/AutomotiveAIChallenge/aichallenge-2024.git ``` -## [Next Step: 仮想環境のインストール](./docker.ja.md) \ No newline at end of file +## [Next Step: 仮想環境のインストール](./docker.ja.md)