README.md

---
title: Qs Benchmarks
emoji: 💻
colorFrom: purple
colorTo: indigo
sdk: gradio
sdk_version: 3.27.0
app_file: app.py
pinned: false
license: cc-by-4.0
---

# Structure of the repository

The repository contains the following:

- data: the benchmark data that generates the plots both in the corresponding manuscript and also in the data explorer at: qucos.qchub.ch
- exp_data: the expectation values of the final evolved wavefunction used to validate the toolchain
- plot_scripts: the scripts used to generate the various plots displayed at the data explorer: qucos.qchub.ch
- qasm_files: the qasm files corresponding to the quantum algorithms that are used to profile the various simulators
- qasm_parser: the translators used to translate the qasm file into the instruction set of the simulator of choice while allowing to choose the HPC compute capability
- toolchain: the toolchain used to automate the benchmarking i.e., generates the structure to collect benchmarks while also generating the corresponding run files, job script files and scope linker files
- plots_display_all.ipynb: the notebook used to display plots of benchmarks (mainly extracting the data from 'data' folder as above and integrating them into the files in 'plot_scripts')
- expectation_plots.ipynb: the notebook used to display plots corresponding to expectation values (mainly extracting the data from 'exp_data' folder and integrating them into the plot files)


The `demo` folder has further instructions that reproduces a minimal example of files required to execute the toolchain on a HPC cluster while collecting the profiling data.

# Zenodo repository

The container images used to generate the benchmarks and their usage are shared at the Zenodo repository: https://zenodo.org/records/10376217