Skip to content

docs: make the landing page show how the package is used - #52

Merged
Sophia Wen (hfwen0502) merged 3 commits into
mainfrom
docs-landing-page
Oct 9, 2026
Merged

Sophia Wen (hfwen0502) merged 3 commits into
mainfrom
docs-landing-page

Conversation

@hfwen0502

Copy link
Copy Markdown
Member

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:

  • Installation: the common CPU case as a copyable conda + pip recipe (no wheels are published, so the extension compiles locally), with GPU backends, host-MPI builds and every build option left to INSTALL.md.
  • SBD as the solver of an SQD loop: a complete solve_sci_batch example plugged into qiskit-addon-sqd's diagonalize_fermionic_hamiltonian, plus a sentence on SBD-selected carryover (carryover_type, qiskit-addon-sqd >= 0.14.0).
  • Backends: what cpu, gpu and gpu-omp run on and what builds each. gpu-omp is marked as offloading TPB only: SBD has no OpenMP-offload GDB code, so a GDB run under gpu-omp executes on the host, and GDB on GPUs needs gpu (Thrust). On 8x H100, GDB on 2.38M determinants took 16 s on gpu against 101 s on gpu-omp, which matched cpu at 94 s.
  • TPB or GDB: the two ways of spanning the subspace, and that only TPB is part of the SQD-loop integration.
  • More: links to the README, the examples, the API reference and issues.

Only docs/index.rst changes. sphinx-build -W -T --keep-going, the command tox -e docs runs, succeeds with no warnings.

🤖 Generated with Claude Code

Sophia Wen (hfwen0502) and others added 2 commits October 9, 2026 15:39
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>
@garrison Jim Garrison (garrison) added the documentation Improvements or additions to documentation label Oct 9, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@hfwen0502
Sophia Wen (hfwen0502) merged commit e7624f5 into main Oct 9, 2026
16 checks passed
@hfwen0502
Sophia Wen (hfwen0502) deleted the docs-landing-page branch October 9, 2026 20:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants