Skip to content

Commit 9da44aa

Browse files
committed
reorganize Installation
1 parent 48eac94 commit 9da44aa

2 files changed

Lines changed: 30 additions & 42 deletions

File tree

docs/data_organization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Data Organization Guide
22

3-
This guide explains how to organize data for WorldEngine. The platform uses a modular data structure where each subsystem (AlgEngine, SimEngine, RenderEngine) has its own data requirements while sharing common formats.
3+
This guide explains how to organize data for WorldEngine. The platform uses a modular data structure where each subsystem (AlgEngine, SimEngine) has its own data requirements while sharing common formats.
44

55
## Quick Overview
66

docs/installation.md

Lines changed: 29 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ WorldEngine consists of two main subsystems that require **separate conda enviro
55
- **SimEngine** (`simengine` env, Python 3.9) - Closed-loop simulation with photorealistic rendering
66
- **AlgEngine** (`algengine` env, Python 3.9) - End-to-end model training and evaluation
77

8-
> **Note:** RenderEngine uses the same environment as SimEngine since it's based on MTGS and shares dependencies.
8+
> **Note:** Scene Reconstruction uses the same environment as SimEngine since it's based on MTGS and shares dependencies.
99
1010
---
1111

@@ -22,7 +22,7 @@ WorldEngine consists of two main subsystems that require **separate conda enviro
2222
**Recommended:**
2323
- GPU: NVIDIA GPU with 24GB+ VRAM (e.g., RTX 3090, A100)
2424
- RAM: 64GB+
25-
- Storage: 2TB+ SSD
25+
- Storage: 5TB+ SSD
2626
- CPU: 16+ cores
2727

2828
### Software Requirements
@@ -82,22 +82,7 @@ cd projects/SimEngine
8282
pip install -r requirements.txt
8383
```
8484

85-
#### 6. Set Environment Variables
86-
87-
Add to your `~/.bashrc` or `~/.zshrc`:
88-
89-
```bash
90-
# WorldEngine Environment Variables
91-
export WORLDENGINE_ROOT="/path/to/WorldEngine"
92-
export PYTHONPATH=$WORLDENGINE_ROOT:$PYTHONPATH
93-
```
94-
95-
Apply changes:
96-
```bash
97-
source ~/.bashrc # or source ~/.zshrc
98-
```
99-
100-
#### 7. Verify Installation
85+
#### 6. Verify Installation
10186

10287
```bash
10388
conda activate simengine
@@ -188,29 +173,7 @@ pip install -r requirements.txt
188173
pip install shapely==2.0.4
189174
```
190175

191-
#### 6. Set Environment Variables
192-
193-
Also, we rely on NAVSIM devkit, please git clone and switch to `v1.1` branch:
194-
```bash
195-
git clone -b v1.1 https://github.com/autonomousvision/navsim.git
196-
```
197-
Add to your `~/.bashrc` or `~/.zshrc`:
198-
199-
```bash
200-
# AlgEngine Environment Variables
201-
export WORLDENGINE_ROOT="/path/to/WorldEngine"
202-
export ALGENGINE_ROOT="${WORLDENGINE_ROOT}/projects/AlgEngine"
203-
export NUPLAN_MAPS_ROOT="${WORLDENGINE_ROOT}/data/raw/nuplan/maps"
204-
export NAVSIM_DEVKIT_ROOT="/path/to/your/navsim/v1.1"
205-
export PYTHONPATH=$WORLDENGINE_ROOT:$ALGENGINE_ROOT:$NAVSIM_DEVKIT_ROOT:$PYTHONPATH
206-
```
207-
208-
Apply changes:
209-
```bash
210-
source ~/.bashrc # or source ~/.zshrc
211-
```
212-
213-
#### 7. Verify Installation
176+
#### 6. Verify Installation
214177

215178
```bash
216179
conda activate algengine
@@ -228,6 +191,31 @@ print(f'✓ MMDetection3D {mmdet3d.__version__}')
228191
print(f'✓ CUDA available: {torch.cuda.is_available()}')
229192
"
230193
```
194+
---
195+
196+
## Environment Variables
197+
198+
we rely on NAVSIM devkit, please git clone and switch to `v1.1` branch:
199+
```bash
200+
git clone -b v1.1 https://github.com/autonomousvision/navsim.git
201+
```
202+
Add to your `~/.bashrc` or `~/.zshrc`:
203+
204+
```bash
205+
# AlgEngine Environment Variables
206+
export NAVSIM_DEVKIT_ROOT="/path/to/your/navsim/v1.1"
207+
export WORLDENGINE_ROOT="/path/to/WorldEngine"
208+
export SIMENGINE_ROOT="${WORLDENGINE_ROOT}/projects/SimEngine"
209+
export ALGENGINE_ROOT="${WORLDENGINE_ROOT}/projects/AlgEngine"
210+
export NUPLAN_MAPS_ROOT="${WORLDENGINE_ROOT}/data/raw/nuplan/maps"
211+
212+
PYTHONPATH=$WORLDENGINE_ROOT:$SIMENGINE_ROOT:$ALGENGINE_ROOT:$NAVSIM_DEVKIT_ROOT:$PYTHONPATH
213+
```
214+
215+
Apply changes:
216+
```bash
217+
source ~/.bashrc # or source ~/.zshrc
218+
```
231219

232220
---
233221

0 commit comments

Comments
 (0)