Skip to content

OVERVIEW validated results tables + paper LaTeX draft (repo publication package) #16

Description

@rosspeili

Context

spinq-vqe v0.1.2 is code-complete with validated results tables in OVERVIEW.md (VQE errors, entanglement, QAOA comparison). spintronic-qrc OVERVIEW.md still shows:

  • Version 0.1.0 (scaffold)
  • Next: Notebook 01
  • Empty deliverables checkboxes for notebooks 01–06, benchmarks/, paper/
  • Open design questions unchecked

After Issues #1#15 (or minimally #1#13 + #10), the repo has enough results to write the publication narrative. OVERVIEW.md lists paper/ LaTeX as a deliverable targeting npj Quantum Information / PRR.

spinq-vqe does not yet ship paper/ either — this issue creates the QRC paper skeleton and locks results into OVERVIEW.

Goal

  1. Rewrite OVERVIEW.md status and results sections with committed numbers from data/*.csv
  2. Resolve or document open design decisions (#217–223)
  3. Add paper/ LaTeX draft skeleton (main.tex + sections + bibliography stub)
  4. Update CITATION.cff if metadata needs refresh (no Zenodo DOI — user handles release/tags)

Part A — OVERVIEW.md refresh

Status table (update)

Field New value
Version 0.2.0-dev or actual pyproject version when merged
Shipped List all completed modules, notebooks, benchmarks
Next Paper refinement / arXiv upload (user-owned)

Key results at a glance (add tables)

Pull from committed CSVs — minimum tables:

NARMA-10 (QRC vs ESN)

Method n_sites / n_reservoir test_nmse Notes
QRC ... ... from data/narma10_results.csv
ESN ... ... same file

Mackey-Glass

Method test_rmse test_nmse

Memory capacity

Method total_mc k_max

Gate depth (C1)

n_sites native_depth universal_depth reduction %

Optional: open-system gamma sweep headline (if Issue #14 done)

Deliverables checklist

Check off all completed items. Leave paper/ as in-progress until Part B merges.

Open design decisions — resolve with evidence

For each item in Open Questions, add a Decision row citing notebook or benchmark that answered it:

Question Decision Evidence
Encoding local vs global ... NB02/NB04 sweep
Measurement subset ... default X,Y,Z all sites or subset
Disorder quenched vs annealed quenched (fixed per run) unless NB shows otherwise pipeline.py
Gate set universality qualitative from NB05 Weyl chamber notebook 05
Open system damping gamma impact on NARMA notebook 06

Part B — paper/ LaTeX skeleton

Create paper/ directory:

paper/
├── main.tex
├── sections/
│   ├── 01_introduction.tex
│   ├── 02_background.tex
│   ├── 03_methods.tex
│   ├── 04_results.tex
│   └── 05_conclusion.tex
├── figures/          # symlinks or copy from ../figures/ key plots
├── references.bib    # subset from REFERENCES.md (BibTeX keys)
└── README.md         # build instructions (pdflatex + bibtex)

Draft title (from OVERVIEW)

Quantum Reservoir Computing on Antiferromagnetic Spin Chains:
Connecting Spintronic Physics to Temporal Machine Learning

Methods section must reference

  • XXZ Hamiltonian + disorder (reservoir.py)
  • QRC pipeline (pipeline.py)
  • Ridge readout (trainer.py)
  • ESN baseline (esn.py)
  • Memory capacity (memory.py)
  • Spintronic gate set + depth (gates.py, depth.py)
  • Optional: calibration.py spinq-vqe link
  • Code availability: GitHub ARPAQLS/spintronic-qrc

Results section

Insert placeholder \input{} tables or \ref{} to figures copied from repo:

  • fig:xxz_dynamics
  • fig:qrc_narma10
  • fig:memory_capacity
  • fig:gate_depth_comparison

Use \todo{} for prose paragraphs — structure matters more than polished writing.

paper/README.md

Document:

cd paper && pdflatex main.tex && bibtex main && pdflatex main.tex

Note: figure paths, no proprietary fonts required.

Part C — Cross-doc sync

  • README.md — add Paper section linking paper/README.md
  • CHANGELOG.md — [Unreleased] or version bump entry summarizing results package
  • docs/README.md — one line on paper/
  • Do NOT edit root Spintronics/README.md unless explicitly requested in same PR (can note in issue comment)

Acceptance criteria

  • OVERVIEW.md has Key results tables with real numbers from data/*.csv
  • OVERVIEW status no longer says scaffold / Notebook 01 next
  • Open design questions section updated with decisions
  • paper/main.tex compiles to PDF (may have todo placeholders)
  • paper/references.bib has >= 15 entries keyed to REFERENCES.md
  • paper/README.md build instructions
  • Deliverables: paper/ checked or marked draft-complete

Files likely touched

  • OVERVIEW.md (major update)
  • paper/* (new)
  • README.md (Paper section)
  • CHANGELOG.md
  • CITATION.cff (optional metadata)

Depends on

Blocks

  • arXiv submission (user-owned)
  • Zenodo DOI (user-owned, no agent tags)
  • spintronic-qbench citation of validated QRC task

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions