Skip to content

Commit

Permalink
docs(installation): simplify run.sh commands (#551)
Browse files Browse the repository at this point in the history
* simplify run.sh commands

Signed-off-by: Oguz Ozturk <oguzkaganozt@gmail.com>

* add clone phase

Signed-off-by: Oguz Ozturk <oguzkaganozt@gmail.com>

* Update docs/installation/autoware/docker-installation.md

Co-authored-by: M. Fatih Cırıt <xmfcx@users.noreply.github.com>

---------

Signed-off-by: Oguz Ozturk <oguzkaganozt@gmail.com>
Co-authored-by: M. Fatih Cırıt <xmfcx@users.noreply.github.com>
  • Loading branch information
oguzkaganozt and xmfcx authored Aug 1, 2024
1 parent 1200ceb commit e610261
Showing 1 changed file with 23 additions and 13 deletions.
36 changes: 23 additions & 13 deletions docs/installation/autoware/docker-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,36 +15,46 @@ 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

GPU acceleration is required for some features such as object detection and traffic light detection/classification. For details of how to enable these features without a GPU, refer to the [Running Autoware without CUDA](../../how-to-guides/others/running-autoware-without-cuda.md).

## Usage

### Runtime setup
### Runtime

You can use `run.sh` to run the Autoware runtime container with the map data:

```bash
./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
Expand All @@ -59,15 +69,15 @@ 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
```

!!! 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

Expand Down

0 comments on commit e610261

Please sign in to comment.