Metadata-Version: 2.4
Name: urbanverse-scene
Version: 0.1.0
Summary: Python API for UrbanVerse urban scene datasets on HuggingFace (CraftBench & UrbanVerse-Scenes)
Project-URL: Homepage, https://urbanverseproject.github.io/
Project-URL: Repository, https://github.com/VAIL-UCLA/UrbanVerse
Project-URL: CraftBench, https://huggingface.co/datasets/Oatmealliu/UrbanVerse-CraftBench
Project-URL: Scenes, https://huggingface.co/datasets/Oatmealliu/UrbanVerse-Scenes
Author: Mingxuan Liu
License: MIT License
        
        Copyright (c) 2026 Mingxuan Liu - Miu
        
        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.
License-File: LICENSE
Keywords: autonomous-driving,dataset,embodied-ai,huggingface,isaacsim,physical-ai,sidewalk-autonomy,urban-scenes,urban-simulation
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.8
Requires-Dist: huggingface-hub>=0.34.4
Requires-Dist: isaacsim[all,extscache]==4.5.0
Requires-Dist: tqdm>=4.67.1
Description-Content-Type: text/markdown

# urbanverse-scene

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![Python 3.8+](https://img.shields.io/badge/python-3.8%2B-blue.svg)](https://www.python.org/downloads/)
[![PyPI version](https://img.shields.io/pypi/v/urbanverse-scene.svg)](https://pypi.org/project/urbanverse-scene/)

Python API for downloading, exploring, and using **UrbanVerse** urban scene datasets hosted on HuggingFace.

| Dataset | Scenes | HuggingFace |
|---|---|---|
| **CraftBench** | 12 hand-crafted testing scenes | [Oatmealliu/UrbanVerse-CraftBench](https://huggingface.co/datasets/Oatmealliu/UrbanVerse-CraftBench) |
| **UrbanVerse-Scenes** | 320 generated training scenes | [Oatmealliu/UrbanVerse-Scenes](https://huggingface.co/datasets/Oatmealliu/UrbanVerse-Scenes) |

## Installation

```bash
pip install urbanverse-scene --extra-index-url https://pypi.nvidia.com
```

> The `--extra-index-url` flag is required because `isaacsim` is hosted on NVIDIA's PyPI index.

## Quick start

```python
import urbanverse_scene as uvs

# (Optional) Override cache directory (default: ~/.cache/urbanverse_scenes/)
uvs.set("~/my_data/urbanverse_scenes")

# List available CraftBench scenes
descs = uvs.craftbench.get_descriptions()

# Download & extract specific scenes
result = uvs.craftbench.load_scenes(descs[:2])
usd_path = result[descs[0]]  # Path to export_version.usd

# Download all 12 CraftBench scenes
uvs.craftbench.download_all()

# Check download integrity & repair missing files
uvs.craftbench.check_integrity()
uvs.craftbench.repair()

# Preview scenes in the browser (video + images)
uvs.craftbench.preview(descs[:3])

# Open scenes in IsaacSim
uvs.open(descs[:1])
uvs.open(descs[:1], headless=True, rtx=True)
```

## API overview

| Function | Description |
|---|---|
| `uvs.set(path)` | Set the local cache directory |
| `uvs.open(descriptions, headless, rtx)` | Open scenes in IsaacSim |
| `uvs.craftbench.get_descriptions()` | List all 12 CraftBench scene names |
| `uvs.craftbench.load_scenes(descriptions)` | Download & extract specific scenes |
| `uvs.craftbench.download_all()` | Download the full CraftBench dataset |
| `uvs.craftbench.check_integrity()` | Verify download completeness |
| `uvs.craftbench.repair()` | Re-download missing files |
| `uvs.craftbench.preview(descriptions)` | Browser-based scene preview (video + images) |

## Requirements

- Python >= 3.8
- [IsaacSim 4.5.0](https://docs.omniverse.nvidia.com/isaacsim/latest/index.html) (installed automatically as a dependency; requires NVIDIA's extra index)
- [huggingface_hub](https://github.com/huggingface/huggingface_hub) >= 0.34.4

## License

[MIT](LICENSE)

## Links

- [UrbanVerse Project](https://urbanverseproject.github.io/)
- [GitHub Repository](https://github.com/VAIL-UCLA/UrbanVerse)
- [CraftBench Dataset](https://huggingface.co/datasets/Oatmealliu/UrbanVerse-CraftBench)
- [UrbanVerse-Scenes Dataset](https://huggingface.co/datasets/Oatmealliu/UrbanVerse-Scenes)
