Merge branch 'declare-dependencies-jupyter-and-bokeh' into 'master'

Declare dependencies on jupyter & bokeh and update README

See merge request micro-ROS/ros_tracing/tracetools_analysis!63
This commit is contained in:
Christophe Bedard 2020-05-23 13:28:49 +00:00
commit 975adac7f9
2 changed files with 4 additions and 15 deletions

View file

@ -4,20 +4,6 @@
Analysis tools for [ROS 2 tracing](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing).
## Setup
Install:
* `pandas`
```
$ sudo apt-get install python3-pandas
```
To display results, install:
* [Jupyter](https://jupyter.org/install)
* [Bokeh](https://bokeh.pydata.org/en/latest/docs/user_guide/quickstart.html#userguide-quickstart-install)
## Trace analysis
After generating a trace (see [`ros2_tracing`](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing#tracing)), we can analyze it to extract useful execution data.
@ -40,7 +26,7 @@ $ ros2 trace-analysis process /path/to/trace/directory
The last command will process and output the raw data models, but to actually display results, process and analyze using a Jupyter Notebook.
```
```shell
$ jupyter notebook
```

View file

@ -13,6 +13,9 @@
<depend>tracetools_read</depend>
<depend>python3-pandas</depend>
<exec_depend>jupyter-notebook</exec_depend>
<exec_depend>python3-bokeh-pip</exec_depend>
<test_depend>ament_copyright</test_depend>
<test_depend>ament_flake8</test_depend>
<test_depend>ament_mypy</test_depend>