PurpleCaffeine

PurpleCaffeine: tracking of quantum programs and experiments - Published in JOSS (2023)

https://github.com/icekhan13/purplecaffeine

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 4 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org
✓
Committers with academic emails
1 of 7 committers (14.3%) from academic institutions
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

experiments qiskit quantum-computing tracking

Keywords from Contributors

mesh

Scientific Fields

Computer Science Computer Science - 84% confidence

Last synced: 6 months ago · JSON representation ·

Repository

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

Basic Info

Host: GitHub
Owner: IceKhan13
License: apache-2.0
Language: Python
Default Branch: main
Homepage: https://icekhan13.github.io/purplecaffeine/
Size: 4.19 MB

Statistics

Stars: 6
Watchers: 3
Forks: 3
Open Issues: 5
Releases: 8

Topics

experiments qiskit quantum-computing tracking

Created almost 3 years ago · Last pushed 6 months ago

Metadata Files

Readme Contributing License Code of conduct Citation

PurpleCaffeine: tracking of quantum programs and experiments

Logo

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.

Quickstart

shell pip install purplecaffeine

```python from qiskit.circuit.random import randomcircuit from qiskit.quantuminfo.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 = randomcircuit(nqubits, depth) obs = randompauli(nqubits)

local_storage = LocalStorage("./trials")

with Trial("Example trial", storage=localstorage) as trial: # track some parameters trial.addparameter("estimator", "qiskit.primitives.Estimator") trial.addparameter("depth", depth) trial.addparameter("nqubits", nqubits) 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

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

Apache License 2.0

Owner

Name: Iskandar Sitdikov
Login: IceKhan13
Kind: user
Location: New York
Company: IBM

Website: https://www.linkedin.com/in/icekhan/
Repositories: 5
Profile: https://github.com/IceKhan13

all @Qiskit things at @IBM Quantum

JOSS Publication

PurpleCaffeine: tracking of quantum programs and experiments

Published

October 03, 2023

DOI

10.21105/joss.05673

Volume 8, Issue 90, Page 5673

Authors

Iskandar Sitdikov

IBM Quantum, T.J. Watson Research Center, Yorktown Heights, NY 10598, USA

Michaël Rollin

Shape-IT, France

Ansah Mohammad Kuriyodath

Sardar Vallabhbhai National Institute of Technology, Surat, India

Luis Eduardo Martínez Hérnandez

Netcracker, Mexico

Editor

Lucy Whalley

Citation (CITATION.cff)

cff-version: 1.1.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: "Sitdikov"
    given-names: "Iskandar"
    orcid: https://orcid.org/0000-0002-6809-8943
  - family-names: "Rollin"
    given-names: "Michaël"
    orcid: https://orcid.org/0000-0001-8619-8190
  - family-names: "Kuriyodath"
    given-names: "Ansah Mohammad" 
    orcid: https://orcid.org/0009-0005-5517-5363
  - family-names: "Hérnandez"
    given-names: "Luis Eduardo Martínez"
    orcid: https://orcid.org/0000-0003-0354-5092
title: "PurpleCaffeine: tracking of quantum programs and experiments"
version: v0.2.5
doi: 10.5281/zenodo.8357490
date-released: 2023-09-19
url: "https://github.com/IceKhan13/purplecaffeine"

GitHub Events

Total

Delete event: 21
Issue comment event: 19
Push event: 37
Pull request event: 38
Pull request review event: 10
Create event: 19

Last Year

Delete event: 21
Issue comment event: 19
Push event: 37
Pull request event: 38
Pull request review event: 10
Create event: 19

Committers

Last synced: 7 months ago

All Time

Total Commits: 113
Total Committers: 7
Avg Commits per committer: 16.143
Development Distribution Score (DDS): 0.637

Past Year

Commits: 12
Committers: 1
Avg Commits per committer: 12.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
dependabot[bot]	4****]	41
Michaël	m**0@g**m	38
Iskandar Sitdikov	I****3	23
Ansah Mohammad	m**0@g**m	5
mentesniker	3****r	3
Lucy Whalley	l**y@n**k	2
Frank Harkins	f**s@h**k	1

Committer Domains (Top 20 + Academic)

hotmail.co.uk: 1 northumbria.ac.uk: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 45
Total pull requests: 94
Average time to close issues: 18 days
Average time to close pull requests: 19 days
Total issue authors: 2
Total pull request authors: 5
Average comments per issue: 1.33
Average comments per pull request: 1.04
Merged pull requests: 67
Bot issues: 0
Bot pull requests: 48

Past Year

Issues: 0
Pull requests: 34
Average time to close issues: N/A
Average time to close pull requests: 23 days
Issue authors: 0
Pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 0.65
Merged pull requests: 13
Bot issues: 0
Bot pull requests: 34

View more stats

Top Authors

Issue Authors

mickahell (23)
IceKhan13 (21)

Pull Request Authors

dependabot[bot] (72)
mickahell (19)
IceKhan13 (17)
AnsahMohammad (5)
mentesniker (2)
frankharkins (1)

Top Labels

Issue Labels

enhancement (35) documentation (10) good first issue (7) epic (3) bug (2) question (1) dependencies (1)

Pull Request Labels

dependencies (73) enhancement (22) documentation (10) python (10)

Packages

Total packages: 1
Total downloads:
- pypi 21 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 8
Total maintainers: 1

pypi.org: purplecaffeine

PurpleCaffeine: tracking of quantum programs and experiments

Documentation: https://purplecaffeine.readthedocs.io/
License: Apache Software License
Latest release: 0.2.5
published over 2 years ago

Versions: 8
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 21 Last month

Rankings

Dependent packages count: 7.3%

Average: 24.1%

Dependent repos count: 40.9%

Maintainers (1)

icekhan

Last synced: 6 months ago

Dependencies

.github/workflows/api_server-dockerhub-release.yml actions

actions/checkout v2 composite
peter-evans/dockerhub-description v3 composite

.github/workflows/client-pypi-release.yml actions

actions/checkout v3 composite
actions/setup-python v2 composite
actions/upload-artifact v2 composite

.github/workflows/docs.yml actions

actions/checkout v3 composite
actions/setup-python v2 composite
peaceiris/actions-gh-pages v3 composite

.github/workflows/draft-pdf.yml actions

actions/checkout v3 composite
actions/upload-artifact v1 composite
openjournals/openjournals-draft-action master composite

.github/workflows/ecosystem.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

.github/workflows/guides-tests.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

.github/workflows/lint.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

.github/workflows/release-drafter.yml actions

release-drafter/release-drafter v5 composite

.github/workflows/tests.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
postgres * docker

api_server/docker/Dockerfile docker

ubuntu 22.04 build

docker-compose.yml docker

postgres latest
purplecaffeine latest

api_server/requirements.txt pypi

Django ==4.2.5
django-health-check ==3.17.0
django-nose ==1.4.7
djangorestframework ==3.14.0
djangorestframework-simplejwt ==5.3.0
drf-spectacular ==0.26.5
gunicorn ==21.2.0
psycopg2-binary ==2.9.7
tzdata ==2023.3
whitenoise ==6.5.0

client/requirements.txt pypi

boto3 >=1.26.133
ipywidgets >=8.0.7
matplotlib >=3.7.1
pandas >=2.0.2
pylatexenc >=2.10
pympler *
qiskit >=0.43.0
qiskit-ibm-runtime >=0.10.0

client/setup.py pypi

docs/requirements-doc.txt pypi

black *
boto3 ==1.26.133
coverage >=5.5
ipywidgets ==8.0.6
jupyter-sphinx >=0.3.2
matplotlib ==3.7.1
mypy >=0.780
mypy-extensions >=0.4.3
nbqa >=1.1.1
nbsphinx >=0.8.8
pandas ==2.0.2
pylatexenc ==2.10
pylint >=2.9.5
pympler *
pytest >=6.2.5
pytest-randomly >=1.2.0
qiskit-ibm-runtime ==0.9.3
qiskit-sphinx-theme *
qiskit-terra >=0.21.1
reno >=3.5.0
sphinx-autodoc-typehints >=1.17.0
sphinx-copybutton >=0.5.0
treon >=0.1.3

requirements-dev.txt pypi

black ==22.3.0 development
coverage ==5.5 development
jupyter ==1.0.0 development
nbconvert ==7.4.0 development
nbformat ==5.8.0 development
pillow ==9.5.0 development
pylint ==2.17.2 development
pytest ==6.2.4 development
qiskit_optimization ==0.5.0 development
testcontainers ==3.7.1 development
tox ==3.24.0 development

setup.py pypi

PurpleCaffeine

Science Score: 100.0%

Keywords

Keywords from Contributors

Scientific Fields

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

PurpleCaffeine: tracking of quantum programs and experiments

Table of Contents

For Users

Quickstart

Documentation

How to Give Feedback

Contribution Guidelines

References and Acknowledgements

License

Owner

JOSS Publication

PurpleCaffeine: tracking of quantum programs and experiments

Authors

Editor

Tags

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: purplecaffeine

Rankings

Maintainers (1)

Dependencies