{"id":13702757,"url":"https://github.com/RoboStack/jupyter-ros","last_synced_at":"2025-05-05T06:32:31.254Z","repository":{"id":37773912,"uuid":"119152042","full_name":"RoboStack/jupyter-ros","owner":"RoboStack","description":"Jupyter widget helpers for ROS, the Robot Operating System","archived":false,"fork":false,"pushed_at":"2024-12-31T12:59:51.000Z","size":11793,"stargazers_count":600,"open_issues_count":23,"forks_count":113,"subscribers_count":24,"default_branch":"main","last_synced_at":"2025-04-28T19:24:20.802Z","etag":null,"topics":["jupyter","python","ros"],"latest_commit_sha":null,"homepage":"https://jupyter-ros.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RoboStack.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-01-27T09:49:27.000Z","updated_at":"2025-04-13T05:23:21.000Z","dependencies_parsed_at":"2023-02-18T09:30:34.882Z","dependency_job_id":"30f3c3c6-8bb0-4dc2-a4b1-576526fba06c","html_url":"https://github.com/RoboStack/jupyter-ros","commit_stats":{"total_commits":190,"total_committers":23,"mean_commits":8.26086956521739,"dds":0.7263157894736842,"last_synced_commit":"0596d3008ea4c829cd18ce92eca6c96d5fa2e044"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoboStack%2Fjupyter-ros","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoboStack%2Fjupyter-ros/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoboStack%2Fjupyter-ros/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoboStack%2Fjupyter-ros/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RoboStack","download_url":"https://codeload.github.com/RoboStack/jupyter-ros/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252451952,"owners_count":21750011,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jupyter","python","ros"],"created_at":"2024-08-02T21:00:42.132Z","updated_at":"2025-05-05T06:32:26.244Z","avatar_url":"https://github.com/RoboStack.png","language":"Python","funding_links":[],"categories":["Development Environment"],"sub_categories":["Code and Run"],"readme":"# ROS Support for jupyter notebooks\n\nWhile the Jupyter ecosystem has been widely adopted by\nthe Data Science and Machine Learning community, the\nrobotics community has not jumped on the band wagon yet!\nMost tools around ROS, the Robot Operating System, are\nbuilt using Python and QT.\n\nHowever, using QT separates the user away from the code.\nWe've built a set of ROS tools for jupyter\nnotebook, trying to promote a rich, interactive experience\nfor Robotics developers utilizing the power of the jupyter\nnotebook.\n\n[![Video of jupyter-ros in JupyterLab](https://raw.githubusercontent.com/wolfv/jupyter-ros/master/docs/assets/jupyterlab-with-ros.gif)](https://www.youtube.com/watch?v=mPvYZango2E)\n\n![](https://raw.githubusercontent.com/wolfv/jupyter-ros/master/docs/assets/screenshot.png)\n\nWith jupyter-ros, it's possible to easily create widgets for\ncustom message types to send messages.\n\nIf you find this package useful, don't hesitate to\ncontribute!\nYou can also always reach out to w.vollprecht@gmail.com or\non twitter: https://twitter.com/wuoulf, or join us on [Gitter](https://gitter.im/RoboStack/Lobby)\n\n## Installation and Dependencies\n\nYou need a ROS environment with rospy. We recommend using [Robostack](https://github.com/RoboStack/ros-noetic) (follow their installation instructions) which allows you to install ROS in a conda environment.\nAlso required are `numpy` and `bqplot` for the live-plotting, \n`ipywidgets` for the interactive widgets, and `ipycanvas` for the Turtlesim animations.\n\n    conda install jupyter bqplot pyyaml ipywidgets ipycanvas\n\n`pyyaml` is necessary for rospy.\n\nTo install use conda or mamba:\n\n    conda install jupyter-ros -c robostack\n\n##### Development installation\nYou can create a dev environment with:\n```bash\nconda create -n jupyros -c conda-forge python nodejs=14 jupyterlab=3 jupyter bqplot pyyaml ipywidgets ipycanvas\n```\n\nFor a development installation (requires npm),\n\n    git clone https://github.com/RoboStack/jupyter-ros.git\n    cd jupyter-ros\n    pip install -e .\n    jupyter nbextension install --py --symlink --sys-prefix jupyros\n    jupyter nbextension enable --py --sys-prefix jupyros\n\n\nTo update the `defaults.js` javascript you need to run `python jupyros/ros3d.py`.\n\n\n## Troubleshooting\n\nYou might see a warning like \"The rospy package is not found in your $PYTHONPATH.\nSubscribe and publish are not going to work. Do you need to activate your ROS environment?\"\n\nThis 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\n\n```\nimport sys\nsys.path.append('/opt/ros/melodic/lib/python2.7/dist-packages/')\n\n# The next line should now work!\nimport jupyros\n```\n\nIf you got the following error when you run a cell ```failed to display Jupyter Widget of type VBox```,\nyou can solve it by running the following command ```jupyter nbextension enable --py --sys-prefix widgetsnbextension```\n\n## License\n\nWe use a shared copyright model that enables all contributors to maintain the copyright on their contributions.\n\nThis software is licensed under the BSD-3-Clause license. See the LICENSE file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRoboStack%2Fjupyter-ros","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FRoboStack%2Fjupyter-ros","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRoboStack%2Fjupyter-ros/lists"}