RFDT Solver and WiTwin Simulator are undergoing internal testing as we prepare for public release. The functions are limited. Sign up to receive updates.

API Reference

Complete API documentation for WiTwin

Coming Soon

Detailed API documentation will be available upon publication. The comprehensive reference will include all classes, methods, and examples to help you get the most out of WiTwin.

Documentation Status#

  • Documentation in preparation
  • Coming with official release

Available Sections#

Core Classes#

Essential classes for building wireless simulations:

  • Environment: Simulation environment and scene management
  • Transmitter: Wireless transmitter device configuration
  • Receiver: Wireless receiver device configuration
  • Object: Physical objects in the environment
  • Material: Electromagnetic material properties
  • Antenna Patterns: Various antenna types and configurations

View Core Classes Reference

Simulation Engine#

Advanced simulation options and configurations (coming soon).

Utilities#

Helper functions and tools (coming soon).

Quick Reference#

import witwin as wt
 
# Create environment
env = wt.Environment(frequency=60e9)
 
# Add transmitter
tx = wt.Transmitter(position=[0, 0, 10], power_dbm=23)
env.add_device(tx)
 
# Add receiver
rx = wt.Receiver(position=[10, 5, 1.5])
env.add_device(rx)
 
# Run simulation
results = env.simulate()

In the Meantime#

Explore our tutorials and examples: