<h2>Vuer: Modern High-Performance Visualization for AI & Robotics in VR
<br/>
<img src="https://api.netlify.com/api/v1/badges/2df7f3ba-1a26-4047-b76a-d7401f907bb5/deploy-status" alt="Production">
<a href="https://pypi.org/project/vuer/">
<img src="https://img.shields.io/pypi/v/vuer.svg" alt="pypi">
</a>
<a href="https://docs.vuer.ai">
<img src="https://readthedocs.org/projects/vuer-py/badge/?version=latest">
</a>
</h2>
<p>
<strong><code>pip install vuer</code></strong>
⬝
visit  <a href="https://docs.vuer.ai">https://docs.vuer.ai</a>  for documentation
</p>
Vuer is a light-weight visualization toolkit for interacting with dynamic 3D and robotics data. It is
VR and AR ready, and can be run on mobile devices.
Our features include:
- light-weight and performant
- VR and AR ready
- Hackable and extensible
- Open source, licensed under MIT
## Installation
You can install `vuer` with `pip`:
```shell
pip install -U 'vuer[all]'
```
Here is an example that loads a URDF file and displays it in the browser. For a more comprehensive list of examples, please refer to
the [examples](https://docs.vuer.ai/en/latest/examples/01_trimesh.html) page.
```python
from vuer import Vuer, VuerSession
from vuer.schemas import DefaultScene, Urdf
app = Vuer()
@app.spawn(start=True)
async def main(session: VuerSession):
app.set @ DefaultScene(
Urdf("assets/urdf/robotiq.urdf"),
)
while True:
await session.sleep(0.1)
```
[](https://vuer.ai?collapseMenu=True&background=131416,fff&initCamPos=2.8,2.2,2.5&ws=ws%3A%2F%2Flocalhost%3A8012&scene=3gAJqGNoaWxkcmVukd4ABKhjaGlsZHJlbpHeAAaoY2hpbGRyZW6Qo3RhZ6RVcmRmo2tleaExo3NyY9lSaHR0cHM6Ly9yYXcuZ2l0aHVidXNlcmNvbnRlbnQuY29tL25hc2EtanBsL20yMDIwLXVyZGYtbW9kZWxzL21haW4vcm92ZXIvbTIwMjAudXJkZqtqb2ludFZhbHVlc94AAKhyb3RhdGlvbpPLQAkeuGAAAAAAAKN0YWenTW92YWJsZaNrZXmhMqhwb3NpdGlvbpMAAMs%2FwzMzQAAAAKN0YWelU2NlbmWja2V5oTOidXCTAAABpGdyaWTDqHNob3dMZXZhwqtyYXdDaGlsZHJlbpLeAASoY2hpbGRyZW6Qo3RhZ6xBbWJpZW50TGlnaHSja2V5tWRlZmF1bHRfYW1iaWVudF9saWdodKlpbnRlbnNpdHkB3gAFqGNoaWxkcmVukKN0YWewRGlyZWN0aW9uYWxMaWdodKNrZXm5ZGVmYXVsdF9kaXJlY3Rpb25hbF9saWdodKlpbnRlbnNpdHkBpmhlbHBlcsOsaHRtbENoaWxkcmVukLJiYWNrZ3JvdW5kQ2hpbGRyZW6Q")
To get a quick overview of what you can do with `vuer`, check out the following:
- take a look at the example gallery [here](https://docs.vuer.ai/en/latest/examples/01_trimesh.html)
- or try to take a look at this demo with a Unitree Go1 robot in front of a flight of stairs [here](https://docs.vuer.ai/en/latest/tutorials/robotics/urdf_go1_stairs.html)
For a comprehensive list of visualization components, please refer to
the [API documentation on Components](https://docs.vuer.ai/en/latest/api/vuer.html).
For a comprehensive list of data types, please refer to the [API documentation on Data Types](https://docs.vuer.ai/en/latest/api/types.html).
Now, to run the examples, first download the example datasets.
Each subdirectory in the `assets` directory contains a `Makefile`. Run the `make` command in each subdirectory to download the datasets. For
example:
```bash
cd assets/static_3d
make
```
Then run the examples
```bash
cd vuer/examples/vuer
python 01_trimesh.py
```
## Contributing to Documentation and Features
Documentation is a crucial part of the `vuer` ecosystem. To contribute to documentation and usage examples, simply:
```bash
pip install -e '.[all]'
make docs
```
This should fire up an http server at the port `8888`, and you can view the documentation at `http://localhost:8888`.
## To Cite
```bibtex
@software{vuer,
author = {Ge Yang},
title = {{VUER}: A 3D Visualization and Data Collection Environment for Robot Learning},
version = {},
publisher = {GitHub},
url = {https://github.com/vuer-ai/vuer},
year = {2024}
}
```
## About Us
Vuer is built by researchers at MIT and UCSD in fields including robotics, computer vision, and computer graphics.
Raw data
{
"_id": null,
"home_page": "https://github.com/vuer-ai/vuer",
"name": "vuer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Ge Yang<ge.ike.yang@gmail.com>",
"author_email": "ge.ike.yang@gmail.com",
"download_url": null,
"platform": null,
"description": "<h2>Vuer: Modern High-Performance Visualization for AI & Robotics in VR\n<br/>\n<img src=\"https://api.netlify.com/api/v1/badges/2df7f3ba-1a26-4047-b76a-d7401f907bb5/deploy-status\" alt=\"Production\">\n<a href=\"https://pypi.org/project/vuer/\">\n<img src=\"https://img.shields.io/pypi/v/vuer.svg\" alt=\"pypi\">\n</a>\n<a href=\"https://docs.vuer.ai\">\n<img src=\"https://readthedocs.org/projects/vuer-py/badge/?version=latest\">\n</a>\n</h2>\n<p>\n<strong><code>pip install vuer</code></strong>\n \u2b1d \nvisit  <a href=\"https://docs.vuer.ai\">https://docs.vuer.ai</a>  for documentation\n</p>\n\nVuer is a light-weight visualization toolkit for interacting with dynamic 3D and robotics data. It is\nVR and AR ready, and can be run on mobile devices.\n\nOur features include:\n\n- light-weight and performant\n- VR and AR ready\n- Hackable and extensible\n- Open source, licensed under MIT\n\n## Installation\n\nYou can install `vuer` with `pip`:\n\n```shell\npip install -U 'vuer[all]'\n```\n\nHere is an example that loads a URDF file and displays it in the browser. For a more comprehensive list of examples, please refer to\nthe [examples](https://docs.vuer.ai/en/latest/examples/01_trimesh.html) page.\n\n```python\nfrom vuer import Vuer, VuerSession\nfrom vuer.schemas import DefaultScene, Urdf\n\napp = Vuer()\n\n\n@app.spawn(start=True)\nasync def main(session: VuerSession):\n app.set @ DefaultScene(\n Urdf(\"assets/urdf/robotiq.urdf\"),\n )\n\n while True:\n await session.sleep(0.1)\n```\n\n[](https://vuer.ai?collapseMenu=True&background=131416,fff&initCamPos=2.8,2.2,2.5&ws=ws%3A%2F%2Flocalhost%3A8012&scene=3gAJqGNoaWxkcmVukd4ABKhjaGlsZHJlbpHeAAaoY2hpbGRyZW6Qo3RhZ6RVcmRmo2tleaExo3NyY9lSaHR0cHM6Ly9yYXcuZ2l0aHVidXNlcmNvbnRlbnQuY29tL25hc2EtanBsL20yMDIwLXVyZGYtbW9kZWxzL21haW4vcm92ZXIvbTIwMjAudXJkZqtqb2ludFZhbHVlc94AAKhyb3RhdGlvbpPLQAkeuGAAAAAAAKN0YWenTW92YWJsZaNrZXmhMqhwb3NpdGlvbpMAAMs%2FwzMzQAAAAKN0YWelU2NlbmWja2V5oTOidXCTAAABpGdyaWTDqHNob3dMZXZhwqtyYXdDaGlsZHJlbpLeAASoY2hpbGRyZW6Qo3RhZ6xBbWJpZW50TGlnaHSja2V5tWRlZmF1bHRfYW1iaWVudF9saWdodKlpbnRlbnNpdHkB3gAFqGNoaWxkcmVukKN0YWewRGlyZWN0aW9uYWxMaWdodKNrZXm5ZGVmYXVsdF9kaXJlY3Rpb25hbF9saWdodKlpbnRlbnNpdHkBpmhlbHBlcsOsaHRtbENoaWxkcmVukLJiYWNrZ3JvdW5kQ2hpbGRyZW6Q\")\n\nTo get a quick overview of what you can do with `vuer`, check out the following:\n\n- take a look at the example gallery [here](https://docs.vuer.ai/en/latest/examples/01_trimesh.html)\n- or try to take a look at this demo with a Unitree Go1 robot in front of a flight of stairs [here](https://docs.vuer.ai/en/latest/tutorials/robotics/urdf_go1_stairs.html)\n\nFor a comprehensive list of visualization components, please refer to\nthe [API documentation on Components](https://docs.vuer.ai/en/latest/api/vuer.html).\n\nFor a comprehensive list of data types, please refer to the [API documentation on Data Types](https://docs.vuer.ai/en/latest/api/types.html).\n\nNow, to run the examples, first download the example datasets.\n\nEach subdirectory in the `assets` directory contains a `Makefile`. Run the `make` command in each subdirectory to download the datasets. For\nexample:\n\n```bash\ncd assets/static_3d\nmake\n```\n\nThen run the examples\n\n```bash\ncd vuer/examples/vuer\npython 01_trimesh.py\n```\n\n## Contributing to Documentation and Features\n\nDocumentation is a crucial part of the `vuer` ecosystem. To contribute to documentation and usage examples, simply:\n\n```bash\npip install -e '.[all]'\nmake docs\n```\nThis should fire up an http server at the port `8888`, and you can view the documentation at `http://localhost:8888`.\n\n## To Cite\n\n```bibtex\n@software{vuer,\n author = {Ge Yang},\n title = {{VUER}: A 3D Visualization and Data Collection Environment for Robot Learning},\n version = {},\n publisher = {GitHub},\n url = {https://github.com/vuer-ai/vuer},\n year = {2024}\n}\n```\n\n## About Us\n\nVuer is built by researchers at MIT and UCSD in fields including robotics, computer vision, and computer graphics.\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": null,
"version": "0.0.34",
"project_urls": {
"Homepage": "https://github.com/vuer-ai/vuer"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "63e52b43cad729aa2e0b91d364f576ce2b74eb893e022ad68ff4cd1c06f85efa",
"md5": "569c139e18b5afe5bd098d09e03de36d",
"sha256": "ffe445882f37289db768e945beb35d19059950f2ffdfab00e1e0d9d67d2f81e6"
},
"downloads": -1,
"filename": "vuer-0.0.34-py3-none-any.whl",
"has_sig": false,
"md5_digest": "569c139e18b5afe5bd098d09e03de36d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 19538886,
"upload_time": "2024-10-02T00:05:56",
"upload_time_iso_8601": "2024-10-02T00:05:56.213777Z",
"url": "https://files.pythonhosted.org/packages/63/e5/2b43cad729aa2e0b91d364f576ce2b74eb893e022ad68ff4cd1c06f85efa/vuer-0.0.34-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-02 00:05:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vuer-ai",
"github_project": "vuer",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "vuer"
}
JSON
