Skip to content

Commit e5c21cf

Browse files
committed
Change some descriptions
Signed-off-by: Maria Teresa Ortega <teresa.ortega0903@gmail.com>
1 parent 33460a1 commit e5c21cf

1 file changed

Lines changed: 7 additions & 11 deletions

File tree

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,10 @@ It moves away from complex automation "glue" in favor of a clean, Python-first a
88

99
### Scope
1010

11-
In this initial phase, LAMBKIN provides a simple Python script that serves as the foundation for the orchestration system. It automates the full benchmarking
12-
pipeline using **Beluga AMCL** as the localization algorithm, evaluating it across multiple configurations(sensor models and particle counts) and measuring its accuracy against a ground truth trajectory.
11+
Lambkin is a simple, sequential process orchestrator that covers the basic concepts of process lifecycle management and graceful termination for ROS2-based benchmarking pipelines. It handles each stage of a benchmark run in a strictly ordered sequence — spawning nodes, recording topics, synchronizing playback, and collecting evaluation metrics — making the execution flow explicit and easy to follow.
12+
13+
While Lambkin is algorithm-agnostic by design and can integrate with any ROS2-based pipeline, this repository provides a specific worked example using the [Beluga](https://github.com/Ekumen-OS/beluga) AMCL localization algorithm, including a predefined launch file and configuration files to run a complete benchmark out of the box.
1314

14-
- Launches Beluga AMCL with different configurations (sensor models, particle counts)
15-
- Plays a reference rosbag to simulate a real robot environment
16-
- Records the output topics and evaluates the estimated trajectory
17-
- Computes the Absolute Pose Error (APE) against the ground truth
18-
- Generates comparison plots across all configurations
1915

2016
## Architecture
2117

@@ -55,12 +51,12 @@ flowchart TD
5551
style H fill:#ede9fe,stroke:#7c3aed,color:#4c1d95
5652
```
5753

58-
### Use Case
54+
### ROS2 Package
5955

60-
LAMBKIN is designed to work with any localization algorithm package. In this
61-
phase, it orchestrates the following ROS2 nodes:
56+
LAMBKIN is designed to work with any localization algorithm package.
57+
The provided launch file brings up three ROS2 nodes:
6258

63-
- **Beluga AMCL** — the algorithm being benchmarked (e.g. a AMCL-based node), responsible for estimating the robot pose from sensor data and a known map
59+
- **Beluga AMCL** — the algorithm being benchmarked (e.g. a AMCL-based node), responsible for estimating the robot pose from sensor data and a known map.
6460
- **map_server** — provides the static map to the localization node
6561
- **lifecycle_manager** — manages the lifecycle of both the localization node and map_server, handling their startup and shutdown transitions automatically
6662

0 commit comments

Comments
 (0)