# Getting Started with Vuer

**Version:** v0.0.67

## Environment Setup

### Create a Conda Environment

```bash
conda create -n vuer python=3.8
conda activate vuer
```

## Installation

### Latest PyPI Version

Install the latest version with all dependencies:

```bash
pip install -U 'vuer[all]==0.0.67'
```

### For Development

If you're contributing to Vuer, use an editable installation:

```bash
pip install -e '.[all]'
```

## Key Learning Pathways

### 1. Vuer Basics Tutorial
Learn foundational concepts for building 3D visualizations with Vuer.

### 2. Tutorial for Roboticists
Specialized tutorial for robotics applications, including URDF loading and robot visualization.

### 3. Example Gallery
Extensive collection of examples demonstrating various capabilities.

## VR/AR Headset Access

To access Vuer visualizations on VR/AR headsets:

1. **Install ngrok** to convert local WebSocket connections to secure connections
2. Local WebSocket: `ws://localhost:8012`
3. Secure WebSocket via ngrok: `wss://xxxxx.ngrok.io`
4. Access the visualization through a query parameter

## Running Examples

### Clone and Setup

```bash
# Clone the repository
git clone https://github.com/vuer-ai/vuer.git
cd vuer

# Install with example dependencies
pip install -U 'vuer[example]==0.0.67'

# Download 3D assets using git LFS
git lfs pull
```

### Execute Examples

Navigate to the examples directory and run Python files:

```bash
cd docs/examples
python your_example.py
```

### Apple Silicon Compatibility

**Important:** Apple Silicon users should install a specific version of open3d:

```bash
pip install open3d==0.15.1
```

This is due to compatibility issues with newer versions on Apple Silicon.

## Building Documentation

For contributors working on documentation:

```bash
make docs
```

## Next Steps

- Explore the [Vuer Basics Tutorial](../tutorials/basics/)
- Check out the [Robotics Tutorial](../tutorials/robotics/)
- Browse the [Example Gallery](../examples/)
- Read the [API Documentation](../api/)

## Source

Documentation: https://docs.vuer.ai/en/latest/quick_start.html