QCVV and Benchmarking
Project description
# Forest Benchmarking
[![pipeline status](https://gitlab.com/rigetti/forest-benchmarking/badges/master/pipeline.svg)](https://gitlab.com/rigetti/forest-benchmarking/commits/master) [![Build Status](https://semaphoreci.com/api/v1/rigetti/forest-benchmarking/branches/master/shields_badge.svg)](https://semaphoreci.com/rigetti/forest-benchmarking)
A library for quantum characterization, verification, validation (QCVV), and benchmarking using [pyQuil](https://github.com/rigetti/pyquil).
## Installation
forest-benchmarking can be installed from source or via the Python package manager PyPI.
Note: NumPy and SciPy must be pre-installed for installation to be successful, due to cvxpy.
### Source
`bash git clone https://github.com/rigetti/forest-benchmarking.git cd forest-benchmarking/ pip install numpy scipy pip install -e . `
### PyPI
`bash pip install numpy scipy pip install forest-benchmarking `
## Library Philosophy
The core philosophy of forest-benchmarking is to separate:
Experiment design and or generation
Data collection
Data analysis
Data visualisation
We ask that code contributed to this repository respect this separation. We also ask that an example of how to use your contributed code is placed in the /examples/ directory along with the standard documentation found in /docs/.
## Testing
The unit tests can be run locally using pytest, but beware that the test dependencies must be installed beforehand using pip install -r requirements.txt.
## Disclaimer
This package is currently in alpha (v0.x), and therefore you should not expect that APIs will necessarily be stable between releases. Code that depends on this package in its current state is very likely to break when the package version changes, so we encourage you to pin the version you use, and update it consciously when necessary.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for forest-benchmarking-0.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc000b7644da9c8b5438d26e29b0f754334c6551564c2f10090a45722a85bde7 |
|
MD5 | 370977ce33f3c725dd63eaa8aaed3de8 |
|
BLAKE2b-256 | 285157209758723363043087ad60fdfaeafbbc721bc1b74d824bd43c7085bc25 |