1- # Welcome to Apollo's GitHub page !
1+ # Welcome to Apollo-Lite 's GitHub Page !
22
33[ Apollo-Lite] ( https://github.com/wheelos/apollo-lite ) is a high-performance,
4- flexible architecture accelerating the development, testing, and deployment of
5- Autonomous Vehicles.
4+ flexible architecture designed to accelerate the development, testing, and
5+ deployment of Autonomous Vehicles.
66
77---
88
@@ -21,100 +21,115 @@ Autonomous Vehicles.
2121- [ Quick Start] ( #quick-start )
2222- [ Build & Compile] ( #build--compile )
2323- [ Copyright and License] ( #copyright-and-license )
24- - [ Connect with us ] ( #connect-with-us )
24+ - [ Connect with Us ] ( #connect-with-us )
2525
2626---
2727
2828## Introduction
2929
30- Apollo is packed with powerful modules and features designed for autonomous
31- driving development. Before you take it for a spin , please ensure your
32- environment is properly calibrated and configured by following the prerequisites
33- and installation instructions below. For a deeper dive, check out Apollo's
30+ Apollo-Lite provides powerful modules and features for autonomous driving
31+ development. Before getting started , please ensure your environment meets the
32+ prerequisites and follow the installation instructions below. For a deeper
33+ understanding, refer to the
3434[ architecture overview] ( http://apollo.auto/docs/architecture_overview.html ) to
35- understand its core technologies and platform design.
35+ learn more about the core technologies and platform design.
3636
3737---
3838
3939## Prerequisites
4040
41- - ** Machine:** 8-core CPU, 8GB RAM minimum
42- - ** GPU:** NVIDIA Turing GPU strongly recommended for acceleration
41+ - ** Machine:** Minimum 8-core CPU, 8GB RAM
42+ - ** GPU:** NVIDIA Turing GPU recommended for acceleration
4343- ** Operating System:** Ubuntu 20.04 LTS
4444
4545---
4646
4747## Installation
4848
49- > Detailed installation steps and scripts are provided for ease of setup.
49+ > Detailed installation steps and scripts are provided for a smooth setup.
5050
5151---
5252
5353## Quick Start
5454
55- ### 1. Setup Host Environment
55+ ** Note:** For quick startup and verification, only the CPU-based image
56+ (simulation planning module) is provided. The full GPU-dependent tutorial will
57+ be released later. We recommend starting with the CPU image because the GPU
58+ image is large and has complex dependencies, which may not be suitable for
59+ beginners.
5660
57- Run the following scripts in order to prepare your host machine, which will
58- perform the following steps sequentially:
61+ ### 1. Install Deployment Tool
5962
60- 1 . Install Docker (checks if already installed, then proceeds)
61- 2 . Install NVIDIA Container Toolkit (checks if already installed, depends on
62- Docker)
63- 3 . Perform host system configurations
63+ ``` bash
64+ pip install whl-deploy
65+ ```
66+
67+ ### 2. Setup Host Environment
68+
69+ Run the following scripts to prepare your host machine. These steps will:
70+
71+ 1 . Install Docker (checks if already installed)
72+ 2 . [ skip] Install NVIDIA Container Toolkit (checks if already installed, depends
73+ on Docker)
74+ 3 . [ skip] Perform host system configurations
6475
6576``` bash
66- # setup host
67- bash docker/setup_host/setup_host.sh
77+ whl-deploy setup docker
6878```
6979
70- ### 2 . Start Docker Container
80+ ### 3 . Start Docker Container
7181
72- Download and start the Apollo container image (only needs to be done once):
82+ Download and start the Apollo container image (only required once):
7383
7484``` bash
75- # docker pull & start testing
7685bash docker/scripts/dev_start.sh -d testing
7786```
7887
79- Enter the running container environment in subsequent sessions with :
88+ To enter the running container environment in subsequent sessions:
8089
8190``` bash
82- # docker into
8391bash docker/scripts/dev_into.sh
8492```
8593
86- Setting Environment Variables
94+ Set environment variables:
8795
8896``` bash
8997source cyber/setup.bash
9098```
9199
92- ### 3 . Build Apollo
100+ ### 4 . Build Apollo
93101
94- Build the entire Apollo project with :
102+ To build the entire Apollo project:
95103
96104``` bash
97- ./apollo.sh build
105+ ./apollo.sh build_cpu
98106```
99107
100- To build a single module, use :
108+ To build a specific module:
101109
102110``` bash
103111./apollo.sh build_cpu < module_name>
104- # example :
112+ # Example :
105113./apollo.sh build_cpu planning
106114```
107115
116+ ** Note:** If the build process is killed due to out-of-memory (OOM), try
117+ reducing the number of build threads:
118+
119+ ``` bash
120+ ./apollo.sh build_cpu dreamview --cpus=2
121+ ```
122+
108123---
109124
110125## Copyright and License
111126
112- Apollo is licensed under the [ Apache License 2.0] ( LICENSE ) . Please adhere to the
113- licensing terms when using or contributing to this project.
127+ Apollo-Lite is licensed under the [ Apache License 2.0] ( LICENSE ) . Please comply
128+ with the license terms when using or contributing to this project.
114129
115130---
116131
117- ## Connect with us
132+ ## Connect with Us
118133
119134- ⭐ Star and Fork to support the project!
120135- 💬 Join our [ community discussion group] ( http://apollo.auto/community ) to chat
@@ -123,5 +138,5 @@ licensing terms when using or contributing to this project.
123138
124139---
125140
126- Thank you for being part of Apollo's journey towards autonomous driving
141+ Thank you for being part of Apollo-Lite 's journey towards autonomous driving
127142innovation!
0 commit comments