Skip to content

Commit 3d60a96

Browse files
committed
docs: refresh PyPI project metadata for v0.7.0
pyproject.toml [project.urls]: - Funding = github.com/sponsors/qectorlab (PyPI renders a dedicated funding icon for this exact key; renaming it loses the icon) - added Source, Commercial Licensing, Security - Documentation now points at docs/ rather than the repo root - normalised qector.store -> www.qector.store to match the README description: adds the v0.7.0 decoder families (weighted Union-Find, Relay-BP, colour-code, correlated two-stage, ambiguity clustering) and qiskit-qec compatibility. keywords: 16 -> 27, adding Sinter, qiskit, BP-OSD, Relay-BP, colour/color code, toric code, CUDA, syndrome decoding, fault tolerance. README: made the COMMERCIAL.md link absolute. The README is the PyPI long description and PyPI does not resolve repo-relative links, so it rendered as a dead link on the project page. All 17 trove classifiers validated; all funding/purchase URLs HTTP 200.
1 parent 8ca66ba commit 3d60a96

2 files changed

Lines changed: 15 additions & 8 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ and commercial licences are what keep the decoder maintained.
2020
| Channel | Who it's for |
2121
|---|---|
2222
| [GitHub Sponsors](https://github.com/sponsors/qectorlab) | Individuals and companies funding ongoing development |
23-
| [Commercial licence](https://www.qector.store/pricing) | Required for company, SaaS, OEM or funded institutional use — see [COMMERCIAL.md](COMMERCIAL.md) |
23+
| [Commercial licence](https://www.qector.store/pricing) | Required for company, SaaS, OEM or funded institutional use — see [COMMERCIAL.md](https://github.com/GuillaumeLessard/qector-decoder/blob/main/COMMERCIAL.md) |
2424
| [Direct purchase](https://buy.stripe.com/6oU00l77Xc8ifsegEqeUU07) | Immediate Stripe checkout, licence issued automatically |
2525
| [admin@qector.store](mailto:admin@qector.store) | Site licences, custom terms, academic partnerships |
2626

pyproject.toml

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ build-backend = "maturin"
55
[project]
66
name = "qector-decoder-v3"
77
version = "0.7.0"
8-
description = "Production-grade Rust/Python quantum error correction decoder. 25+ decoder families: MWPM Blossom, Union-Find, BP-OSD, LDPC/qLDPC, belief-matching, CUDA/GPU batch decoding, 7-tier AutoDecoder fallback. PyMatching/Stim/Sinter compatible. Ed25519 license verification."
8+
description = "Production-grade Rust/Python quantum error correction decoder. 25+ decoder families: MWPM Blossom, Union-Find (weighted), BP-OSD, Relay-BP for LDPC/qLDPC, belief-matching, colour-code, correlated two-stage matching, ambiguity clustering, CUDA/GPU batch decoding, 7-tier AutoDecoder fallback. PyMatching/Stim/Sinter/qiskit-qec compatible. Ed25519 license verification."
99
readme = "README.md"
1010
requires-python = ">=3.9"
1111
license = { text = "PolyForm-Noncommercial-1.0.0" }
1212
authors = [
1313
{name = "Guillaume Lessard / iD01t Productions", email = "admin@qector.store"}
1414
]
15-
keywords = ["quantum", "error correction", "decoder", "union-find", "QEC", "rust", "MWPM", "Stim", "PyMatching", "LDPC", "qLDPC", "blossom", "belief propagation", "GPU decoding", "surface code", "quantum computing"]
15+
keywords = ["quantum", "error correction", "decoder", "union-find", "QEC", "rust", "MWPM", "Stim", "Sinter", "PyMatching", "qiskit", "LDPC", "qLDPC", "blossom", "belief propagation", "belief matching", "BP-OSD", "Relay-BP", "colour code", "color code", "toric code", "GPU decoding", "CUDA", "surface code", "syndrome decoding", "fault tolerance", "quantum computing"]
1616
classifiers = [
1717
"License :: Other/Proprietary License",
1818
"Operating System :: OS Independent",
@@ -114,14 +114,21 @@ all = [
114114
]
115115

116116
[project.urls]
117-
Homepage = "https://qector.store"
118-
Documentation = "https://github.com/GuillaumeLessard/qector-decoder"
117+
# PyPI gives a few of these keys dedicated icons in the sidebar: Homepage,
118+
# Documentation, Source, Issues, Changelog and Funding. "Funding" is why the
119+
# sponsors link is spelled exactly that way -- rename it and the icon is lost.
120+
Homepage = "https://www.qector.store"
121+
Documentation = "https://github.com/GuillaumeLessard/qector-decoder/tree/main/docs"
122+
Source = "https://github.com/GuillaumeLessard/qector-decoder"
119123
Repository = "https://github.com/GuillaumeLessard/qector-decoder"
120-
Pricing = "https://qector.store/pricing"
121-
Purchase = "https://buy.stripe.com/7sY9AVdwlgoyfse9bYeUU00"
124+
Issues = "https://github.com/GuillaumeLessard/qector-decoder/issues"
122125
Changelog = "https://github.com/GuillaumeLessard/qector-decoder/blob/main/CHANGELOG.md"
123126
"Release Notes" = "https://github.com/GuillaumeLessard/qector-decoder/blob/main/RELEASE_NOTES.md"
124-
Issues = "https://github.com/GuillaumeLessard/qector-decoder/issues"
127+
Funding = "https://github.com/sponsors/qectorlab"
128+
Pricing = "https://www.qector.store/pricing"
129+
Purchase = "https://buy.stripe.com/7sY9AVdwlgoyfse9bYeUU00"
130+
"Commercial Licensing" = "https://github.com/GuillaumeLessard/qector-decoder/blob/main/COMMERCIAL.md"
131+
Security = "https://github.com/GuillaumeLessard/qector-decoder/blob/main/SECURITY.md"
125132

126133

127134
[project.scripts]

0 commit comments

Comments
 (0)