Metadata-Version: 2.1
Name: bunny_teleop
Version: 0.0.2
Summary: Bimanual Dexterous Teleoperation with Real-Time Retargeting using VisionPro.
Home-page: 
Author: BunnyVisionPro
Author-email: 
Maintainer: BunnyVisionPro
Maintainer-email: 
License: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.7,<=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyzmq
Requires-Dist: numpy
Requires-Dist: tornado
Provides-Extra: dev
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Provides-Extra: example

<!-- PROJECT LOGO -->

<p align="center">

  <h1 align="center"><img src="docs/assets/logo/bunny.png" width="80">Bunny-VisionPro: Bimanual Dexterous Teleoperation with Real-Time Retargeting using VisionPro</h1>
  <p align="center">
    <a href="https://dingry.github.io/"><strong>Runyu Ding</strong></a>
    ·
    <a href="https://yzqin.github.io/"><strong>Yuzhe Qin</strong></a>
    ·
    <a href="https://jiyuezh.github.io/"><strong>Jiyue Zhu</strong></a>
    ·
    <a href="https://www.researchgate.net/profile/Chengzhe-Jia"><strong>Chengzhe Jia</strong></a>
    <br>
    <a href="https://aaronyang1223.github.io/"><strong>Shiqi Yang</strong></a>
    ·
    <a href="https://rchalyang.github.io/"><strong>Ruihan Yang</strong></a>
    .
    <a href="https://xjqi.github.io/"><strong>Xiaojuan Qi</strong></a>
    .
    <a href="https://xiaolonw.github.io/"><strong>Xiaolong Wang</strong></a>
  </p>
  <h3 align="center"><a href="https://dingry.github.io/projects/bunny_visionpro.html">Project Page</a> | <a href="https://dingry.github.io/BunnyVisionPro/">Documentation</a> | <a href="https://github.com/Dingry/bunny_teleop_server">Teleop Server Code</a> </h3>
  <div align="center"></div>
</p>

<img src="docs/assets/images/Multi_Robot.webp" alt="Teleoperation with various robots.">

## :wrench: Installation and Usage

Please refer to the [documentation](https://dingry.github.io/BunnyVisionPro/) for detailed installation and usage
instructions.

## :tada: News

- [2024/05/06] :fire: Initial release with basic usage of bimanual teleoperation with Vision Pro. Check out
  the [documentation](https://dingry.github.io/BunnyVisionPro/).

## :white_check_mark: TODO

- [x] Tutorial for initialization
- [x] Tutorial for tips and troubleshooting
- [ ] Tutorial for retargeting
- [ ] Robot collision avoidance
- [ ] Robot arm singularity avoidance
- [ ] Collision-free retargeting

## :seedling: Acknowledgement

Our code is built
upon [VisionProTeleop](https://github.com/Improbable-AI/VisionProTeleop), [dex-retargeting](https://github.com/dexsuite/dex-retargeting), [sim-web-visualizer](https://github.com/NVlabs/sim-web-visualizer).
We thank all these authors for their nicely open sourced code and their great contributions to the community.

## :rabbit: Citation

```
@article{bunny-visionpro,
  author  = {Runyu Ding, Yuzhe Qin, Jiyue Zhu, Chengzhe Jia, Shiqi Yang, Ruihan Yang, Xiaojuan Qi, and Xiaolong Wang},
  title   = {Bunny-VisionPro: Bimanual Dexterous Teleoperation with Real-Time Retargeting using Vision Pro},
  year   = {2024}
}
```
