Repository navigation
docs: make the landing page show how the package is used - #52
Merged
Merged
Conversation
The home page was a two-paragraph description plus links, with a three-line example using placeholder file names. It now carries what a first-time reader needs without leaving the page: a CPU install with the available_backends() check, the SQD-loop recipe (solve_sci_batch as sci_solver, the main use), a table of the three backends and what each needs, and a short TPB-versus-GDB section. Detail stays in INSTALL.md, the README and the per-folder example READMEs, which it links to. Snippets are the README's, so they match what is already documented and tested. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The documentation home page was a few sentences pointing elsewhere. This makes it show how the package is used, so a reader can tell from the landing page alone what SBD does here and where to go next:
piprecipe (no wheels are published, so the extension compiles locally), with GPU backends, host-MPI builds and every build option left toINSTALL.md.solve_sci_batchexample plugged intoqiskit-addon-sqd'sdiagonalize_fermionic_hamiltonian, plus a sentence on SBD-selected carryover (carryover_type,qiskit-addon-sqd>= 0.14.0).cpu,gpuandgpu-omprun on and what builds each.gpu-ompis marked as offloading TPB only: SBD has no OpenMP-offload GDB code, so a GDB run undergpu-ompexecutes on the host, and GDB on GPUs needsgpu(Thrust). On 8x H100, GDB on 2.38M determinants took 16 s ongpuagainst 101 s ongpu-omp, which matchedcpuat 94 s.Only
docs/index.rstchanges.sphinx-build -W -T --keep-going, the commandtox -e docsruns, succeeds with no warnings.🤖 Generated with Claude Code