Initial commit
This commit is contained in:
59
docs/guides/introduction.md
Normal file
59
docs/guides/introduction.md
Normal file
@@ -0,0 +1,59 @@
|
||||
# Vuer: 3D Visualization Toolkit
|
||||
|
||||
**Version:** v0.0.67
|
||||
|
||||
## What is Vuer?
|
||||
|
||||
Vuer is a light-weight visualization toolkit for interacting with dynamic 3D and robotics data. The framework emphasizes accessibility, supporting virtual and augmented reality experiences while remaining mobile-device compatible.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Lightweight performance** - Efficient 3D rendering and visualization
|
||||
- **VR and AR compatibility** - Works with virtual and augmented reality devices
|
||||
- **Community support** - Active community and documentation
|
||||
- **Extensible and customizable** - Build custom visualizations and components
|
||||
- **MIT open-source license** - Free to use and modify
|
||||
|
||||
## Installation
|
||||
|
||||
Install the framework via pip:
|
||||
|
||||
```bash
|
||||
pip install 'vuer[all]==0.0.67'
|
||||
```
|
||||
|
||||
## Quick Example
|
||||
|
||||
Here's a straightforward example demonstrating URDF file loading and browser-based visualization:
|
||||
|
||||
```python
|
||||
from vuer import Vuer
|
||||
|
||||
# Create Vuer app
|
||||
app = Vuer()
|
||||
|
||||
@app.spawn
|
||||
async def main(session):
|
||||
# Your visualization code here
|
||||
pass
|
||||
|
||||
app.run()
|
||||
```
|
||||
|
||||
## Development & Expertise
|
||||
|
||||
The project emerged from research at MIT and UCSD, with contributors specializing in robotics, computer vision, and computer graphics fields.
|
||||
|
||||
## Available Resources
|
||||
|
||||
- **Tutorials** - Learn the basics and advanced topics
|
||||
- Vuer Basics
|
||||
- Tutorial for Roboticists
|
||||
- Camera tutorials
|
||||
- Physics and MuJoCo integration
|
||||
- **Example Gallery** - Diverse use cases and demonstrations
|
||||
- **API Documentation** - Comprehensive reference for components and data types
|
||||
|
||||
## Source
|
||||
|
||||
Documentation available at: https://docs.vuer.ai/
|
||||
Reference in New Issue
Block a user