Skip to content

Commit 27edfb2

Browse files
committed
docs: add instructions for installing non-default RMW implementations
1 parent 5f397cc commit 27edfb2

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,16 @@ If you want to evaluate native execution mode as well, install ROS 2 and build t
245245
Follow the official [ROS 2 Jazzy Installation steps](https://docs.ros.org/en/jazzy/Installation/Ubuntu-Install-Debs.html).
246246
Other ROS 2 distributions may also work, but they are not officially tested yet.
247247

248+
To benchmark with non-default RMW implementations, install the corresponding packages:
249+
250+
```bash
251+
# For CycloneDDS (rmw_cyclonedds_cpp)
252+
sudo apt install -y ros-jazzy-rmw-cyclonedds-cpp
253+
254+
# For Zenoh (rmw_zenoh_cpp)
255+
sudo apt install -y ros-jazzy-rmw-zenoh-cpp
256+
```
257+
248258
Then, build the ROS 2 package used by this framework in `ros2_node_impl_ws/` (see [ros2_node_impl_ws/README.md](./ros2_node_impl_ws/README.md) for details on ROS 2 node features).
249259

250260
```bash
@@ -253,6 +263,12 @@ cd ros2_node_impl_ws
253263
colcon build --packages-select ros2_perf_multihost_nodes
254264
```
255265

266+
It is recommended to add the following to your `~/.bashrc` so the built package is automatically sourced in every shell session:
267+
268+
```bash
269+
echo "source ~/ros2-perf-multihost/ros2_node_impl_ws/install/local_setup.bash" >> ~/.bashrc
270+
```
271+
256272
#### Python dependencies
257273

258274
Install the following packages on each target Host:

0 commit comments

Comments
 (0)