Binary Installation#
Some caret packages are available as Debian packages.
The table below lists the packages that can be installed using binary installation.
| packages name | packages description | binary install |
|---|---|---|
| caret_trace | Define tracepoints added by function hooking | × |
| caret_msgs | Message type defined by caret | ○ |
| caret_analyze | Library for scripts to analyze and visualize data | ○ |
| caret_analyze_cpp_impl | Efficient helper functions to analyze trace data written in C++ | ○ |
| ros2caret | CLI commands like ros2 caret |
○ |
| rclcpp | The forked rclcpp including CARET-dedicated tracepoints | × |
| ros2_tracing | The forked ros2_tracing including definition of CARET-dedicated tracepoints |
× |
Note
Only the packages for analyzing trace data can be installed by binary installation.
The binary does not include the packages for recording trace data.
Requirements#
CARET is confirmed to run on the platforms shown in the following table with supported version.
| dependent platform | supported version |
|---|---|
| ROS | Humble |
| Ubuntu | 22.04 |
| LTTng | stable-2.13 |
| Linux Kernel | 5.15.x |
| Python3 | 3.10.x |
Installation of required packages#
Update your apt repository caches.
sudo apt update
The following packages are required for the CARET binary packages.
These dependencies are not automatically installed with the binary installation.
sudo apt install python3-bt2
python3 -m pip install -U \
pandas>=2.1.1 \
bokeh>=3 \
jupyterlab \
multimethod
Install CARET packages#
Install the caret package released in ROS build farm.
The packages installed here are only those related to trace data analysis.
sudo apt install -y \
ros-humble-caret-analyze \
ros-humble-caret-analyze-cpp-impl \
ros-humble-ros2caret \
ros-humble-caret-msgs
You can confirm that the installation was successful by the following command.
source /opt/ros/humble/setup.bash
ros2 pkg list | grep caret
# caret_analyze
# caret_analyze_cpp_impl
# caret_msgs
# ros2caret
The CARET installed in this section provides the ability to analyze pre-measured trace data.
Please see the tutorial for the analysis procedures.