API reference

Use the API reference when you need exact Python method names, parameters, return values, and examples for integrating AODT into your own scripts or applications.

Available References

• DigitalTwinClient API: connect to the Digital Twin server, load scenarios, inspect status, run full simulations, request CIRs, fetch NumPy results, and manage client sessions.
• Config Builder API: build simulation YAML in Python using SimConfig, panels, DUs, RUs, UEs, S3 settings, Parquet export settings, and calibration-related configuration.
• EM Solver API: reference for EM Solver interfaces.

Where To Start

• If you are running simulations, start with DigitalTwinClient.
• If you are creating the scenario YAML passed to client.start(...), start with Config Builder.
• If you need low-level EM Solver reference, start with EM Solver API.
• For workflow guidance before diving into signatures, see AODT Client.