Installation

Install WiTwin Core and verify your environment

Install#

WiTwin Core is included in the base witwin package:

pip install witwin

It is also installed automatically as a dependency when you install any WiTwin solver package:

pip install witwin-channel   # includes witwin.core
pip install witwin[maxwell]  # includes witwin.core

Requirements#

  • Python: 3.10 or higher

Note

WiTwin Core itself has no GPU requirement. GPU support is only needed when using solver packages like witwin-channel or witwin-maxwell.

Verify#

from witwin.core import Box, Material, Structure
 
box = Box(position=(0.0, 0.0, 0.0), size=(1.0, 1.0, 1.0))
mat = Material(eps_r=4.0)
structure = Structure(name="test", geometry=box, material=mat)
 
print(f"WiTwin Core {__import__('witwin.core', fromlist=['__version__']).__version__}")
print(f"Structure: {structure.name}")

Next Steps#