This is an initial compilation of the python classes and their connections to form the Variational Quantum Harmonizer.
It is an overview of the VQH software structure. Expand the Graph view in the right side (click on the icon at the top right corner of the canvas) for a full visualization of all modules put together.
The local and global Graph views are a great way of navigating through this API.
IMPORTANT NOTE: At the time of publishing, this reference contains documentation of VQH as of January 2024 - v0.3 - or the version that was used in the CTM 2024:Studio Quantum - >>Wave Dysfuction<<, sponsored by the Goethe Institut.
See the Github Repo, at branch v0.3_algorithm_dev for using the latest version..
Here’s a schematic overview of the Software structure, which will make you familiarized with the tag names inside this website. The subtag (separated by ’/’ ) will assist in searching for different submodules of VQH in the source code. For instance, for checking sonification mappings, check the synth tag.
vqhapi core source mapper queue hardware interface algorithm synth util
To help with this documentation, or to contribute to VQH, please open a now issue on the github repo Itaborala/VQH-Docs