Skip to content

Commit 3545754

Browse files
committed
Update README with Docker volumes and dry-run usage instructions
Signed-off-by: Maria Teresa Ortega <teresa.ortega0903@gmail.com>
1 parent 938bca3 commit 3545754

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

examples/beluga/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,16 @@ Make sure you have the following reference files available before running the be
5252
docker compose up -d lambkin_dev
5353
docker compose exec -it lambkin_dev bash
5454
```
55+
Mount your reference files as volumes in `docker-compose.yml` before starting the container:
56+
57+
```yaml
58+
volumes:
59+
- /path/to/your/rosbag:/data/rosbag
60+
- /path/to/your/map:/data/map
61+
- /path/to/your/groundtruth:/data/groundtruth
62+
```
63+
64+
> **Note:** Users are responsible for mounting their own reference files. The paths inside the container should match the ones used in the benchmark script.
5565
5666
**2. Install ROS2 dependencies:**
5767
@@ -83,3 +93,11 @@ source install/setup.bash
8393
```bash
8494
uv run examples/beluga/beluga_benchmark.py
8595
```
96+
97+
By default, the benchmark runs in dry-run mode, printing the commands that would be executed without running them:
98+
99+
```bash
100+
uv run examples/beluga/beluga_benchmark.py --dry-run
101+
```
102+
103+
> **Note:** Real execution is not yet supported. The `--dry-run` flag is the only supported mode at this time.

0 commit comments

Comments
 (0)