Skip to content

Commit b0c65a6

Browse files
committed
Add Zenodo DOI, report generation pipeline, and update version metadata to 0.4.0
1 parent f9c37bf commit b0c65a6

10 files changed

Lines changed: 1636 additions & 9 deletions

File tree

.github/workflows/publish-pypi.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,46 @@ jobs:
103103
generate_release_notes: true
104104
draft: false
105105
prerelease: ${{ contains(github.ref, 'rc') || contains(github.ref, 'beta') || contains(github.ref, 'alpha') }}
106+
107+
# ── Job 4: Update Version Metadata ────────────────────────────
108+
# After a release is published, update CITATION.cff and README.md
109+
# on master so they always reflect the latest released version.
110+
# Uses GITHUB_TOKEN which intentionally does not trigger other
111+
# workflows, preventing infinite loops.
112+
update-metadata:
113+
name: Update Version Metadata
114+
needs: github-release
115+
runs-on: ubuntu-latest
116+
if: ${{ !contains(github.ref, 'rc') && !contains(github.ref, 'beta') && !contains(github.ref, 'alpha') }}
117+
118+
steps:
119+
- name: Checkout master
120+
uses: actions/checkout@v4
121+
with:
122+
ref: master
123+
124+
- name: Extract version and date
125+
id: meta
126+
run: |
127+
VERSION="${GITHUB_REF#refs/tags/v}"
128+
DATE="$(date -u +%Y-%m-%d)"
129+
echo "version=${VERSION}" >> "${GITHUB_OUTPUT}"
130+
echo "date=${DATE}" >> "${GITHUB_OUTPUT}"
131+
132+
- name: Update CITATION.cff
133+
run: |
134+
sed -i 's/^version: ".*"/version: "${{ steps.meta.outputs.version }}"/' CITATION.cff
135+
sed -i 's/^date-released: ".*"/date-released: "${{ steps.meta.outputs.date }}"/' CITATION.cff
136+
137+
- name: Update README.md bibtex version
138+
run: |
139+
sed -i 's/version={[^}]*}/version={${{ steps.meta.outputs.version }}}/' README.md
140+
141+
- name: Commit and push if changed
142+
run: |
143+
git diff --quiet && exit 0
144+
git config user.name "Ashutosh Mishra"
145+
git config user.email "ashutoshm1771@gmail.com"
146+
git add CITATION.cff README.md
147+
git commit -m "chore: update version metadata to ${{ steps.meta.outputs.version }}"
148+
git push origin master

CITATION.cff

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@ cff-version: 1.2.0
22
title: "Quantum Encoding Atlas"
33
message: "If you use this software, please cite it as below."
44
type: software
5+
doi: "10.5281/zenodo.18780936"
56
authors:
67
- family-names: "Mishra"
78
given-names: "Ashutosh"
89
email: "ashutoshm1771@gmail.com"
910
repository-code: "https://github.com/encoding-atlas/quantum-encoding-atlas"
10-
url: "https://q-encoding-atlas.web.app/documentation"
11+
url: "https://encoding-atlas.github.io/quantum-encoding-atlas"
1112
license: MIT
12-
version: "0.1.0"
13-
date-released: "2026-01-24"
13+
version: "0.4.0"
14+
date-released: "2026-02-26"
1415
keywords:
1516
- quantum computing
1617
- quantum machine learning
@@ -21,6 +22,6 @@ keywords:
2122
- cirq
2223
abstract: >-
2324
A comprehensive Python library for quantum data encodings
24-
in machine learning, featuring 15+ encoding methods,
25+
in machine learning, featuring 16 encoding methods,
2526
multi-framework support (PennyLane, Qiskit, Cirq),
2627
analysis tools, and practical guidance for encoding selection.

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
[![CI](https://img.shields.io/github/actions/workflow/status/encoding-atlas/quantum-encoding-atlas/ci.yml?branch=master&logo=github&label=CI)](https://github.com/encoding-atlas/quantum-encoding-atlas/actions/workflows/ci.yml)
1111
[![codecov](https://codecov.io/gh/encoding-atlas/quantum-encoding-atlas/branch/master/graph/badge.svg)](https://codecov.io/gh/encoding-atlas/quantum-encoding-atlas)
1212
[![Documentation](https://img.shields.io/badge/docs-online-blue.svg)](https://encoding-atlas.github.io/quantum-encoding-atlas/)
13+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.18780936.svg)](https://doi.org/10.5281/zenodo.18780936)
1314
[![Website](https://img.shields.io/badge/Website-live-brightgreen?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAHFUlEQVR42sWX309UVxDHzwMvhTdeVEB+gyoCqsgqP0VERWRhkd8sgg9S66tNbKKNNjaxVhNr/wVl0RqjiU3UJ0iMtdFoY2MTAVVBZX1eLFn1Yfqd2z2ey9y9uCqrk3zynTMz58wc9sdd1HxY6sKFiaAJnEhZsCAAHYGOQV9FGMN6BBrgmkhtovqStjglJRlD7EpbtOgSmElLSSEoaWWQZ3Vjhveivh8kf87Bk8D3YDo9NZU0WNt9jY5J7HnWEPQgSFLxsoy0tATwNQhmLF5MGqwNZi18U5sO3PaAKTDAvdR8WlZ6ehq4nZmeTlCLTDTWa6H2GnutxuRdzuFeIHV+hs/I8GRnZAQBvSMzU6tB5LJAjoyLmK5zOSMIPOpTLCcry5+blRWGEgOf4SGgOiZyGtRYdWKfrhUxjazh3n71MZabne3Py84mJj8nh9UJ4rnGd+RztRrfici59PmwS+Tn5nowdBhKS2zkxwjXYr+Mc0zmzLmij9gfBrG9nZbm5aWB4JK8PGKWMvn5Bo6bnF5zDmp8YGrkPnGuPEPHxQxT0Lk/2MuWLEkAtwG5sVzG0Eiu13s8NBQI0KNHjywCZ86QZ+1azukzpG9w78v5W8D9K7Zg2bKBgqVLabmgwGCtUafjDi1fv55eBoMk7fnz53wJud8JchaiP1Tv3a2i2Yrly5NAENA7cBCrROYLbevfzp0jNztz+jTX6T3CF7j3nOJZlbSiFSsOFhYUENQCPiN9vXbViadPyc3Gx8bIpYeMy56y5oCyW3FhYTKYLkZyZVERwZ8N4jLmVjsxMeF+gfHxWM61qxsh5M0PwFVFRbtWFRcT4KEY45s1Y3wGvkbXnT9/ntwsMDio66KdZXKin0bU9Sttq1euvARoPqiprqaXL1+StBcvXlB1ZaWu42E+tddFxVayenXimlWrZqAEtWDfYOLMutJS1jlra2tqrFfiyZMn1tfoubNn+WL2Gq12rG8pnZPzSAUzIFGtXbOmCZCGk6xusccYKBQK0ZPHj+mPGzfol5MnqbWlJfqekhLXs9paW+nXU6foz5s3rYtOT0/TgwcPRL/34lWlJSUnANnhv4RWxh7jwaMZD/HD4cPWK6Rr9b61EZ8fcD8eOeL6QR8dHXWdgYky53HlKS0NWE0B9L3woHPZU+S/3bfPse+7/ftpcnKSpMkLiFmMHz02qPBXGSlbt47WR8Da7suYuIC78fu+qqKCqvDBvXDhAsViY3hOlEX6WSpAXKNjwwqP/jFATJmNcgEOZI35Amx/37tH/9y/z27MF9C9jZre5WVlOq5zo6qirOxVRXk5QbnAUmstfSjDb5F4GS7gnEGsBdMKL/GryshLXWVT7Vs5oPUpfirEy/inRqXoy8jZKhlcCDqtqquqxqqR2FBVRazVRiUcj+8Fxsd5DjOD9J2Mqg3V1SP8kKnZsIHgA/gGs0YeGv8L6J7op9XMAZ3NsNpYUxMA9A5sqBVru07E9wKmr5wh+kyDqnbjxhOANtXWEquE44z2+SEUL3v48KHuY1eDM3Zc1W3a1FSHIANfw4WsknhfQM8RK161ua4uEcwAcmPL5s3aj/sF0Mutt+Rf8JViQ9GlrVu2kAZr4RudjOMFHuEC6BErF5W2+q1bdwGqr68nVok99/OxYzQ0NERXr16lv+7epdevX9PHWjgcpjt37lhnBQIB+uno0Vk9t9nngQ84pmcx/9AgmNywbVsIEIM1q4TjjrWvuZkOHzpE165dozdv3tD7jC985coVOoQ92OvswzQ0yJgkBJKV3bY3NBwExDRu3y7V+ELt9Pf1WcO9ffuWpHHs98uXaefOnXKfOcv0kufL+gNKmrexMQlMAdI0sgqwmXVO9u7dS8+ePSNt/PD7Zs8eeQ4jesXEFEhS0azJ6x1obmqipgjsM4hHx9RG1qa+o6ODrl+/TsPDw9Te3m4/S57piHtBRM2ZZv9u5WbNzc0J4Da/N6EENfh8llqDsIoaWafP4Hp5nn2NvDNn8pJbPKOay1p8vtSWlpYgIAZr2hFRhmPW2mDyZo9zDfWxGnifY49P1PpM/ymQqmKxHTt2eEAYENMKovoCkZdrZ4wvL8+IXs+zlKoPsdbWVn9bWxtpsP7fh+q19pl2Wy7KvrmRe8XZwK8+xvDh84NwBz6E7S50COWL8AfYwlnLebsPdT8XZ4Th96hPsc7OTk9nR0cQag3VCeAz2jfw0DomlTFnSGSca6egpWo+rLurK7Wrq+s2IDvdrBJZw9jX3d3u+0ztLZCq5tPQOAEM9PT0BAH1YBCt2rchYnPnus0ZU9Dd0AQVL/P7/Un+np6D0BAgpre3l9XgjL0vHwIHQJL6XLaztzcZv2v6wUX4MzwQlFgRszM7pn3sieztgyarL2n9/f2JfX19Xuhx6CAYBqNgmmGfY5Ec13hB4nz0/g83250Vq34algAAAABJRU5ErkJggg==)](https://q-encoding-atlas.web.app)
1415

1516
[Documentation](https://encoding-atlas.github.io/quantum-encoding-atlas/) |
@@ -120,8 +121,9 @@ If you use this library in your research, please cite:
120121
title={Quantum Encoding Atlas: A Comprehensive Library for Quantum Data Encodings},
121122
author={Mishra, Ashutosh},
122123
year={2026},
123-
url={https://github.com/encoding-atlas/quantum-encoding-atlas},
124-
version={0.1.0}
124+
doi={10.5281/zenodo.18780936},
125+
url={https://doi.org/10.5281/zenodo.18780936},
126+
version={0.4.0}
125127
}
126128
```
127129

experiments/config.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@
7070
"vqc",
7171
"kernel",
7272
"tradeoff",
73+
"report",
7374
})
7475

7576
VALID_BACKENDS = frozenset({"pennylane", "qiskit", "cirq"})
@@ -88,6 +89,7 @@
8889
"vqc": 6, # Stage 6a → seed 6042
8990
"kernel": 7, # Stage 6b → seed 7042
9091
"tradeoff": 8, # Stage 7 → seed 8042
92+
"report": 9, # Stage 8 → seed 9042
9193
}
9294

9395
# Quick-mode overrides reduce sample counts for fast validation.
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"stage": "report",
3+
"seed": 42,
4+
"backend": "pennylane",
5+
"encodings": [
6+
{
7+
"name": "__report__",
8+
"params": {}
9+
}
10+
],
11+
"analysis_params": {
12+
"stage_dirs": {
13+
"resources": "experiments/results/raw/stage1_resources",
14+
"simulability": "experiments/results/raw/stage2_simulability",
15+
"expressibility": "experiments/results/raw/stage3_expressibility",
16+
"entanglement": "experiments/results/raw/stage4_entanglement",
17+
"trainability": "experiments/results/raw/stage5_trainability",
18+
"noise": "experiments/results/raw/stage5b_noise",
19+
"vqc": "experiments/results/raw/stage6a_vqc",
20+
"kernel": "experiments/results/raw/stage6b_kernel"
21+
},
22+
"tradeoff_dir": "experiments/results/raw/stage7_tradeoff",
23+
"sensitivity_dir": "experiments/results/raw/stage6a5_sensitivity",
24+
"figure_dir": "experiments/results/figures",
25+
"table_dir": "experiments/results/tables",
26+
"generate_tables": true
27+
},
28+
"output_dir": "experiments/results/report"
29+
}

0 commit comments

Comments
 (0)