Skip to content

Commit

Permalink
doc: add sim-msgs and updat doc (#3)
Browse files Browse the repository at this point in the history
* doc: add sim-msgs and updat doc

* fix en document
  • Loading branch information
yhisaki authored Oct 20, 2023
1 parent a21d724 commit 4917290
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 6 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "docker/aichallenge/aichallenge_ws/src/sim-msgs"]
path = docker/aichallenge/aichallenge_ws/src/sim-msgs
url = https://github.com/autonomalabs/sim-msgs.git
1 change: 1 addition & 0 deletions docker/aichallenge/aichallenge_ws/src/sim-msgs
Submodule sim-msgs added at 47f4f5
15 changes: 12 additions & 3 deletions documentation/docfx_project/setup/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@
```
sudo apt install -y git-lfs
git lfs clone https://github.com/AutomotiveAIChallenge/aichallenge2023-racing
cd aichallenge2023-racing
git submodule update --init --recursive
```
3. 大会用dockerイメージのビルド
```
Expand Down Expand Up @@ -130,11 +132,18 @@ DockerコンテナからAWSIMを起動したい場合は、Dockerイメージの
```
3. コンテナ内で以下を実行
```
sudo ip link set multicast on lo
source /autoware/install/setup.bash
/aichallenge/AWSIM/AWSIM.x86_64
cd /aichallenge
bash run_awsim.sh
```

> [!NOTE]
> AWSIMからpublish・subscribeされているトピックのメッセージは,一部`/aichallenge/aichallenge_ws/src/sim-msgs`で定義されています.これらのメッセージを扱うには,以下のコマンドを実行してください.
> ```
> cd /aichallenge
> bash build_autoware.sh
> source /aichallenge/aichallenge_ws/install/setup.bash
> ```
### AWSIM(Windows)
1. [GoogleDrive](https://drive.google.com/drive/folders/1p-_rZLDVncssgYTwjBmLKMyGQxOKHV5Q?usp=sharing)から最新の`AWSIM_AIChallenge_Windows_v*.*.zip`をダウンロードし解凍
2. ファイルをダブルクリックで起動
Expand Down
15 changes: 12 additions & 3 deletions documentation/docfx_project_en/setup/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ Please install the following.
```
sudo apt install -y git-lfs
git lfs clone https://github.com/AutomotiveAIChallenge/aichallenge2023-racing
cd aichallenge2023-racing
git submodule update --init --recursive
```
3. build docker image for competition
```
Expand Down Expand Up @@ -130,11 +132,18 @@ If you want to start AWSIM from a Docker container, please follow the steps belo
```
3. execute the following in the container
```
sudo ip link set multicast on lo
source /autoware/install/setup.bash
/aichallenge/AWSIM/AWSIM.x86_64
cd /aichallenge
bash run_awsim.sh
```

> [!NOTE]
> The messages for the topics that are being published and subscribed to from AWSIM are partially defined in `/aichallenge/aichallenge_ws/src/sim-msgs`. To handle these messages, please execute the following commands:
> ```
> cd /aichallenge
> bash build_autoware.sh
> source /aichallenge/aichallenge_ws/install/setup.bash
> ```
### AWSIM(Windows)
1. Download latest `AWSIM_AIChallenge_Windows_v*.*.zip` from [GoogleDrive](https://drive.google.com/drive/folders/1p-_rZLDVncssgYTwjBmLKMyGQxOKHV5Q?usp=sharing) and unzip it.
2. double-click the file to start it
Expand Down

0 comments on commit 4917290

Please sign in to comment.