| Name | purplecaffeine JSON |
| Version |
0.2.5
JSON |
| download |
| home_page | |
| Summary | PurpleCaffeine: tracking of quantum programs and experiments |
| upload_time | 2023-09-19 01:08:02 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | |
| keywords |
quantum
tracking
experiments
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
PurpleCaffeine: tracking of quantum programs and experiments
============================================================
[](https://www.python.org/)
[](https://github.com/Qiskit/qiskit)
[](https://github.com/IceKhan13/purplecaffeine/blob/main/LICENSE)
[](https://github.com/psf/black)
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
1. [Quickstart](#quickstart)
2. [Source Code Installation](#source-code-installation)
3. [Documentation](#documentation)
4. [Guides](https://github.com/IceKhan13/purplecaffeine/tree/main/docs/guides)
5. [How to Give Feedback](#how-to-give-feedback)
6. [Contribution Guidelines](#contribution-guidelines)
7. [References and Acknowledgements](#references-and-acknowledgements)
8. [License](#license)
----------------------------------------------------------------------------------------------------
### Quickstart
```shell
pip install purplecaffeine
```
```python
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:
```shell
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](https://github.com/IceKhan13/purplecaffeine/issues) in the repository
----------------------------------------------------------------------------------------------------
### Contribution Guidelines
For information on how to contribute to this project, please take a look at our [contribution guidelines](https://github.com/IceKhan13/purplecaffeine/blob/main/CONTRIBUTING.md).
----------------------------------------------------------------------------------------------------
## 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
[Apache License 2.0](LICENSE)
Raw data
{
"_id": null,
"home_page": "",
"name": "purplecaffeine",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "quantum tracking experiments",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/51/74/aa552d402134955ac5bc4f0725d00ea07b80b39cb3e6148f7887b6109614/purplecaffeine-0.2.5.tar.gz",
"platform": null,
"description": "PurpleCaffeine: tracking of quantum programs and experiments\n============================================================\n\n\n[](https://www.python.org/)\n[](https://github.com/Qiskit/qiskit)\n[](https://github.com/IceKhan13/purplecaffeine/blob/main/LICENSE)\n[](https://github.com/psf/black)\n\n\n\nTracking experiments and programs is known problem in scientific community.\nThis project is aimed to create simple general interface to track quantum experiments, store and search them in an easy way.\n\n### Table of Contents\n\n##### For Users\n\n1. [Quickstart](#quickstart)\n2. [Source Code Installation](#source-code-installation)\n3. [Documentation](#documentation)\n4. [Guides](https://github.com/IceKhan13/purplecaffeine/tree/main/docs/guides)\n5. [How to Give Feedback](#how-to-give-feedback)\n6. [Contribution Guidelines](#contribution-guidelines)\n7. [References and Acknowledgements](#references-and-acknowledgements)\n8. [License](#license)\n\n\n----------------------------------------------------------------------------------------------------\n\n### Quickstart\n\n```shell\npip install purplecaffeine\n```\n\n\n```python\nfrom qiskit.circuit.random import random_circuit\nfrom qiskit.quantum_info.random import random_pauli\nfrom qiskit.primitives import Estimator\n\nfrom purplecaffeine.core import Trial, LocalStorage\nfrom purplecaffeine.widget import Widget\n\nn_qubits = 4\ndepth = 3\nshots = 2000\n\ncircuit = random_circuit(n_qubits, depth)\nobs = random_pauli(n_qubits)\n\nlocal_storage = LocalStorage(\"./\")\n\nwith Trial(\"Example trial\", storage=local_storage) as trial:\n # track some parameters\n trial.add_parameter(\"estimator\", \"qiskit.primitives.Estimator\")\n trial.add_parameter(\"depth\", depth)\n trial.add_parameter(\"n_qubits\", n_qubits)\n trial.add_parameter(\"shots\", shots)\n \n # track objects of interest\n trial.add_circuit(\"circuit\", circuit)\n trial.add_operator(\"obs\", obs)\n\n # run\n exp_value = Estimator().run(circuit, obs, shots=shots).result().values.item()\n \n # track results of run\n trial.add_metric(\"exp_value\", exp_value)\n\nWidget(local_storage).show()\n```\n\n\n----------------------------------------------------------------------------------------------------\n\n### Source Code Installation\n\n\nIf you want to install from source code, execute while in the root folder of the project:\n\n```shell\ncd client\npip install .\n```\n\n----------------------------------------------------------------------------------------------------\n\n### Documentation\n\nDocumentation for project is hosted at https://icekhan13.github.io/purplecaffeine/\n\n----------------------------------------------------------------------------------------------------\n\n### How to Give Feedback\n\nWe encourage your feedback! You can share your thoughts with us by:\n- [Opening an issue](https://github.com/IceKhan13/purplecaffeine/issues) in the repository\n\n\n----------------------------------------------------------------------------------------------------\n\n### Contribution Guidelines\n\nFor information on how to contribute to this project, please take a look at our [contribution guidelines](https://github.com/IceKhan13/purplecaffeine/blob/main/CONTRIBUTING.md).\n\n\n----------------------------------------------------------------------------------------------------\n\n## References and Acknowledgements\n[1] Qiskit is an open-source SDK for working with quantum computers at the level of circuits, algorithms, and application modules. \\\n https://github.com/Qiskit/qiskit\n\n\n----------------------------------------------------------------------------------------------------\n\n### License\n[Apache License 2.0](LICENSE)\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "PurpleCaffeine: tracking of quantum programs and experiments",
"version": "0.2.5",
"project_urls": null,
"split_keywords": [
"quantum",
"tracking",
"experiments"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e114a5247882273ff5f5c062004438493f5c6f62fa96abe4564e5c94f6c2ec8f",
"md5": "2f42afd3cdc537ccc8f17796c57cbdb1",
"sha256": "3add606e1ac0b4ec63a7bd5f14d8c6232a00526591059706bab26fb0625028a8"
},
"downloads": -1,
"filename": "purplecaffeine-0.2.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2f42afd3cdc537ccc8f17796c57cbdb1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 18595,
"upload_time": "2023-09-19T01:08:00",
"upload_time_iso_8601": "2023-09-19T01:08:00.983097Z",
"url": "https://files.pythonhosted.org/packages/e1/14/a5247882273ff5f5c062004438493f5c6f62fa96abe4564e5c94f6c2ec8f/purplecaffeine-0.2.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5174aa552d402134955ac5bc4f0725d00ea07b80b39cb3e6148f7887b6109614",
"md5": "1942e8a87e4eb97223ed6318ac141058",
"sha256": "961f438bd25b706af1fa3762d840441c15aa2ec2f1411f7f43fa6b7cd231dc3f"
},
"downloads": -1,
"filename": "purplecaffeine-0.2.5.tar.gz",
"has_sig": false,
"md5_digest": "1942e8a87e4eb97223ed6318ac141058",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 16713,
"upload_time": "2023-09-19T01:08:02",
"upload_time_iso_8601": "2023-09-19T01:08:02.224901Z",
"url": "https://files.pythonhosted.org/packages/51/74/aa552d402134955ac5bc4f0725d00ea07b80b39cb3e6148f7887b6109614/purplecaffeine-0.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-19 01:08:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "purplecaffeine"
}
