From ffc9906aea63fc734da78a69f343746ff5fa746f Mon Sep 17 00:00:00 2001
From: sparkainlp-x <281253927+sparkainlp-x@users.noreply.github.com>
Date: Sat, 26 Sep 2026 22:48:29 -0400
Subject: [PATCH] docs: add .zenodo.json release metadata

---
 .zenodo.json | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 .zenodo.json

diff --git a/.zenodo.json b/.zenodo.json
new file mode 100644
index 0000000..93b9437
--- /dev/null
+++ b/.zenodo.json
@@ -0,0 +1,41 @@
+{
+  "upload_type": "software",
+  "title": "qldpc_decoder_cpp: C++/HLS qLDPC decoder research scaffold",
+  "description": "<p>C++/HLS research scaffold for a qLDPC decoder: a minimal C++20 program that links Joschka Roffe's <a href=\"https://github.com/quantumgizmos/ldpc\">ldpc</a> library through CMake FetchContent (OpenMP enabled), a Catch2 unit-test target, and a GF(2) sparse matrix-vector micro-benchmark used as a CI regression gate, plus Vitis HLS / Vivado / PetaLinux scripts targeting the AMD ZCU111 board.</p><p><strong>Evidence tags.</strong> Software build, Catch2 tests, smoke test: run in CI (GitHub-hosted). GF(2) sparse mat-vec micro-benchmark, ~70 ns median: <strong>REPORTED; host/conditions unspecified</strong> (a single micro-operation on a synthetic 32×64 matrix; not qLDPC decoding latency, not an FPGA or end-to-end figure). HLS kernel: scaffold (no belief-propagation message updates yet). HLS synthesis, 300/400 MHz timing: <strong>TARGET / UNRUN</strong>. HIL benchmark on ZCU111, FER: <strong>UNRUN</strong>.</p><p><strong>Known limitation.</strong> <code>verify_correction()</code> always returns <code>true</code>, so any HIL run would report FER = 0 by construction; it must be replaced with a code-aware check before any FER figure is published.</p><p><strong>Scope and limits.</strong> Research scaffold. Not a complete qLDPC decoder on hardware; not a quantum-hardware result (no qubits, QPU, or cryostat were used; <code>N_QUBITS = 144</code> is a code-length parameter); not a measured decoding latency; not hardware-ready or production software. It is independent of the OES-32 residual contract (ADR-001). Please also cite the upstream ldpc library.</p><p>Evidence tags follow <a href=\"https://github.com/sparkainlp-x/.github#evidence-tags\">sparkainlp-x/.github</a> (SYNTHETIC / REPORTED / TARGET / UNRUN).</p>",
+  "creators": [
+    {
+      "name": "Brisson, Jean-François",
+      "affiliation": "Spark AI NLP"
+    }
+  ],
+  "access_right": "open",
+  "license": "MIT",
+  "keywords": [
+    "qLDPC",
+    "LDPC codes",
+    "error correction",
+    "GF(2)",
+    "C++20",
+    "CMake",
+    "Catch2",
+    "Vitis HLS",
+    "FPGA",
+    "research scaffold"
+  ],
+  "related_identifiers": [
+    {
+      "identifier": "https://github.com/sparkainlp-x/qldpc_decoder_cpp",
+      "relation": "isSupplementTo",
+      "resource_type": "software"
+    },
+    {
+      "identifier": "https://github.com/quantumgizmos/ldpc",
+      "relation": "requires",
+      "resource_type": "software"
+    }
+  ],
+  "language": "eng",
+  "references": [
+    "Roffe, Joschka. ldpc (software). https://github.com/quantumgizmos/ldpc"
+  ]
+}