Skip to content

Commit 44531dc

Browse files
sponsor section in README.md and tables of contents
1 parent f141f6f commit 44531dc

5 files changed

Lines changed: 231 additions & 99 deletions

File tree

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,29 @@ Implemented packages:
3232
- `qite` for projected variational dynamics (`VarQITE`, `VarQRTE`)
3333
- `common` for shared chemistry, Hamiltonians, caching, and plotting
3434

35+
## Table of Contents
36+
37+
- [What This Repo Is Good For](#what-this-repo-is-good-for)
38+
- [Choose A Method](#choose-a-method)
39+
- [Install](#install)
40+
- [Quickstart](#quickstart)
41+
- [Typical Workflow](#typical-workflow)
42+
- [Package Overview](#package-overview)
43+
- [vqe](#vqe)
44+
- [qpe](#qpe)
45+
- [qite](#qite)
46+
- [Shared Infrastructure](#shared-infrastructure)
47+
- [Supported Molecule Inputs](#supported-molecule-inputs)
48+
- [Non-Molecule Mode](#non-molecule-mode)
49+
- [Outputs And Reproducibility](#outputs-and-reproducibility)
50+
- [Notebooks](#notebooks)
51+
- [Documentation](#documentation)
52+
- [Repository Layout](#repository-layout)
53+
- [Testing](#testing)
54+
- [Support Development](#support-development)
55+
- [Author](#author)
56+
- [License](#license)
57+
3558
## What This Repo Is Good For
3659

3760
Use this repo if you want:
@@ -357,6 +380,24 @@ Variational_Quantum_Eigensolver/
357380
pytest -q
358381
```
359382

383+
---
384+
385+
## Support development
386+
387+
If this repository is useful for research, learning, or experimentation, you can support continued development via GitHub Sponsors:
388+
389+
https://github.com/sponsors/SidRichardsQuantum
390+
391+
Sponsorship helps support ongoing work on open-source implementations of quantum algorithms, including improvements to documentation, reproducible workflows, and example notebooks.
392+
393+
Support helps maintain and expand practical tooling for variational quantum methods, quantum simulation workflows, and related experimentation.
394+
395+
## Citation
396+
397+
Sid Richards (2026)
398+
399+
Unified Variational and Phase-Estimation Quantum Simulation Suite
400+
360401
## Author
361402

362403
Sid Richards

THEORY.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -788,5 +788,13 @@ PennyLane documentation for:
788788

789789
---
790790

791-
Author: Sid Richards
792-
License: MIT
791+
## Author
792+
793+
Sid Richards
794+
795+
- LinkedIn: [sid-richards-21374b30b](https://www.linkedin.com/in/sid-richards-21374b30b/)
796+
- GitHub: [SidRichardsQuantum](https://github.com/SidRichardsQuantum)
797+
798+
## License
799+
800+
MIT. See [LICENSE](LICENSE).

USAGE.md

Lines changed: 53 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,50 @@ Workflows and APIs for:
99

1010
---
1111

12+
## Table of Contents
13+
14+
- [Documentation Map](#documentation-map)
15+
- [Core Execution Model](#core-execution-model)
16+
- [Supported Molecule Inputs](#supported-molecule-inputs)
17+
- [Installation](#installation)
18+
- [General Conventions](#general-conventions)
19+
- [Method Support Summary](#method-support-summary)
20+
- [Quickstart](#quickstart)
21+
22+
- [VQE Workflows](#vqe-workflows)
23+
- [Basic VQE](#basic-vqe)
24+
- [Non-molecule expert mode](#non-molecule-expert-mode)
25+
- [Ansatz selection](#ansatz-selection)
26+
- [Optimizer selection](#optimizer-selection)
27+
- [Geometry scans](#geometry-scans)
28+
- [Noise studies](#noise-studies)
29+
- [Low-qubit benchmark](#low-qubit-benchmark)
30+
31+
- [Excited-State Methods](#excited-state-methods)
32+
- [Post-VQE methods](#post-vqe-methods)
33+
- [Variational excited states](#variational-excited-states)
34+
35+
- [QPE](#qpe)
36+
- [Basic QPE](#basic-qpe)
37+
- [Noise](#noise)
38+
- [Time evolution controls](#time-evolution-controls)
39+
40+
- [QITE / Projected Dynamics](#qite--projected-dynamics)
41+
- [Execution modes](#execution-modes)
42+
- [Run](#run)
43+
- [Real-time run](#real-time-run)
44+
- [Noisy evaluation](#noisy-evaluation)
45+
- [Noise sweep](#noise-sweep)
46+
- [Cache semantics](#cache-semantics)
47+
48+
- [Reproducibility](#reproducibility)
49+
- [Testing](#testing)
50+
- [Citation](#citation)
51+
- [Author](#author)
52+
- [License](#license)
53+
54+
---
55+
1256
## Documentation Map
1357

1458
| File | Purpose |
@@ -812,7 +856,13 @@ Sid Richards (2026)
812856

813857
Unified Variational and Phase-Estimation Quantum Simulation Suite
814858

815-
---
859+
## Author
860+
861+
Sid Richards
862+
863+
- LinkedIn: [sid-richards-21374b30b](https://www.linkedin.com/in/sid-richards-21374b30b/)
864+
- GitHub: [SidRichardsQuantum](https://github.com/SidRichardsQuantum)
865+
866+
## License
816867

817-
Author: Sid Richards
818-
License: MIT
868+
MIT. See [LICENSE](LICENSE).

more_docs/vqe/noise.md

Lines changed: 51 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -155,9 +155,9 @@ vqe -m H2 --noisy --depolarizing-prob 0.02
155155

156156
Behaviour:
157157

158-
* noise applied independently to each qubit
159-
* any subset of built-in channels can be combined
160-
* ignored if `--noisy` is not set
158+
- noise applied independently to each qubit
159+
- any subset of built-in channels can be combined
160+
- ignored if `--noisy` is not set
161161

162162
---
163163

@@ -186,18 +186,18 @@ apply_optional_noise(..., noise_model=my_noise)
186186

187187
Behaviour:
188188

189-
* applied **after the ansatz**
190-
* executed only if `noisy=True`
191-
* can include arbitrary PennyLane channels
189+
- applied **after the ansatz**
190+
- executed only if `noisy=True`
191+
- can include arbitrary PennyLane channels
192192

193193
---
194194

195195
### Combined behaviour
196196

197197
If both interfaces are used:
198198

199-
* built-in configured channels are applied first
200-
* then `noise_model` is applied
199+
- built-in configured channels are applied first
200+
- then `noise_model` is applied
201201

202202
This allows explicit package-supported channels plus arbitrary extra PennyLane channels.
203203

@@ -213,13 +213,13 @@ apply_optional_noise(...)
213213

214214
### Key properties
215215

216-
* no-op if `noisy=False`
217-
* applied to all wires:
216+
- no-op if `noisy=False`
217+
- applied to all wires:
218218

219219
```python
220220
wires = list(range(num_wires))
221221
```
222-
* applied **inside QNodes**, after ansatz construction
222+
- applied **inside QNodes**, after ansatz construction
223223

224224
---
225225

@@ -257,8 +257,8 @@ Differentiation method depends on noise:
257257

258258
Reason:
259259

260-
* parameter-shift is not generally valid for noisy channels
261-
* finite-difference is used as a fallback
260+
- parameter-shift is not generally valid for noisy channels
261+
- finite-difference is used as a fallback
262262

263263
---
264264

@@ -268,47 +268,47 @@ Noise affects different methods differently.
268268

269269
### Fully supported
270270

271-
* VQE
272-
* ADAPT-VQE
273-
* SSVQE
274-
* VQD
275-
* QPE (via noisy evolution)
271+
- VQE
272+
- ADAPT-VQE
273+
- SSVQE
274+
- VQD
275+
- QPE (via noisy evolution)
276276

277277
---
278278

279279
### Partially supported
280280

281-
* QITE / VarQITE
281+
- QITE / VarQITE
282282

283-
* optimization: noiseless
284-
* evaluation: noisy (post-processing)
283+
- optimization: noiseless
284+
- evaluation: noisy (post-processing)
285285

286286
---
287287

288288
### Not supported (noiseless-only)
289289

290-
* LR-VQE
291-
* EOM-VQE
292-
* QSE
293-
* EOM-QSE
290+
- LR-VQE
291+
- EOM-VQE
292+
- QSE
293+
- EOM-QSE
294294

295295
Reason:
296296

297-
* require statevector access
298-
* rely on exact overlaps or tangent vectors
297+
- require statevector access
298+
- rely on exact overlaps or tangent vectors
299299

300300
---
301301

302302
## Overlap Handling Under Noise
303303

304304
For methods like VQD:
305305

306-
* noiseless:
306+
- noiseless:
307307
[
308308
|\langle \psi_i | \psi_j \rangle|^2
309309
]
310310

311-
* noisy:
311+
- noisy:
312312
[
313313
\mathrm{Tr}(\rho_i \rho_j)
314314
]
@@ -323,42 +323,42 @@ Noise impacts:
323323

324324
### 1. Energy estimation
325325

326-
* increases variance
327-
* introduces bias
328-
* reduces achievable accuracy
326+
- increases variance
327+
- introduces bias
328+
- reduces achievable accuracy
329329

330330
---
331331

332332
### 2. Optimization
333333

334-
* flattens gradients
335-
* introduces stochastic behaviour
336-
* may slow convergence
334+
- flattens gradients
335+
- introduces stochastic behaviour
336+
- may slow convergence
337337

338338
---
339339

340340
### 3. Circuit expressibility
341341

342-
* reduces effective expressibility
343-
* limits reachable states
342+
- reduces effective expressibility
343+
- limits reachable states
344344

345345
---
346346

347347
### 4. Excited-state methods
348348

349-
* post-VQE methods typically break under noise
350-
* variational methods remain usable
349+
- post-VQE methods typically break under noise
350+
- variational methods remain usable
351351

352352
---
353353

354354
## Practical Guidance
355355

356-
* use small noise levels first:
356+
- use small noise levels first:
357357

358-
* e.g. `0.01 – 0.05`
359-
* compare against noiseless baseline
360-
* reduce stepsize when noise is high
361-
* use multi-seed runs for statistical analysis:
358+
- e.g. `0.01 – 0.05`
359+
- compare against noiseless baseline
360+
- reduce stepsize when noise is high
361+
- use multi-seed runs for statistical analysis:
362362

363363
```bash
364364
vqe --multi-seed-noise
@@ -368,10 +368,10 @@ Noise impacts:
368368

369369
## Limitations
370370

371-
* noise is applied **after the full ansatz**, not per gate
372-
* no time-dependent noise modeling
373-
* no hardware-specific calibration
374-
* no error mitigation techniques included
371+
- noise is applied **after the full ansatz**, not per gate
372+
- no time-dependent noise modeling
373+
- no hardware-specific calibration
374+
- no error mitigation techniques included
375375

376376
---
377377

@@ -392,8 +392,8 @@ Noise impacts:
392392

393393
Noise is treated as a **modular, post-ansatz layer**:
394394

395-
* simple to use via CLI
396-
* extensible via custom models
397-
* integrated consistently across VQE workflows
395+
- simple to use via CLI
396+
- extensible via custom models
397+
- integrated consistently across VQE workflows
398398

399399
This design enables controlled studies of noise effects without modifying algorithm implementations.

0 commit comments

Comments
 (0)