Installation
Get started with WiTwin by installing the Python package and dependencies
Requirements#
Before installing WiTwin, ensure you have the following prerequisites:
- Python: Version 3.9 or higher
- CUDA: 11.8 or 12.x (for GPU acceleration)
- Operating System: Windows 10/11, Ubuntu 20.04+, or macOS 12+
Warning
GPU support requires NVIDIA GPU with CUDA capability 7.0 or higher (RTX 20 series or newer recommended).
Quick Install#
Coming Soon
The WiTwin Python package will be available on PyPI soon. Stay tuned for the official release!
Verify Installation#
After installation, verify that WiTwin is correctly installed:
import witwin
print(witwin.__version__)
# Test basic functionality
from witwin import Scene, Server
scene = Scene()
print("WiTwin is ready!")Start the Editor#
The WiTwin Studio provides a visual interface for working with simulations:
from witwin import Server, Scene
scene = Scene()
server = Server(scene=scene)
server.start() # Opens browser automatically at http://localhost:8080Or access the cloud-hosted editor at editor.witwin.ai.
Next Steps#
- Read the Quick Start to understand the basics
- Follow the Design Principle to learn about the core concepts
- Try the Tutorials to build your first simulation