An open API service indexing awesome lists of open source software.

https://github.com/amadeuszsz/autoware_vscode

VS Code configuration for developing Autoware projects with devcontainers
https://github.com/amadeuszsz/autoware_vscode

autoware devcontainer vscode

Last synced: 3 months ago
JSON representation

VS Code configuration for developing Autoware projects with devcontainers

Awesome Lists containing this project

README

          

# Autoware Development Environment

A comprehensive development environment setup for Autoware projects using VS Code Dev Containers with Docker support.

## Overview

This repository provides a complete development environment for Autoware projects, featuring:

- **Docker-based development containers** with pre-configured Autoware environment
- **VS Code project** configuration for seamless development experience
- **System optimization using Ansible** for host machine configuration

## Quick Start

### 1. Requirements

- **Ubuntu 22.04** operating system
- **NVIDIA GPU** for CUDA support

### 2. Host Setup

```bash
# Clone this repository
sudo apt -y update && sudo apt -y install git
git clone https://github.com/amadeuszsz/autoware_vscode.git ~/autoware_vscode

# Install dependencies using Ansible (recommended)
sudo apt purge ansible
sudo apt -y update && sudo apt -y install pipx
python3 -m pipx ensurepath
pipx install --include-deps --force "ansible==6.*"
pipx ensurepath && source ~/.bashrc
cd ~/autoware_vscode && ansible-galaxy collection install -f -r "ansible-galaxy-requirements.yaml"
ansible-playbook autoware_vscode.dev_env.setup_host -K
```

### 3. Workspace Setup

```bash
git clone https://github.com/autowarefoundation/autoware.git ~/autoware
mkdir -p ~/autoware/src && cd ~/autoware
vcs import src < autoware.repos
vcs import src < autoware-nightly.repos

# Setup your development environment
cd ~/autoware_vscode && ./setup_workspace.sh ~/autoware

# Pull docker image (you might need to reboot to apply group Docker permissions)
docker pull ghcr.io/autowarefoundation/autoware:universe-devel-cuda
```

### 4. Code Development

1. Open VS Code
2. Open Dev Container:
- Open command palette (`Ctrl+Shift+P`)
- Type and select `Dev Containers: Open Folder in Container...`
- Select your Autoware workspace
- Choose Dev Containers configuration (recommended: `universe-devel-cuda`) and wait till it's built.
3. Build the workspace:
- Open command palette (`Ctrl+Shift+P`)
- Type and select `Tasks: Run Task`
- Select `Build: Workspace (Release)`
- Wait till the build is complete
4. Trigger clangd indexing:
- Open any C++ related file in VS Code
- Wait till the indexing is complete
5. Start development!

## Documentation

Additional documentation is available in the [docs/](docs/) directory:

- [Debugging](docs/debugging.md) - Debugging Autoware code
- [Terminal Multiplexer](docs/terminal-multiplexer.md) - Working with terminal multiplexers
- [Visualization](docs/visualization.md) - Using visualization tools