Skip to content
Jupyter widget helpers for ROS, the Robot Operating System
Branch: master
Clone or download
Latest commit 3425462 Apr 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs/assets
js update examples and readme Apr 5, 2019
jupyros Merge pull request #14 from HemaZ/master Apr 18, 2019
notebooks update examples and readme Apr 5, 2019
.gitignore update examples and readme Apr 5, 2019
MANIFEST.in add ros 3d Apr 3, 2019
README.md update readme Apr 5, 2019
RELEASING.md more explanations Apr 3, 2019
jupyter-ros.json add ros 3d Apr 3, 2019
setup.cfg
setup.py

README.md

ROS Support for jupyter notebooks

While the Jupyter ecosystem has been widely adopted by the Data Science and Machine Learning community, the robotics community has not jumped on the band wagon yet! Most tools around ROS, the Robot Operating System, are built using Python and QT.

However, using QT seperates the user away from the code. We've built an initial version of the ROS tools for jupyter notebook, trying to promote a rich, interactive experience for Robotics developers utilizing the power of the jupyter notebook.

Video of jupyter-ros in JupyterLab

With jupyter-ros, it's possible to easily create widgets for custom message types to send messages.

In the future, we plan to bring simple and fast real-time plotting from ROS topics to this library.

If you find this initial package useful, don't hesitate to contribute! You can also always reach out to w.vollprecht@gmail.com or on twitter: https://twitter.com/wuoulf

Installation and Dependencies

You need a ROS environment with rospy, obviously. Also required are numpy and bqplot for the live-plotting.

pip install jupyter bqplot pyyaml

pyyaml is necessary for rospy.

To install use pip:

pip install jupyros
jupyter nbextension enable --py --sys-prefix jupyros

To install the extension for jupyterlab, you also need to execute the following:

$ jupyter labextension install jupyter-ros 
Development installation

For a development installation (requires npm),

git clone https://github.com/wolfv/jupyter-ros.git
cd jupyter-ros
pip install -e .
jupyter nbextension install --py --symlink --sys-prefix jupyros
jupyter nbextension enable --py --sys-prefix jupyros

Troubleshooting

You might see a warning like "The rospy package is not found in your $PYTHONPATH. Subscribe and publish are not going to work. Do you need to activate your ROS environment?"

This is harmless during installation, but if you see this warning in a notebook, you should check that your ROS environment is activated. You can also set the path from inside the notebook using

import sys
sys.path.append('/opt/ros/kinetic/lib/python2.7/dist-packages/')

# The next line should now work!
import jupyros

If you got the following error when you run a cell failed to display Jupyter Widget of type VBox, you can solve it by running the following command jupyter nbextension enable --py --sys-prefix widgetsnbextension

You can’t perform that action at this time.