Skip to content

docs(examples): add TFIM ground-state and SU(3) Heisenberg examples - #502

Draft
lkdvos wants to merge 1 commit into
docs/content-wave1from
docs/new-examples
Draft

docs(examples): add TFIM ground-state and SU(3) Heisenberg examples#502
lkdvos wants to merge 1 commit into
docs/content-wave1from
docs/new-examples

Conversation

@lkdvos

@lkdvos lkdvos commented Aug 3, 2026

Copy link
Copy Markdown
Member

Split out of #449. Stacked on it — merges last, after #500 and #449.

The gallery had no beginner entry point: every example already assumed familiarity with the API. groundstates/0.tfim-groundstate is a complete ground-state study of the transverse-field Ising model — the same model the tutorials use — from a product state through DMRG, magnetization and correlation functions.

excitations/1.su3-heisenberg covers the SU(3) Heisenberg chain using SUNRepresentations, the only example exercising a non-abelian symmetry beyond SU(2).

Needs a physics call before merging: its dispersion reproduces the soft-mode location of [devos2022] but not the reported gap — this computes ≈ −0.042 against the paper's +0.0263. The page says so explicitly rather than presenting the number as agreement, but the discrepancy is unresolved. It is isolated in this PR precisely so it does not hold up the prose review in #449.

Both pages are the real output of examples/make.jl against current main.

🤖 Generated with Claude Code

The gallery had no beginner entry point: every example already assumed familiarity with the
API. `groundstates/0.tfim-groundstate` is a complete ground-state study of the
transverse-field Ising model — the same model the tutorials use — from a product state
through DMRG, magnetization and correlation functions.

`excitations/1.su3-heisenberg` covers the SU(3) Heisenberg chain using `SUNRepresentations`,
which is the only example exercising a non-abelian symmetry beyond SU(2). Its dispersion
reproduces the soft-mode location of the reference but not the reported gap value; the page
says so explicitly rather than quietly presenting the number as agreement.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

After the build completes, the updated documentation will be available here

@codecov

codecov Bot commented Aug 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

1 participant