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.

Sign up for GitHub

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(installation): update the installation instructions #516

Merged
merged 11 commits into from
Mar 6, 2024
Merged

docs(installation): update the installation instructions #516

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
668838b
Update Docker installation instructions
oguzkaganozt Feb 5, 2024
1af7fd8
style(pre-commit): autofix
pre-commit-ci[bot] Feb 5, 2024
f1f1734
Update source installation documentation
oguzkaganozt Mar 5, 2024
022a446
reorder source installation instructions and add artifacts to the list
Mar 6, 2024
19fd296
bring the back
Mar 6, 2024
7b93b72
the
Mar 6, 2024
2e00456
nvidia typo fix
Mar 6, 2024
6aa1a9a
fix local dead link
Mar 6, 2024
7b45d8b
fix setup-dev-env.sh link
Mar 6, 2024
f986389
fix small spelling mistakes and capitalizations
Mar 6, 2024
bd5092e
add under construction
Mar 6, 2024
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 docs/installation/autoware/docker-installation.md
View file
Open in desktop
ambroise-arm marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Open AD Kit: Containerized Workloads for the Autoware
# Open AD Kit: Containerized Workloads for Autoware

Open AD Kit offers two types of Docker image to let you get started with the Autoware quickly: `devel` and `runtime`.
Open AD Kit offers two types of Docker image to let you get started with Autoware quickly: `devel` and `runtime`.

1. The `devel` image enables you to develop Autoware without setting up the local development environment.
2. The `runtime` image contains only runtime executables and enables you to try out Autoware quickly.

!!! info

Before proceeding, confirm and agree with the [NVIDIA Deep Learning Container license](https://developer.nvidia.com/ngc/nvidia-deep-learning-container-license). By pulling and using the Autoware Open AD Kit images, you accept the terms and conditions of the license.
Before proceeding, confirm and agree with the [NVIDIA Deep Learning Container license](https://developer.nvidia.com/ngc/nvidia-deep-learning-container-license). By pulling and using Autoware Open AD Kit images, you accept the terms and conditions of the license.
ambroise-arm marked this conversation as resolved.
Show resolved Hide resolved

## Prerequisites

Expand Down Expand Up @@ -53,7 +53,7 @@

#### Run Autoware simulator

Inside the container, you can run the Autoware simulation by following these tutorials:
Inside the container, you can run Autoware simulation by following these tutorials:
ambroise-arm marked this conversation as resolved.
Show resolved Hide resolved

[Planning Simulation](../../tutorials/ad-hoc-simulation/planning-simulation.md)

Expand Down Expand Up @@ -113,7 +113,7 @@
Get the Visual Studio Code's [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension.
And reopen the workspace in the container by selecting `Remote-Containers: Reopen in Container` from the Command Palette (`F1`).

By default devcontainer assumes NIVIDA GPU support, you can change this by deleting these lines within `.devcontainer/devcontainer.json`:

Check warning on line 116 in docs/installation/autoware/docker-installation.md

View workflow job for this annotation

GitHub Actions / spell-check-differential 

Unknown word (NIVIDA)
ambroise-arm marked this conversation as resolved.
Show resolved Hide resolved

```json
"hostRequirements": {
Expand Down
7 changes: 4 additions & 3 deletions docs/installation/autoware/source-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,10 @@ sudo apt-get -y install git
- [Install ROS 2 Dev Tools](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/ros2_dev_tools#manual-installation)
- [Install the RMW Implementation](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/rmw_implementation#manual-installation)
- [Install pacmod](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/pacmod#manual-installation)
- [Install Autoware Core dependencies](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/autoware_core#manual-installation)
- [Install Autoware Universe dependencies](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/autoware_universe#manual-installation)
- [Install pre-commit dependencies](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/pre_commit#manual-installation)
- [Install gdown](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/gdown#manual-installation)
- [Install geographiclib](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/geographiclib#manual-installation)
- [Install Build Tools](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/build_tools#manual-installation)
- [Install Development Tools](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/dev_tools#manual-installation)
- [Install Nvidia CUDA](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/cuda#manual-installation)
- [Install Nvidia cuDNN and TensorRT](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/tensorrt#manual-installation)

Expand Down
Loading