https://github.com/altaris/qiskit-benchmark

A simple qiskit benchmark that runs random circuits
https://github.com/altaris/qiskit-benchmark

Last synced: about 1 month ago
JSON representation

A simple qiskit benchmark that runs random circuits

• Host: GitHub
• URL: https://github.com/altaris/qiskit-benchmark
• Owner: altaris
• License: mit
• Created: 2024-04-02T02:23:23.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2024-04-04T01:54:16.000Z (9 months ago)
• Last Synced: 2024-04-04T10:05:38.966Z (9 months ago)
• Language: Python
• Size: 21.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# qiskit-benchmark

![Python 3](https://img.shields.io/badge/python-3-blue?logo=python)

[![License](https://img.shields.io/badge/license-MIT-green)](https://choosealicense.com/licenses/mit/)

[![Code style](https://img.shields.io/badge/style-black-black)](https://pypi.org/project/black)

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

```sh

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

```sh

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

```sh

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

```sh

make docs-browser

```

### Code quality

Don't forget to run

```sh

make

```

to format the code following [black](https://pypi.org/project/black/),

typecheck it using [mypy](http://mypy-lang.org/), and check it against coding

standards using [pylint](https://pylint.org/).