diff --git a/README.md b/README.md index e69de29..7fcab46 100644 --- a/README.md +++ b/README.md @@ -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!