Add info to readme

This commit is contained in:
Christophe Bedard 2019-07-01 10:29:11 +02:00
parent ce69dba82a
commit 31f456c21c

View file

@ -0,0 +1,20 @@
# tracetools_analysis
Analysis tools for [ROS 2 tracing](https://gitlab.com/ros_tracing/ros2_tracing).
# Setup
To display results, install:
* [Jupyter](https://jupyter.org/install)
* [Bokeh](https://bokeh.pydata.org/en/latest/docs/user_guide/quickstart.html#userguide-quickstart-install)
# Use
Start Jupyter Notebook:
```
$ jupyter notebook
```
Then navigate to the [`analysis/`](./tracetools_analysis/analysis/) directory, and select one of the provided notebooks, or create your own!