search

Qiskit / red-queen

Quantum software benchmarking tool
Apache License 2.0
18 stars 15 forks source link

Improve Documentation for Red Queen #42

Open Lementknight opened 2 years ago

Lementknight commented 2 years ago

Red Queen has many nuances that should be properly documented so that fellow open sources developers have an easier time both developing for Red Queen and using it.

-Add documentation to explain how to add new benchmarks

-Add guidance on how to use virtual environments in the README.md

-Update README.md to reflect its transition to a python package [#27 Addresses This]

-Add Docstrings to files

-Add description of quantum circuit each benchmark uses

shraddha-aangiras commented 1 year ago

As a part of QAMP Fall '22 I'd like to work on this issue @mtreinish