altaris/qiskit-benchmark

A simple qiskit benchmark that runs random circuits

qiskit-benchmark

A simple qiskit benchmark that runs random circuits and measures the time taken. Produces a CSV file and pretty heatmap plots.

Dependencies

• python3.10 or newer;
• python packages listed requirements.txt

Usage

python3.10 -m qiskit_benchmark output/dir/path [options...]

Run python3.10 -m qiskit_benchmark --help to see the list of available options.

Contributing

Dependencies

• python3.10 or newer;
• requirements.txt for runtime dependencies;
• requirements.dev.txt for development dependencies.
• make (optional);

Simply run

virtualenv venv -p python3.10
. ./venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt
pip install -r requirements.dev.txt

Documentation

Simply run

make docs

This will generate the HTML doc of the project, and the index file should be at docs/index.html. To have it directly in your browser, run

make docs-browser

Code quality

Don't forget to run

make

to format the code following black, typecheck it using mypy, and check it against coding standards using pylint.