Welcome to jupyter-ros’s documentation!

Introduction

jupyter-ros comes with many helpers to make working with ROS and rospy source code easier inside a Jupyter Notebook. The jupyter-ros tool suite contains the following pieces:

• publishing and receiving messages from the notebook interface

• a 3D widget for inspecting the robot and sensors in 3D

• playing back bag files and other helpers

General

• Getting Started
• Support

User Documentation

• Installation
  • The jupyter-ros server extension
• ROS Essentials
  • Subscribing to a ROS topic
  • Publishing to a ROS topic
  • Calling a ROS service
  • Calling a ROS action server
  • Turtlesim
• ROS 3D Widgets
• ROS Server Extension
• Troubleshooting
  • Websocket Failure

Developer Documentation

• Developer Installation
  • Install Jupyter-ROS
  • Build Documentation
• Testing
• Contributing
  • Ground Rules
  • Your First Contribution
  • Getting Started
  • How to Report a Bug
  • How to Suggest a Feature or Enhancement
  • Code Review Process
  • Community

Reference

• ROS Widgets
  • subscribe()
  • action_client()
  • add_widgets()
  • bag_player()
  • client()
  • publish()
  • service_client()
  • DepthCloud
  • GridModel
  • InteractiveMarker
  • LaserScan
  • Marker
  • MarkerArrayClient
  • OccupancyGrid
  • Path
  • PointCloud
  • Polygon
  • Pose
  • PoseArray
  • ROSConnection
  • SceneNode
  • TFClient
  • URDFModel
  • Viewer
• ROS2 Widgets

Indices and tables

• Index

• Module Index

• Search Page