{"id":19246448,"url":"https://github.com/icekhan13/purplecaffeine","last_synced_at":"2025-04-21T11:32:53.254Z","repository":{"id":156395455,"uuid":"607722575","full_name":"IceKhan13/purplecaffeine","owner":"IceKhan13","description":"Project is aimed to create simple general interface to track quantum experiments, store and search them in an easy way.","archived":false,"fork":false,"pushed_at":"2025-04-07T02:07:12.000Z","size":4394,"stargazers_count":6,"open_issues_count":4,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-14T13:49:24.095Z","etag":null,"topics":["experiments","qiskit","quantum-computing","tracking"],"latest_commit_sha":null,"homepage":"https://icekhan13.github.io/purplecaffeine/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IceKhan13.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-02-28T14:50:46.000Z","updated_at":"2025-04-01T09:00:49.000Z","dependencies_parsed_at":"2024-03-18T21:35:06.749Z","dependency_job_id":"f62caa2c-2d00-409e-85c8-3c45b9317ab3","html_url":"https://github.com/IceKhan13/purplecaffeine","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IceKhan13%2Fpurplecaffeine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IceKhan13%2Fpurplecaffeine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IceKhan13%2Fpurplecaffeine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IceKhan13%2Fpurplecaffeine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IceKhan13","download_url":"https://codeload.github.com/IceKhan13/purplecaffeine/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250048062,"owners_count":21366168,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["experiments","qiskit","quantum-computing","tracking"],"created_at":"2024-11-09T17:32:10.273Z","updated_at":"2025-04-21T11:32:51.621Z","avatar_url":"https://github.com/IceKhan13.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"PurpleCaffeine: tracking of quantum programs and experiments\n============================================================\n\n[![DOI](https://joss.theoj.org/papers/10.21105/joss.05673/status.svg)](https://doi.org/10.21105/joss.05673)\n![Platform](https://img.shields.io/badge/Platform-Linux%20%7C%20macOS%20%7C%20Windows-informational)\n[![Python](https://img.shields.io/badge/Python-3.8%20%7C%203.9%20%7C%203.10-informational)](https://www.python.org/)\n[![Qiskit](https://img.shields.io/badge/Qiskit-%E2%89%A5%201.0.0-6133BD)](https://github.com/Qiskit/qiskit)\n[![Ecosystem](https://raw.githubusercontent.com/qiskit-community/ecosystem/main/badges/PurpleCaffeine.svg)](https://qiskit.org/ecosystem)\n[![License](https://img.shields.io/github/license/qiskit-community/quantum-prototype-template?label=License)](https://github.com/IceKhan13/purplecaffeine/blob/main/LICENSE)\n[![Code style: Black](https://img.shields.io/badge/Code%20style-Black-000.svg)](https://github.com/psf/black)\n\n![Logo](./docs/images/readme_logo.png)\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. [Documentation](#documentation)\n3. [Guides](docs/guides)\n4. [How to Give Feedback](#how-to-give-feedback)\n5. [Contribution Guidelines](#contribution-guidelines)\n6. [References and Acknowledgements](#references-and-acknowledgements)\n7. [License](#license)\n\n\n----------------------------------------------------------------------------------------------------\n\n### Quickstart\n\n```shell\npip install purplecaffeine\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(\"./trials\")\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![visualization](./docs/images/visualization.png)\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](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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficekhan13%2Fpurplecaffeine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ficekhan13%2Fpurplecaffeine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficekhan13%2Fpurplecaffeine/lists"}