From 3cd18716c6a3ba139349c75179641fea0019d1e9 Mon Sep 17 00:00:00 2001 From: Oguz Ozturk Date: Thu, 16 May 2024 16:40:23 +0300 Subject: [PATCH 1/3] simplify run.sh commands Signed-off-by: Oguz Ozturk --- docs/installation/autoware/docker-installation.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/installation/autoware/docker-installation.md b/docs/installation/autoware/docker-installation.md index 74d3fef3c5a..4e9860b6ee2 100644 --- a/docs/installation/autoware/docker-installation.md +++ b/docs/installation/autoware/docker-installation.md @@ -33,7 +33,7 @@ To install without **NVIDIA GPU** support: ## Usage -### Runtime setup +### Runtime You can use `run.sh` to run the Autoware runtime container with the map data: @@ -41,10 +41,13 @@ You can use `run.sh` to run the Autoware runtime container with the map data: ./docker/run.sh --map-path path_to_map_data ``` -For more launch options, you can append a custom launch command instead of using the default launch command `ros2 launch autoware_launch autoware.launch.xml`: +For more launch options, you can append a custom launch command instead of using the default launch command which is `ros2 launch autoware_launch autoware.launch.xml`. + +Here is an example of running the runtime container with a custom launch command: ```bash -./docker/run.sh --map-path path_to_map_data ros2 launch autoware_launch autoware.launch.xml map_path:=/autoware_map vehicle_model:=sample_vehicle sensor_model:=sample_sensor_kit +./docker/run.sh --map-path ~/autoware_map/sample-map-rosbag ros2 launch autoware_launch planning_simulator.launch.xml map_path:=/autoware_map vehicle_model:=sample_vehicle sensor_model:=sample_sensor_kit + ``` !!! info @@ -59,7 +62,7 @@ Inside the container, you can run the Autoware tutorials by following these link [Rosbag Replay Simulation](../../tutorials/ad-hoc-simulation/rosbag-replay-simulation.md). -### Development setup +### Development Environment ```bash ./docker/run.sh --devel @@ -67,7 +70,7 @@ Inside the container, you can run the Autoware tutorials by following these link !!! info - By default workspace mounted on the container will be current directory, you can change the workspace path by `--workspace path_to_workspace`. For development environments without NVIDIA GPU support use `--no-nvidia`. + By default workspace mounted on the container will be current directory(pwd), you can change the workspace path by `--workspace path_to_workspace`. For development environments without NVIDIA GPU support use `--no-nvidia`. #### How to set up a workspace From d1cf1a72ec26f61adef5dea192c5e09d14aca980 Mon Sep 17 00:00:00 2001 From: Oguz Ozturk Date: Fri, 17 May 2024 17:08:28 +0300 Subject: [PATCH 2/3] add clone phase Signed-off-by: Oguz Ozturk --- .../autoware/docker-installation.md | 23 ++++++++++++------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/docs/installation/autoware/docker-installation.md b/docs/installation/autoware/docker-installation.md index 4e9860b6ee2..4b8913f6d6c 100644 --- a/docs/installation/autoware/docker-installation.md +++ b/docs/installation/autoware/docker-installation.md @@ -15,17 +15,24 @@ Open AD Kit offers two types of Docker image to let you get started with Autowar - NVIDIA Container Toolkit (preferred) - NVIDIA CUDA 12 compatible GPU Driver (preferred) -The [setup script](https://github.com/autowarefoundation/autoware/blob/main/setup-dev-env.sh) will install all required dependencies with the setup script: +1. Clone `autowarefoundation/autoware` and move to the directory. -```bash -./setup-dev-env.sh -y docker -``` + ```bash + git clone https://github.com/autowarefoundation/autoware.git + cd autoware + ``` -To install without **NVIDIA GPU** support: +2. The [setup script](https://github.com/autowarefoundation/autoware/blob/main/setup-dev-env.sh) will install all required dependencies with: -```bash -./setup-dev-env.sh -y --no-nvidia docker -``` + ```bash + ./setup-dev-env.sh -y docker + ``` + + To install without **NVIDIA GPU** support: + + ```bash + ./setup-dev-env.sh -y --no-nvidia docker + ``` !!! info From afa324e4ef1ccfce7a2611a5d1a867a552fa083d Mon Sep 17 00:00:00 2001 From: oguzkaganozt Date: Thu, 1 Aug 2024 15:05:30 +0300 Subject: [PATCH 3/3] Update docs/installation/autoware/docker-installation.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: M. Fatih Cırıt --- docs/installation/autoware/docker-installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/autoware/docker-installation.md b/docs/installation/autoware/docker-installation.md index 4b8913f6d6c..87bd0c8beab 100644 --- a/docs/installation/autoware/docker-installation.md +++ b/docs/installation/autoware/docker-installation.md @@ -69,7 +69,7 @@ Inside the container, you can run the Autoware tutorials by following these link [Rosbag Replay Simulation](../../tutorials/ad-hoc-simulation/rosbag-replay-simulation.md). -### Development Environment +### Development environment ```bash ./docker/run.sh --devel