Skip to content

Commit 336cf3e

Browse files
committed
Rewrite the beluga Example
Signed-off-by: Maria Teresa Ortega <teresa.ortega0903@gmail.com>
1 parent b48cbc0 commit 336cf3e

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

examples/beluga/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Beluga Example
22

3-
A worked example of a LAMBKIN benchmark pipeline applied to [Beluga AMCL](https://github.com/Ekumen-OS/beluga). It sweeps over sensor models and particle counts, evaluates trajectory accuracy, and aggregates results across all configurations. Ships with its own ROS2 package, Docker environment, and benchmark script.
3+
A worked example of a LAMBKIN benchmark pipeline applied to [Beluga AMCL](https://github.com/Ekumen-OS/beluga) in ROS 2. It sweeps over sensor models and particle counts, evaluates trajectory accuracy, and aggregates results across all configurations. Ships with its own ROS 2 package, Docker environment, and benchmark script.
44

55
## How it works
66

@@ -29,6 +29,8 @@ The launch file accepts the map path, sensor model type, and particle count as p
2929

3030
## Setup
3131

32+
If you are running the benchmark as-is, use the Production profile. If you are modifying the benchmark script or the ROS 2 package, use the Development profile.
33+
3234
### **1. Configure volume mounts**
3335

3436
Edit `docker/docker-compose.yml` and set the host paths to your reference files:
@@ -92,3 +94,6 @@ docker compose --profile production exec lambkin_prod bash
9294
```bash
9395
uv run examples/beluga/beluga_benchmark.py
9496
```
97+
Once complete, results are written to results/ organized by configuration (var_<number>/iter_<number>). Each iteration contains the recorded bag, TUM trajectory, and APE metrics.
98+
99+
> Note: Full execution is not yet implemented. At this stage the benchmark runs in dry-run mode only, printing all commands that would be executed without running them.

0 commit comments

Comments
 (0)