uahic / jupyterlab-ros

Helper extensions for running ROS from within JupyterLab

jupyterlab-ros

A JupyterLab extension for ROS.

Requirements

• python >= 3.6
• JupyterLab >= 2.0
• npm >= 6.13.4
• ROS
  • ros-melodic-ros-core
  • ros-melodic-rospy
  • ros-melodic-rosbridge-suite
  • ros-melodic-rosbag
  • ros-melodic-rosauth
  • ros-melodic-tf2-web-republisher

Install

# Create a new environment with the dependencies
mamba create -n jupyterlab-ros -c conda-forge -c robostack python=3.6 nodejs=12 jupyterlab ros-melodic-ros-core ros-melodic-rosauth ros-melodic-rospy ros-melodic-rosbridge-suite ros-melodic-rosbag ros-melodic-tf2-web-republisher

conda activate jupyterlab-ros

# Install the extension
pip install jupyter-ros-server

Uninstall

# Uninstalling python package
pip uninstall jupyter-ros-server

# Cleaning jupyterlab
jupyter lab clean
jupyter lab build

Contributing

Install

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
git clone https://github.com/RoboStack/jupyterlab-ros.git
# Move to jupyterlab-ros directory
cd jupyterlab-ros

# Install server extension in editable mode
python -m pip install -e .

# Link your development version of the extension with JupyterLab
jupyter-labextension develop . --ovewrite

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter-lab

Uninstall

# Uninstalling the frontend extension
jupyter-labextension uninstall @robostack/jupyterlab-ros

# Uninstalling the server extension
pip uninstall jupyter_ros_server

# Cleaning jupyterlab
jupyter lab clean
jupyter lab build