Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(tutorial): ss2 instructions #118

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
c526537
Update and rename rosbag-replay-simulation.md to Installation.md
WJaworskiRobotec May 19, 2022
53fd677
Rename Installation.md to installation.md
WJaworskiRobotec May 19, 2022
8491ee6
Update and rename digital-twin-simulation.md to scenario-simulation.md
WJaworskiRobotec May 19, 2022
56812de
Update and rename planning-simulation.md to random-test-simulation.md
WJaworskiRobotec May 19, 2022
a6c98d0
Update and rename scenario-simulation.md to scenario-test-simulation.md
WJaworskiRobotec May 19, 2022
f3cf300
Update .pages
WJaworskiRobotec May 19, 2022
5954359
Update random-test-simulation.md
WJaworskiRobotec May 19, 2022
6a15401
Update scenario-test-simulation.md
WJaworskiRobotec May 19, 2022
8bd58af
ci(pre-commit): autofix
pre-commit-ci[bot] May 19, 2022
ca765b6
Update random-test-simulation.md
WJaworskiRobotec May 19, 2022
109598b
ci(pre-commit): autofix
pre-commit-ci[bot] May 19, 2022
ceb2f4a
Update scenario-test-simulation.md
WJaworskiRobotec May 19, 2022
047e007
Update random-test-simulation.md
WJaworskiRobotec May 19, 2022
361e9bf
Add files via upload
WJaworskiRobotec May 19, 2022
053e02f
Update random-test-simulation.md
WJaworskiRobotec May 19, 2022
fc28a7b
Update scenario-test-simulation.md
WJaworskiRobotec May 19, 2022
a3344f4
Update docs/tutorials/scenario-simulation/random-test-simulation.md
WJaworskiRobotec May 20, 2022
464e186
Update docs/tutorials/scenario-simulation/scenario-test-simulation.md
WJaworskiRobotec May 20, 2022
57dcb2a
ci(pre-commit): autofix
pre-commit-ci[bot] May 20, 2022
d57e316
Update docs/tutorials/scenario-simulation/random-test-simulation.md
WJaworskiRobotec May 20, 2022
a76188f
Update docs/tutorials/scenario-simulation/scenario-test-simulation.md
WJaworskiRobotec May 20, 2022
a237fd7
Update docs/tutorials/scenario-simulation/random-test-simulation.md
WJaworskiRobotec May 20, 2022
48ba1a9
Create rosbag-replay-simulation.md
WJaworskiRobotec May 20, 2022
ba65176
Create digital-twin-simulation.md
WJaworskiRobotec May 20, 2022
5670b4d
Update .pages
WJaworskiRobotec May 20, 2022
5392622
changed structure of files
WJaworskiRobotec May 20, 2022
45377bf
Update installation.md
WJaworskiRobotec May 23, 2022
2059ea1
Update installation.md
WJaworskiRobotec May 23, 2022
fe6d364
ci(pre-commit): autofix
pre-commit-ci[bot] May 23, 2022
c52f231
fix .pages
May 23, 2022
a848f99
move images
May 23, 2022
39fea72
Update installation.md
WJaworskiRobotec May 23, 2022
75378d9
Update scenario-test-simulation.md
WJaworskiRobotec May 23, 2022
fd94f9d
Update random-test-simulation.md
WJaworskiRobotec May 23, 2022
29581eb
Update docs/tutorials/scenario-simulation/planning-simulation/random-…
WJaworskiRobotec May 23, 2022
c1065e9
Update docs/tutorials/scenario-simulation/planning-simulation/scenari…
WJaworskiRobotec May 23, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/tutorials/scenario-simulation/.pages
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
nav:
- index.md
- planning-simulation.md
- planning-simulation
- rosbag-replay-simulation.md
- digital-twin-simulation.md
5 changes: 0 additions & 5 deletions docs/tutorials/scenario-simulation/index.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/tutorials/scenario-simulation/planning-simulation.md

This file was deleted.

4 changes: 4 additions & 0 deletions docs/tutorials/scenario-simulation/planning-simulation/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
nav:
- installation.md
- scenario-test-simulation.md
- random-test-simulation.md
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Installation

This document contains step-by-step instruction on how to build [AWF Autoware Core/Universe](https://github.com/autowarefoundation/autoware) with `scenario_simulator_v2`.

## Prerequisites

1. [Autoware has been built and installed](https://autowarefoundation.github.io/autoware-documentation/main/installation/)

## How to build

1. Navigate to the Autoware workspace:

```bash
cd autoware
```

2. Import Simulator dependencies:

```bash
vcs import src < simulator.repos
```

3. Install dependent ROS packages:

```bash
source /opt/ros/galactic/setup.bash
rosdep install --from-paths src --ignore-src --rosdistro $ROS_DISTRO
```

4. Build the workspace:

```bash
colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release
```
kenji-miyake marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Random test simulation

!!! note

Running the Scenario Simulator requires some additional steps on top of building and installing Autoware, so make sure that [Scenario Simulator installation](installation.md) has been completed first before proceeding.

## Running steps

1. Move to the workspace directory where Autoware and the Scenario Simulator have been built.

2. Source the workspace setup script:

```bash
source install/setup.bash
```

3. Run the simulation:

```bash
ros2 launch random_test_runner random_test.launch.py \
architecture_type:=awf/universe \
sensor_model:=sample_sensor_kit \
vehicle_model:=sample_vehicle
```

![random_test_runner](images/random_test_runner.png)
Copy link
Contributor

@kenji-miyake kenji-miyake May 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've moved the directory. 6a37550


For more information about supported parameters, refer to the ![random_test_runner documentation].(<https://github.com/tier4/scenario_simulator_v2/blob/master/test_runner/random_test_runner/Readme.md#node-parameters>)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your kind notification!
I updated the link.

Suggested change
For more information about supported parameters, refer to the ![random_test_runner documentation].(<https://github.com/tier4/scenario_simulator_v2/blob/master/test_runner/random_test_runner/Readme.md#node-parameters>)
For more information about supported parameters, refer to the ![random_test_runner documentation].(<https://github.com/tier4/scenario_simulator_v2/blob/master/docs/user_guide/random_test_runner/README.md#node-parameters>)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@HansRobo Could you open a PR for that? 🙏

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or should I do it?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, This PR has already merged!
I will create PR for this change now...

Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Scenario test simulation

!!! note

Running the Scenario Simulator requires some additional steps on top of building and installing Autoware, so make sure that [Scenario Simulator installation](installation.md) has been completed first before proceeding.

## Running steps

1. Move to the workspace directory where Autoware and the Scenario Simulator have been built.

2. Source the workspace setup script:

```bash
source install/setup.bash
```

3. Run the simulation:

```bash
ros2 launch scenario_test_runner scenario_test_runner.launch.py \
architecture_type:=awf/universe \
record:=false \
scenario:='$(find-pkg-share scenario_test_runner)/scenario/sample.yaml' \
sensor_model:=sample_sensor_kit \
vehicle_model:=sample_vehicle
```

![scenario_test_runner](images/scenario_test_runner.png)