Skip to content

docs: fix existing-checkout import and low-memory build instructions #18

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

Merged
woensug-choi merged 1 commit into from
Oct 10, 2026
Merged

docs: fix existing-checkout import and low-memory build instructions #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 7 additions & 1 deletion website/content/en/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Wave Sim is fetched at the pinned upstream revision and built by the helper. It
## 3. Resolve workspace dependencies

```bash
vcs import src --shallow --skip-existing \
vcs import src --skip-existing \
--input src/posim/extras/repos/posim.lyrical.repos
rosdep update --rosdistro lyrical
rosdep install --rosdistro lyrical --from-paths src --ignore-src -r -y
Expand All @@ -62,6 +62,12 @@ source ~/posim_ws/install/setup.bash

Continue with [First simulation](quickstart.md). NVIDIA/CUDA sonar has additional [build requirements](sonar-tuning.md).

If the compiler is killed because memory is exhausted, limit compiler jobs as well as package concurrency. `--executor sequential` serializes packages, not compiler processes:

```bash
MAKEFLAGS="-j1" CMAKE_BUILD_PARALLEL_LEVEL=1 colcon build --merge-install --executor sequential --symlink-install
```

## Update a workspace

Record the current revision, pull the desired POSIM revision, then repeat dependency resolution and the build. Keep custom model work committed before updating.
Expand Down
8 changes: 7 additions & 1 deletion website/content/ko/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Wave Sim은 도우미가 지정된 업스트림 커밋을 내려받아 빌드합
## 3. 작업 공간 의존성 설치

```bash
vcs import src --shallow --skip-existing \
vcs import src --skip-existing \
--input src/posim/extras/repos/posim.lyrical.repos
rosdep update --rosdistro lyrical
rosdep install --rosdistro lyrical --from-paths src --ignore-src -r -y
Expand All @@ -62,6 +62,12 @@ source ~/posim_ws/install/setup.bash

이어서 [첫 시뮬레이션](quickstart.md)을 실행하세요. NVIDIA/CUDA 소나는 [추가 빌드 설정](sonar-tuning.md)이 필요합니다.

메모리 부족으로 컴파일러가 강제 종료되면 패키지뿐 아니라 컴파일 작업 수도 줄이세요. `--executor sequential`은 패키지를 순서대로 빌드하지만, 패키지 안의 컴파일 작업 수까지 제한하지는 않습니다.

```bash
MAKEFLAGS="-j1" CMAKE_BUILD_PARALLEL_LEVEL=1 colcon build --merge-install --executor sequential --symlink-install
```

## 작업 공간 갱신

현재 커밋을 기록하고 필요한 POSIM 커밋을 받은 뒤 의존성 설치와 빌드를 반복합니다. 직접 수정한 로봇 모델은 갱신 전에 커밋하여 보관하세요.
Expand Down
Loading