Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ The Autoware Foundation is a voting member of the [SOAFEE (Scalable Open Archite

Open AD Kit is a micro-service based project, which means that it is designed to be deployed on a variety of platforms with microservices architecture. Each component is designed to be independent and can be deployed on a variety of platforms.

- **Independent components** for sensing, perception, mapping, localization, planning, control, and visualization
- **Multi-platform deployment** supporting both amd64 and arm64 architectures
- **Service mesh integration** with configurable environment variables
- **Independent images** for sensing, perception, mapping, localization, planning, control, APIs, simulation, and visualization
- **Multi-platform deployment** supporting both amd64 and arm64 architectures
- **Configurable ROS 2 container deployments** with environment-driven composition

![Granular Components](docs/assets/images/granular-components.png)

Expand All @@ -53,7 +53,7 @@ Open AD Kit leverages modern cloud native technologies to deliver scalable, port

- **Seamless scaling** from development laptops to production edge devices
- **Hybrid cloud support** bridging development and production environments
- **Container orchestration** ready for Kubernetes and similar platforms
- **Containerized runtimes** using Docker Compose, Docker Bake, and platform-specific integrations such as AutoSD

![Cloud Native](docs/assets/images/cloud-native.png)

Expand Down
2 changes: 1 addition & 1 deletion deployments/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ This directory contains deployment configurations for **Open AD Kit**. Each fold
- [Planning Simulation](./samples/planning-simulation): Simple Open AD Kit deployment that demonstrates the autoware **planning features** with planning simulation.
- [Logging Simulation](./samples/logging-simulation): Simple Open AD Kit deployment that demonstrates the autoware **end-to-end functionality** with sensor simulation using rosbag.
- **Demo deployment** configurations with specific use case scenarios.
- [Zenoh Bridge](./demos/zenoh-bridge): A demo of remote visualization with Zenoh bridge. See [Zenoh Bridge Document](openadkit-dev/docs/deployments/zenoh-bridge/index.md) for more details.
- [Zenoh Bridge](./demos/zenoh-bridge): A demo of remote visualization with Zenoh bridge. See the [Zenoh Bridge documentation](../docs/deployments/demos/zenoh-bridge/index.md) for more details.
32 changes: 24 additions & 8 deletions deployments/samples/logging-simulation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,25 @@ This sample deployment shows how to run Autoware Open AD Kit **logging simulatio

## Requirements

In order to run the logging simulation, you need to have the logging simulation **sample map** and **rosbag**. You can download them by running the following commands:
In order to run the logging simulation, you need the logging simulation **sample map**, **rosbag**, and the Autoware artifacts downloaded by `setup.sh --download-artifacts`.

If `gdown` or `unzip` are not installed yet, install them first:

```bash
sudo apt-get install -y python3-pip unzip
python3 -m pip install --user gdown
```

### Sample Logging Map

Download and unpack a logging simulation sample map that is used in this sample.

- You can also download [the map](https://drive.google.com/file/d/1499_nsbUbIeturZaDj7jhUownh5fvXHd/view?usp=sharing) manually.
- You can also download [the map](https://drive.google.com/file/d/1A-8BvYRX3DhSzkAnOcGWFw5T30xTlwZI/view?usp=sharing) manually.

```bash
gdown -O ~/autoware_map/ 'https://docs.google.com/uc?export=download&id=1A-8BvYRX3DhSzkAnOcGWFw5T30xTlwZI'
unzip -d ~/autoware_map/ ~/autoware_map/sample-map-rosbag.zip
mkdir -p ~/autoware_map
gdown -O ~/autoware_map/sample-map-rosbag.zip 'https://docs.google.com/uc?export=download&id=1A-8BvYRX3DhSzkAnOcGWFw5T30xTlwZI'
unzip -o -d ~/autoware_map ~/autoware_map/sample-map-rosbag.zip
```

> **Note**: This sample map(Copyright 2020 TIER IV, Inc.) is only for demonstration purposes. You can use your own map by following the [How-to Guide](https://autowarefoundation.github.io/autoware-documentation/main/how-to-guides/integrating-autoware/creating-maps/).
Expand All @@ -23,15 +31,23 @@ unzip -d ~/autoware_map/ ~/autoware_map/sample-map-rosbag.zip

Download and unpack a sample rosbag that is used for **sensor simulation** in this sample.

- You can also download [the rosbag](https://drive.google.com/file/d/1499_nsbUbIeturZaDj7jhUownh5fvXHd/view?usp=sharing) manually.
- You can also download [the rosbag](https://drive.google.com/file/d/1sU5wbxlXAfHIksuHjP3PyI2UVED8lZkP/view?usp=sharing) manually.

```bash
gdown -O ~/autoware_map/ 'https://docs.google.com/uc?export=download&id=1sU5wbxlXAfHIksuHjP3PyI2UVED8lZkP'
unzip -d ~/autoware_map/ ~/autoware_map/sample-rosbag.zip
gdown -O ~/autoware_map/sample-rosbag.zip 'https://docs.google.com/uc?export=download&id=1sU5wbxlXAfHIksuHjP3PyI2UVED8lZkP'
unzip -o -d ~/autoware_map ~/autoware_map/sample-rosbag.zip
```

> **Note**: Due to privacy concerns, the rosbag(Copyright 2020 TIER IV, Inc.) does not contain image data, which will cause: Traffic light recognition functionality cannot be tested with this sample rosbag. Object detection accuracy is decreased.

### Autoware Artifacts

This deployment mounts `${HOME}/autoware_data` into the sensing and perception containers. Download the artifacts ahead of time by following the [Getting Started](../../../docs/getting-started/index.md) guide:

```bash
sudo ./setup.sh --download-artifacts
```

## Run the Deployment

1. Start the deployment by running the following command:
Expand All @@ -46,7 +62,7 @@ unzip -d ~/autoware_map/ ~/autoware_map/sample-rosbag.zip
http://localhost:6080/vnc.html
```

Use the default password `openadkit` to access the visualizer. **It can take a few seconds to visualizer to start.**
Use the default password `openadkit` to access the visualizer. **It can take a few seconds for the visualizer to start.**

> If your machine is on a remote server, you can access the visualizer by using its accessible IP address:
>
Expand Down
16 changes: 12 additions & 4 deletions deployments/samples/planning-simulation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,14 @@ This sample deployment shows how to run Autoware Open AD Kit **planning simulati

## Requirements

In order to run the planning simulation, you need to have the planning simulation **sample map**. You can download it by running the following commands:
In order to run the planning simulation, you need the planning simulation **sample map**.

If `gdown` or `unzip` are not installed yet, install them first:

```bash
sudo apt-get install -y python3-pip unzip
python3 -m pip install --user gdown
```

### Sample Planning Map

Expand All @@ -13,8 +20,9 @@ Download and unpack a planning simulation sample map that is used in this sample
- You can also download [the map](https://drive.google.com/file/d/1499_nsbUbIeturZaDj7jhUownh5fvXHd/view?usp=sharing) manually.

```bash
gdown -O ~/autoware_map/ 'https://docs.google.com/uc?export=download&id=1499_nsbUbIeturZaDj7jhUownh5fvXHd'
unzip -d ~/autoware_map ~/autoware_map/sample-map-planning.zip
mkdir -p ~/autoware_map
gdown -O ~/autoware_map/sample-map-planning.zip 'https://docs.google.com/uc?export=download&id=1499_nsbUbIeturZaDj7jhUownh5fvXHd'
unzip -o -d ~/autoware_map ~/autoware_map/sample-map-planning.zip
```

> **Note**: This sample map(Copyright 2020 TIER IV, Inc.) is only for demonstration purposes. You can use your own map by following the [How-to Guide](https://autowarefoundation.github.io/autoware-documentation/main/how-to-guides/integrating-autoware/creating-maps/).
Expand All @@ -33,7 +41,7 @@ unzip -d ~/autoware_map ~/autoware_map/sample-map-planning.zip
http://localhost:6080/vnc.html
```

Use the default password `openadkit` to access the visualizer. **It can take a few seconds to visualizer to start.**
Use the default password `openadkit` to access the visualizer. **It can take a few seconds for the visualizer to start.**

> If your machine is on a remote server, you can access the visualizer by using its accessible IP address:
>
Expand Down
12 changes: 4 additions & 8 deletions docs/components/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Components

Open AD Kit is a component based project, which means that it is designed to be deployed on a variety of platforms with microservices architecture. Each **Autoware component** is designed to be independent and can be configured to work together to achieve a particular task, such as a simulation or a full autonomous driving stack.
Open AD Kit is a component-based project designed to run on a variety of platforms with containerized services. Each **Autoware function** remains independently deployable, while the published images group closely related functions together where that keeps the runtime layout simpler.

![Granular Components](../assets/images/granular-components.png)

Expand Down Expand Up @@ -30,14 +30,10 @@ The planning component is responsible for planning the vehicle's path. Planning

The control component is responsible for controlling the vehicle's actuators. Control component can be configured to use a variety of control algorithms, including **PID and MPC**. For more details, see the [Autoware control design document](https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-architecture-v1/components/control/).

### Vehicle
### Vehicle and System

The vehicle component is responsible for managing the vehicle's state. Vehicle component can be configured to use a variety of vehicle algorithms, including **vehicle state estimation and vehicle control**. For more details, see the [Autoware vehicle design document](https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-architecture-v1/components/vehicle/).
The `vehicle-system` image packages both the vehicle interface and system-level services used by the Open AD Kit deployments. On the functional side, the vehicle component manages vehicle-specific interfaces and state, while the system component provides health monitoring and related system services. For more details, see the [Autoware vehicle design document](https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-architecture-v1/components/vehicle/).

### API

The API component is responsible for providing [AD API](https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-interfaces/ad-api/) interface for the vehicle's state. API component can be configured to enable/disable various interfaces. For more details, see the [Autoware Interface design document](https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-architecture-v1/interfaces/).

### System

The system component is responsible for managing the vehicle's system. System component can be configured to use a variety of system algorithms, including **system health monitoring and system error handling**.
The API component is responsible for providing [AD API](https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-interfaces/ad-api/) interface for the vehicle's state. API component can be configured to enable or disable various interfaces. For more details, see the [Autoware Interface design document](https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-architecture-v1/interfaces/).
4 changes: 2 additions & 2 deletions docs/deployments/samples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

Sample deployment configurations to help you get started. Recommended for **learning and development**.

- [Planning Simulation](planning-simulation/index.md)
- [Logging Simulation](logging-simulation/index.md)
- [Planning Simulation](planning-simulation/index.md) - Run the Autoware planning simulation with a sample map.
- [Logging Simulation](logging-simulation/index.md) - Run the Autoware logging simulation with a sample rosbag.
70 changes: 18 additions & 52 deletions docs/deployments/samples/logging-simulation/index.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,35 @@
# Autoware Open AD Kit Logging Simulation

This sample deployment shows how to run Autoware Open AD Kit **logging simulation**.
This sample deployment demonstrates the Open AD Kit logging simulation workflow.

## Requirements
## Source of Truth

In order to run the logging simulation, you need to have the logging simulation **sample map** and **rosbag**. You can download them by running the following commands:
The complete operational instructions for this deployment live alongside the deployment assets in [`deployments/samples/logging-simulation/README.md`](https://github.com/autowarefoundation/openadkit/blob/main/deployments/samples/logging-simulation/README.md).

### Sample Logging Map
That README covers:

Download and unpack a logging simulation sample map that is used in this sample.
- sample map and rosbag download and extraction
- required Autoware artifacts
- visualizer access
- startup and shutdown commands

- You can also download [the map](https://drive.google.com/file/d/1499_nsbUbIeturZaDj7jhUownh5fvXHd/view?usp=sharing) manually.
## Quick Start

```bash
gdown -O ~/autoware_map/ 'https://docs.google.com/uc?export=download&id=1A-8BvYRX3DhSzkAnOcGWFw5T30xTlwZI'
unzip -d ~/autoware_map/ ~/autoware_map/sample-map-rosbag.zip
```

> **Note**: This sample map(Copyright 2020 TIER IV, Inc.) is only for demonstration purposes. You can use your own map by following the [How-to Guide](https://autowarefoundation.github.io/autoware-documentation/main/how-to-guides/integrating-autoware/creating-maps/).

### Sample Rosbag

Download and unpack a sample rosbag that is used for **sensor simulation** in this sample.

- You can also download [the rosbag](https://drive.google.com/file/d/1499_nsbUbIeturZaDj7jhUownh5fvXHd/view?usp=sharing) manually.
From `deployments/samples/logging-simulation/`:

```bash
gdown -O ~/autoware_map/ 'https://docs.google.com/uc?export=download&id=1sU5wbxlXAfHIksuHjP3PyI2UVED8lZkP'
unzip -d ~/autoware_map/ ~/autoware_map/sample-rosbag.zip
docker compose --env-file logging-simulation.env up -d
docker compose --env-file logging-simulation.env up rosbag -d
```

> **Note**: Due to privacy concerns, the rosbag(Copyright 2020 TIER IV, Inc.) does not contain image data, which will cause: Traffic light recognition functionality cannot be tested with this sample rosbag. Object detection accuracy is decreased.

## Run the Deployment

1. Start the deployment by running the following command:

```bash
docker compose --env-file logging-simulation.env up -d
```
Open the visualizer at:

2. Wait for the deployment to start for about 5 seconds and then open a browser to visualize the simulation and navigate to:

```bash
http://localhost:6080/vnc.html
```

Use the default password `openadkit` to access the visualizer. **It can take a few seconds to visualizer to start.**

> If your machine is on a remote server, you can access the visualizer by using its accessible IP address:
>
> ```bash
> http://<your-server-ip>:6080/vnc.html
> ```

3. To start the logging simulation, you should run the following command to play the rosbag:

```bash
docker compose --env-file logging-simulation.env up rosbag -d
```

## Stop the Deployment
```text
http://localhost:6080/vnc.html
```

Stop the deployment by running the following command:
To stop the deployment:

```bash
docker compose --env-file logging-simulation.env --profile rosbag down
```
```
51 changes: 17 additions & 34 deletions docs/deployments/samples/planning-simulation/index.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,33 @@
# Autoware Open AD Kit Planning Simulation

This sample deployment shows how to run Autoware Open AD Kit **planning simulation**.
This sample deployment demonstrates the Open AD Kit planning simulation workflow.

## Requirements
## Source of Truth

In order to run the planning simulation, you need to have the planning simulation **sample map**. You can download it by running the following commands:
The complete operational instructions for this deployment live alongside the deployment assets in [`deployments/samples/planning-simulation/README.md`](https://github.com/autowarefoundation/openadkit/blob/main/deployments/samples/planning-simulation/README.md).

### Sample Planning Map
That README covers:

Download and unpack a planning simulation sample map that is used in this sample.
- sample map download and extraction
- visualizer access
- startup and shutdown commands

- You can also download [the map](https://drive.google.com/file/d/1499_nsbUbIeturZaDj7jhUownh5fvXHd/view?usp=sharing) manually.
## Quick Start

From `deployments/samples/planning-simulation/`:

```bash
gdown -O ~/autoware_map/ 'https://docs.google.com/uc?export=download&id=1499_nsbUbIeturZaDj7jhUownh5fvXHd'
unzip -d ~/autoware_map ~/autoware_map/sample-map-planning.zip
docker compose --env-file planning-simulation.env up -d
```

> **Note**: This sample map(Copyright 2020 TIER IV, Inc.) is only for demonstration purposes. You can use your own map by following the [How-to Guide](https://autowarefoundation.github.io/autoware-documentation/main/how-to-guides/integrating-autoware/creating-maps/).

## Run the Deployment

1. Start the deployment by running the following command:

```bash
docker compose --env-file planning-simulation.env up -d
```

2. Wait for the deployment to start for about 5 seconds and then open a browser to visualize the simulation and navigate to:
Open the visualizer at:

```bash
http://localhost:6080/vnc.html
```

Use the default password `openadkit` to access the visualizer. **It can take a few seconds to visualizer to start.**

> If your machine is on a remote server, you can access the visualizer by using its accessible IP address:
>
> ```bash
> http://<your-server-ip>:6080/vnc.html
> ```

3. After you see the visualizer, you can start the autonomous driving simulation by following the [planning simulation instructions](https://autowarefoundation.github.io/autoware-documentation/main/demos/planning-sim/lane-driving/#2-set-an-initial-pose-for-the-ego-vehicle) in the Autoware documentation.
```text
http://localhost:6080/vnc.html
```

## Stop the Deployment
To stop the deployment:

```bash
docker compose --env-file planning-simulation.env down
```
```
8 changes: 5 additions & 3 deletions docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

- Docker Engine
- NVIDIA Container Toolkit (Optional but highly recommended for sensing and perception tasks)
- Autoware artifacts (Optional but highly recommended for sensing and perception tasks)
- Autoware artifacts (Optional in general, but required for sensing and perception deployments such as Logging Simulation)

> All the above requirements can be installed by running the **setup.sh** script.

Expand All @@ -31,7 +31,9 @@
sudo ./setup.sh --download-artifacts
```

> This step is required for deployments that mount `${HOME}/autoware_data`, including the Logging Simulation sample.

## Next Steps

- [Running a sample deployment](../deployments/)
- [Learn more about the Open AD Kit components](../components/)
- [Running a sample deployment](../deployments/index.md)
- [Learn more about the Open AD Kit components](../components/index.md)
5 changes: 4 additions & 1 deletion docs/hardware/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ The Open AD Kit supports **amd64** and **arm64** architectures with the followin
## Tested Hardware

- [ADLink AADP-AVA](https://www.adlinktech.com/products/Computer_on_Modules/COM-HPC-Server-Carrier-and-Starter-Kit/Ampere_Altra_Developer_Platform)
- [NVIDIA Jetson Orin](https://www.nvidia.com/en-us/autonomous-machines/embedded-systems/jetson-orin/) (TBD)

## Planned Validation

- [NVIDIA Jetson Orin](https://www.nvidia.com/en-us/autonomous-machines/embedded-systems/jetson-orin/)

## Tested Cloud Instances

Expand Down
Loading
Loading