Metadata-Version: 2.4
Name: witwin
Version: 0.0.2
Summary: Witwin - Multi-physics simulation platform
License-Expression: MIT
Requires-Python: >=3.10
Requires-Dist: numpy>=1.24
Requires-Dist: torch>=2.0
Provides-Extra: all
Requires-Dist: witwin-channel>=0.0.1; extra == 'all'
Requires-Dist: witwin-genesis>=0.0.1; extra == 'all'
Requires-Dist: witwin-maxwell>=0.0.1; extra == 'all'
Requires-Dist: witwin-radar>=0.0.1; extra == 'all'
Provides-Extra: channel
Requires-Dist: witwin-channel>=0.0.1; extra == 'channel'
Provides-Extra: genesis
Requires-Dist: witwin-genesis>=0.0.1; extra == 'genesis'
Provides-Extra: maxwell
Requires-Dist: witwin-maxwell>=0.0.1; extra == 'maxwell'
Provides-Extra: radar
Requires-Dist: witwin-radar>=0.0.1; extra == 'radar'
Description-Content-Type: text/markdown

# WiTwin Core

WiTwin Core is the core package of the WiTwin stack. It provides the shared foundations used across WiTwin projects, with a focus on common scene representation, geometry primitives, mesh utilities, and state management that can be reused by different simulation modules.

## Get Started

Python 3.10+ and an NVIDIA GPU are required for the main WiTwin simulation workflows.

```bash
pip install witwin
```

## What It Provides

- Shared scene and geometry primitives in `witwin.core`
- Common state management for simulation-facing scene objects
- Reusable mesh, structure, and material building blocks for WiTwin solvers

## Related Solvers

- [WiTwin Maxwell](https://github.com/witwin-ai/witwin-maxwell)
- [WiTwin Radar](https://github.com/witwin-ai/witwin-radar)

## Developer

<a href="http://xingyuchen.me/">
  <img src="https://github.com/Asixa.png" alt="Xingyu Chen" width="48" height="48" style="border-radius:50%;">
</a>

[Xingyu Chen](http://xingyuchen.me/)
