| Name | rerun-robotics JSON |
| Version |
0.0.7
JSON |
| download |
| home_page | None |
| Summary | Robotics visualization using Rerun |
| upload_time | 2024-12-04 03:59:24 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 William Shen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
robotics
visualization
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# rerun-robotics
Utilities to use the amazing [Rerun visualizer](https://www.rerun.io/) for robotics applications.
This repo is a work in progress.
## Installation
```bash
pip install rerun-robotics
```
### Install from source
```bash
git clone https://github.com/williamshen-nz/rerun-robotics.git
cd rerun-robotics
pip install -e .
```
## Usage
Check the [Rerun documentation](https://www.rerun.io/docs) for information on how to use the viewer.
We currently support the Franka Emika Panda robot and setting it via joint positions.
```python
import rerun as rr
from rerun_robotics import load_franka_panda
rr.init("demo", spawn=True)
panda = load_franka_panda()
# 7 arm joints + 1 gripper joint
panda.set_joint_positions([0, -0.75, 0, -2.35, 0, 1.57, 0.78, 0.04])
```
<img src="https://github.com/williamshen-nz/rerun-robotics/blob/main/docs/panda_example.png?raw=true" width="550">
### Franka Panda Demo
This demo shows how to log joint positions over time using a [timeline](https://rerun.io/docs/concepts/timelines).
```bash
python -m rerun_robotics.examples.panda
```
[Source code](rerun_robotics/examples/panda.py)
## Troubleshooting
If you are having issues, try to install the most recent version of the rerun-sdk (`pip install rerun-sdk -U`). The APIs
are mostly stable but still change sometimes. If you still are unable to get things working, please open an issue and we
will do our best to help!
Last tested on `rerun-sdk==0.17.0`.
## Changelog
See [docs/CHANGELOG.md](docs/CHANGELOG.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "rerun-robotics",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "robotics, visualization",
"author": null,
"author_email": "William Shen <willshen@mit.edu>",
"download_url": "https://files.pythonhosted.org/packages/50/fb/17fdb1c5638d41dd2f476cfc4a26037dc3263a741779bb7bf7086cd85e21/rerun_robotics-0.0.7.tar.gz",
"platform": null,
"description": "# rerun-robotics\n\nUtilities to use the amazing [Rerun visualizer](https://www.rerun.io/) for robotics applications.\nThis repo is a work in progress.\n\n## Installation\n\n```bash\npip install rerun-robotics\n```\n\n### Install from source\n\n```bash\ngit clone https://github.com/williamshen-nz/rerun-robotics.git\ncd rerun-robotics\npip install -e .\n```\n\n## Usage\n\nCheck the [Rerun documentation](https://www.rerun.io/docs) for information on how to use the viewer.\n\nWe currently support the Franka Emika Panda robot and setting it via joint positions.\n\n```python\nimport rerun as rr\nfrom rerun_robotics import load_franka_panda\n\nrr.init(\"demo\", spawn=True)\n\npanda = load_franka_panda()\n# 7 arm joints + 1 gripper joint\npanda.set_joint_positions([0, -0.75, 0, -2.35, 0, 1.57, 0.78, 0.04])\n```\n\n<img src=\"https://github.com/williamshen-nz/rerun-robotics/blob/main/docs/panda_example.png?raw=true\" width=\"550\">\n\n### Franka Panda Demo\n\nThis demo shows how to log joint positions over time using a [timeline](https://rerun.io/docs/concepts/timelines).\n\n```bash\npython -m rerun_robotics.examples.panda\n```\n\n[Source code](rerun_robotics/examples/panda.py)\n\n## Troubleshooting\n\nIf you are having issues, try to install the most recent version of the rerun-sdk (`pip install rerun-sdk -U`). The APIs\nare mostly stable but still change sometimes. If you still are unable to get things working, please open an issue and we\nwill do our best to help!\n\nLast tested on `rerun-sdk==0.17.0`.\n\n## Changelog\n\nSee [docs/CHANGELOG.md](docs/CHANGELOG.md).\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 William Shen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Robotics visualization using Rerun",
"version": "0.0.7",
"project_urls": {
"Source": "https://github.com/williamshen-nz/rerun-robotics"
},
"split_keywords": [
"robotics",
" visualization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3fae359a6bdc4e0ca61200147f0873d15152b138a1c8854fd0e345fe0314451f",
"md5": "fca5cd88054d4ffc496a94ad27ae59a7",
"sha256": "703f6ebbae2c17986ca84945a0f286e73944daec8bcec41b4dd0eb0fb1a93e32"
},
"downloads": -1,
"filename": "rerun_robotics-0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fca5cd88054d4ffc496a94ad27ae59a7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6508,
"upload_time": "2024-12-04T03:59:21",
"upload_time_iso_8601": "2024-12-04T03:59:21.374305Z",
"url": "https://files.pythonhosted.org/packages/3f/ae/359a6bdc4e0ca61200147f0873d15152b138a1c8854fd0e345fe0314451f/rerun_robotics-0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "50fb17fdb1c5638d41dd2f476cfc4a26037dc3263a741779bb7bf7086cd85e21",
"md5": "db43c7a467b884c831936cb76081b39b",
"sha256": "4b5696d5f21a3a757bae1b05621f2abc2933b4c734f3bb4427e1e888ab799f6b"
},
"downloads": -1,
"filename": "rerun_robotics-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "db43c7a467b884c831936cb76081b39b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5119,
"upload_time": "2024-12-04T03:59:24",
"upload_time_iso_8601": "2024-12-04T03:59:24.525787Z",
"url": "https://files.pythonhosted.org/packages/50/fb/17fdb1c5638d41dd2f476cfc4a26037dc3263a741779bb7bf7086cd85e21/rerun_robotics-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-04 03:59:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "williamshen-nz",
"github_project": "rerun-robotics",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "rerun-robotics"
}
