API Documentation

Levitate, a python package for simulating acoustic levitation using ultrasonic transducer arrays.

The API consists of four main modules, and a few supporting modules. The main modules contain models to handle transducers and transducer arrays, in the transducers and arrays modules respectively, algorithms to calculate physical properties in the fields module, and some numerical optimization functions in the optimization module. There is also a visualizers module with some convenience function to show various fields, and some analysis tools in analysis. It is possible to use different materials or material properties from the materials module.

The hardware module includes definitions with array geometries corresponding to some physical prototypes, and python-c++ combined setup to control Ultrahaptics physical hardware directly from python. This implementation of Ultrahaptics control from python is not officially supported by Ultrahaptics, and only enables a very limited subset of the research SDK.