Installation

Install WiTwin Maxwell and verify your environment

Requirements#

  • Python: 3.10 or higher
  • CUDA: 11.8 or 12.x (for GPU acceleration)
  • Operating System: Windows 10/11 or Linux
  • PyTorch: with CUDA support

Warning

WiTwin Maxwell requires an NVIDIA GPU. CPU-only environments are not supported for simulation workflows.

Install#

pip install witwin[maxwell]

This installs WiTwin Maxwell and its dependencies including the base witwin package.

Verify#

import witwin.maxwell as mw
 
scene = mw.Scene(
    domain=mw.Domain(bounds=((-0.5, 0.5), (-0.5, 0.5), (-0.5, 0.5))),
    grid=mw.GridSpec.uniform(0.1),
    boundary=mw.BoundarySpec.pml(num_layers=2, strength=1.0),
    device="cuda",
)
print("WiTwin Maxwell is ready.")
print(f"Scene device: {scene.device}")

If the scene constructs without error, the installation is complete.

Next Steps#