Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/IceKhan13/purplecaffeine

Project is aimed to create simple general interface to track quantum experiments, store and search them in an easy way.
https://github.com/IceKhan13/purplecaffeine

experiments qiskit quantum-computing tracking

Last synced: 17 days ago
JSON representation

Project is aimed to create simple general interface to track quantum experiments, store and search them in an easy way.

Host: GitHub
URL: https://github.com/IceKhan13/purplecaffeine
Owner: IceKhan13
License: apache-2.0
Created: 2023-02-28T14:50:46.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-05-14T18:36:56.000Z (about 2 months ago)
Last Synced: 2024-05-15T14:56:29.451Z (about 2 months ago)
Topics: experiments, qiskit, quantum-computing, tracking
Language: Python
Homepage: https://icekhan13.github.io/purplecaffeine/
Size: 3.97 MB
Stars: 7
Watchers: 2
Forks: 3
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff

Lists

awesome-qiskit - PurpleCaffeine - Project is aimed to create simple general interface to track quantum experiments, store and search them in an easy way. (Community)

README

        PurpleCaffeine: tracking of quantum programs and experiments

============================================================

[![DOI](https://joss.theoj.org/papers/10.21105/joss.05673/status.svg)](https://doi.org/10.21105/joss.05673)

![Platform](https://img.shields.io/badge/Platform-Linux%20%7C%20macOS%20%7C%20Windows-informational)

[![Python](https://img.shields.io/badge/Python-3.8%20%7C%203.9%20%7C%203.10-informational)](https://www.python.org/)

[![Qiskit](https://img.shields.io/badge/Qiskit-%E2%89%A5%201.0.0-6133BD)](https://github.com/Qiskit/qiskit)

[![Ecosystem](https://raw.githubusercontent.com/qiskit-community/ecosystem/main/badges/PurpleCaffeine.svg)](https://qiskit.org/ecosystem)

[![License](https://img.shields.io/github/license/qiskit-community/quantum-prototype-template?label=License)](https://github.com/IceKhan13/purplecaffeine/blob/main/LICENSE)

[![Code style: Black](https://img.shields.io/badge/Code%20style-Black-000.svg)](https://github.com/psf/black)

![Logo](./docs/images/readme_logo.png)

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. [Documentation](#documentation)

3. [Guides](docs/guides)

4. [How to Give Feedback](#how-to-give-feedback)

5. [Contribution Guidelines](#contribution-guidelines)

6. [References and Acknowledgements](#references-and-acknowledgements)

7. [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("./trials")

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()

```

![visualization](./docs/images/visualization.png)

----------------------------------------------------------------------------------------------------

### 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](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)