docs: expand each algorithm into its own in-depth manual section#4
Merged
Conversation
Split the combined TEBD/TDVP page and give every algorithm its own pedagogical section (Background with theory + math, how it works in MPSToolkit, a verified worked example, tips/pitfalls, API, example links, references): TEBD, TDVP, ScarFinder, Operator Space, DMT, DAOE, and Chebyshev (CheMPS). Expand Architecture into a map of how the algorithms share the evolve!/project! building blocks, and remove the stale orphan evolution.md. Coordinate @docs ownership so each docstring is documented exactly once (newly documenting MPSToolkit.score, chebyshev_rescaling, rescale_hamiltonian), and update the nav, api.md, README, getting-started, and landing-page links for the split. All seven worked examples were executed against the package and the full Documenter build passes (doctests, cross-references, KaTeX math). Co-Authored-By: Claude Opus 4.8 (1M context) <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
1 participant
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.
Expands the documentation so each algorithm is its own pedagogical section, following up on the house-style README/logo work.
What changed
@docs) → example links → references.evolve!/project!building blocks.evolution.md(not in the nav, superseded).MPSToolkit.score,chebyshev_rescaling,rescale_hamiltonian.api.md, README, getting-started, and landing-page links for the split.Verification
@docs(each docstring documented exactly once), no orphan-page warnings.ALL_EXAMPLES_OK). Notably DAOE's damped overlap came out0.741 = exp(-2γ), matching the documented damping law.🤖 Generated with Claude Code