Metadata-Version: 2.2
Name: hyvis
Version: 0.1.1
Summary: A package for visualization of quantum-classical hybrid systems.
Author-email: Lucas Euler <lucas.euler@jos-quantum.de>
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy>=1.26.4
Requires-Dist: scikit-learn>=1.4.2
Requires-Dist: matplotlib>=3.8.4
Provides-Extra: qaoa
Requires-Dist: qiskit>=1.1.1; extra == "qaoa"
Requires-Dist: qiskit-aer>=0.14.2; extra == "qaoa"

# HYVIS

Package for visualization of high dimensional function landscapes,
in particular those in quantum-classical hybrid systems.

Provided by JoS Quantum.

# Installation

```bash
pip install hyvis
```


# Features

- Create and manipulate affine linear subspaces of a higher dimensional superspace

- Scan subspaces and visualize the outcome

- Calculate Hessians and use them for visualization

- Explore generating videos using a trajectory in the landscape

<img src="pictures/basicplot.png" alt="basicplot" height="150"/>
<img src="pictures/basichessian.png" alt="basichessian" height="150"/>
<img src="pictures/bubble.gif" alt="bubble" height="150"/>




# Examples

The following notebooks demonstrate the most relevant features:

- [Basics](notebooks/example_basic_scan.ipynb): A toy function scanned in the most simple ways.
- [Hessian](notebooks/example_hessian.ipynb): Using the Hessian to better understand a landscape.
- [Videos](notebooks/example_video_scan.ipynb): Animated videos of scans moving through the hyperspace.
- [Non-trivial Lanscapes](notebooks/example_nontrivial_landscapes.ipynb): The package applied to more involved loss functions. (requires hyvis[qaoa])


# Authors

This package was developed by Lucas Euler. For questions and ideas please contact lucas.euler@jos-quantum.de .

Special thanks to Jason Ledwidge, Marcelin Gallezot, Alessio Paesano and Henrikh Baghramyan at JoS QUANTUM for their support and insight.
