PurpleCaffeine: tracking of quantum programs and experiments
Project description
PurpleCaffeine: tracking of quantum programs and experiments
Tracking experiments and programs is known problem in scientific community. This project is aimed to create simple general interface to track quantum experiments, store and search them in an easy way.
Table of Contents
For Users
- Quickstart
- Source Code Installation
- Documentation
- Guides
- How to Give Feedback
- Contribution Guidelines
- References and Acknowledgements
- License
Quickstart
pip install purplecaffeine
from qiskit.circuit.random import random_circuit
from qiskit.quantum_info.random import random_pauli
from qiskit.primitives import Estimator
from purplecaffeine.core import Trial, LocalStorage
from purplecaffeine.widget import Widget
n_qubits = 4
depth = 3
shots = 2000
circuit = random_circuit(n_qubits, depth)
obs = random_pauli(n_qubits)
local_storage = LocalStorage("./")
with Trial("Example trial", storage=local_storage) as trial:
# track some parameters
trial.add_parameter("estimator", "qiskit.primitives.Estimator")
trial.add_parameter("depth", depth)
trial.add_parameter("n_qubits", n_qubits)
trial.add_parameter("shots", shots)
# track objects of interest
trial.add_circuit("circuit", circuit)
trial.add_operator("obs", obs)
# run
exp_value = Estimator().run(circuit, obs, shots=shots).result().values.item()
# track results of run
trial.add_metric("exp_value", exp_value)
Widget(local_storage).show()
Source Code Installation
If you want to install from source code, execute while in the root folder of the project:
cd client
pip install .
Documentation
Documentation for project is hosted at https://icekhan13.github.io/purplecaffeine/
How to Give Feedback
We encourage your feedback! You can share your thoughts with us by:
- Opening an issue in the repository
Contribution Guidelines
For information on how to contribute to this project, please take a look at our contribution guidelines.
References and Acknowledgements
[1] Qiskit is an open-source SDK for working with quantum computers at the level of circuits, algorithms, and application modules.
https://github.com/Qiskit/qiskit
License
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
Built Distribution
File details
Details for the file purplecaffeine-0.2.5.tar.gz
.
File metadata
- Download URL: purplecaffeine-0.2.5.tar.gz
- Upload date:
- Size: 16.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 961f438bd25b706af1fa3762d840441c15aa2ec2f1411f7f43fa6b7cd231dc3f |
|
MD5 | 1942e8a87e4eb97223ed6318ac141058 |
|
BLAKE2b-256 | 5174aa552d402134955ac5bc4f0725d00ea07b80b39cb3e6148f7887b6109614 |
File details
Details for the file purplecaffeine-0.2.5-py3-none-any.whl
.
File metadata
- Download URL: purplecaffeine-0.2.5-py3-none-any.whl
- Upload date:
- Size: 18.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3add606e1ac0b4ec63a7bd5f14d8c6232a00526591059706bab26fb0625028a8 |
|
MD5 | 2f42afd3cdc537ccc8f17796c57cbdb1 |
|
BLAKE2b-256 | e114a5247882273ff5f5c062004438493f5c6f62fa96abe4564e5c94f6c2ec8f |