{"id":13717587,"url":"https://github.com/RoboStack/jupyterlab-ros","last_synced_at":"2025-05-07T07:31:44.539Z","repository":{"id":42250200,"uuid":"265210034","full_name":"RoboStack/jupyterlab-ros","owner":"RoboStack","description":"Helper extensions for running ROS from within JupyterLab","archived":false,"fork":false,"pushed_at":"2023-03-14T15:15:36.000Z","size":8869,"stargazers_count":63,"open_issues_count":17,"forks_count":22,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-28T04:34:43.753Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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":null,"contributing":null,"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}},"created_at":"2020-05-19T09:57:04.000Z","updated_at":"2025-01-25T14:09:24.000Z","dependencies_parsed_at":"2024-03-17T05:42:09.115Z","dependency_job_id":"b3f9ff5f-aac8-474f-a9ab-a5cc4da63d20","html_url":"https://github.com/RoboStack/jupyterlab-ros","commit_stats":{"total_commits":117,"total_committers":9,"mean_commits":13.0,"dds":0.4358974358974359,"last_synced_commit":"e9aa5e48562397d71c2795867882adbc05af00cc"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoboStack%2Fjupyterlab-ros","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoboStack%2Fjupyterlab-ros/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoboStack%2Fjupyterlab-ros/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoboStack%2Fjupyterlab-ros/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RoboStack","download_url":"https://codeload.github.com/RoboStack/jupyterlab-ros/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251362328,"owners_count":21577443,"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":[],"created_at":"2024-08-03T00:01:24.431Z","updated_at":"2025-05-07T07:31:43.067Z","avatar_url":"https://github.com/RoboStack.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jupyterlab-ros\n\nA JupyterLab extension for ROS.\n\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/RoboStack/jupyterlab-ros/master?urlpath=lab/tree/examples)\n\n### Install\n\nWe recommend following the installation instructions of the [RoboStack](https://github.com/RoboStack/ros-noetic) repository which enables you to install ROS Noetic in a conda environment. After following these instructions, simply\n\n```bash\nconda activate robostackenv\nmamba install jupyterlab-ros nodejs=12\n```\n\n### How to use?\n\nPlease see the [examples](./examples) folder for some tutorials and examples how to use jupyterlab-ros. These require the following ROS packages:\n```bash\nmamba install ros-noetic-ros-core ros-noetic-rospy ros-noetic-rosbridge-suite ros-noetic-rosbag ros-noetic-rosauth ros-noetic-tf2-web-republisher ros-noetic-franka-ros ros-noetic-interactive-marker-tutorials ros-noetic-teb-local-planner ros-noetic-turtlebot3 ros-noetic-turtlebot3-fake\n```\n\n## Contributing\n\n### Install\n\nThe `jlpm` command is JupyterLab's pinned version of\n[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use\n`yarn` or `npm` in lieu of `jlpm` below.\n\n```bash\n# Create a development environment\n# With the following command you have all the necessary to run\n# the examples (you will need to install jupyros from pip later).\n# You can also use the install instructions from https://github.com/RoboStack/ros-noetic\n# to create the environment\nmamba create -n lab-ros -c conda-forge -c robostack python=3.8 nodejs=14 jupyterlab=3 ipympl ipyvuetify bqplot ipywidgets voila ros-noetic-ros-core ros-noetic-rospy ros-noetic-rosbridge-suite ros-noetic-rosbag ros-noetic-rosauth ros-noetic-tf2-web-republisher ros-noetic-franka-ros ros-noetic-interactive-marker-tutorials ros-noetic-teb-local-planner ros-noetic-turtlebot3 ros-noetic-turtlebot3-fake\n\n# Activate the environment and install jupyros\nconda activate lab-ros\npip install jupyros\n\n# Clone the repo to your local environment\ngit clone https://github.com/RoboStack/jupyterlab-ros.git\n# Move to jupyterlab-ros directory\ncd jupyterlab-ros\n\n# Install server extension in editable mode\npython -m pip install -e .\n\n# Link your development version of the extension with JupyterLab\njupyter-labextension develop . --overwrite\n```\n\nYou 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.\n\n```bash\n# Watch the source directory in another terminal tab\njlpm watch\n# Run jupyterlab in watch mode in one terminal tab\njupyter-lab\n```\n\n### Uninstall\n\n```bash\n# Uninstalling the frontend extension\njupyter-labextension uninstall @robostack/jupyterlab-ros\n\n# Uninstalling the server extension\npip uninstall jupyter_ros_server\n\n# Cleaning jupyterlab\njupyter lab clean\njupyter lab build\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRoboStack%2Fjupyterlab-ros","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FRoboStack%2Fjupyterlab-ros","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRoboStack%2Fjupyterlab-ros/lists"}