Skip to main content

Forest Benchmarking: QCVV using PyQuil

pypi version DOI slack workspace

A library for quantum characterization, verification, validation (QCVV), and benchmarking using 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

git clone https://github.com/rigetti/forest-benchmarking.git
cd forest-benchmarking/
pip install numpy scipy
pip install -e .

PyPI

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.

Citation

If you use Forest Benchmarking, please cite it via the BibTeX file.

Metadata

Release files for forest-benchmarking 0.9.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for forest-benchmarking 0.9.0
File Size Uploaded Provenance Actions
forest-benchmarking-0.9.0.tar.gz 140.9 kB Without provenance Details for forest-benchmarking-0.9.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for forest-benchmarking 0.9.0
File Interpreter ABI Platform Actions
forest_benchmarking-0.9.0-py3-none-any.whl Python 3 none any Details for forest_benchmarking-0.9.0-py3-none-any.whl

Total release size: 307.1 kB

Release files / forest-benchmarking-0.9.0.tar.gz

Download URL forest-benchmarking-0.9.0.tar.gz
Size 140.9 kB
Tags Source
SHA-256 checksum
How to use checksums
99aad84797ab133af5e4a6c52b3968acd7467968da62d9adb8528de96ea980de
BLAKE2b-256 checksum
How to use checksums
fb9e3fc4e63f86e9e1cc3c876017fd8aec99d667025c653c9ff3b9df5e92b510
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.8.15

Release files / forest_benchmarking-0.9.0-py3-none-any.whl

Download URL forest_benchmarking-0.9.0-py3-none-any.whl
Size 166.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e6f4ce73f9e1ec78c0c25eb5a7a94d8208fcc9fa7889236e6a01774bd794612e
BLAKE2b-256 checksum
How to use checksums
95495120b1baa7bf1512280fdfb798579aa4f23c2b2f4b7a8328981aed38d7d6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.8.15

Security for forest-benchmarking 0.9.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page