Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation improvements #226

Merged
merged 12 commits into from
Jan 16, 2025
Merged

Documentation improvements #226

merged 12 commits into from
Jan 16, 2025

Conversation

lkdvos
Copy link
Member

@lkdvos lkdvos commented Jan 13, 2025 •
edited
Loading

This PR enables the usage of DocStringExtensions.jl for better docstrings, and DocumenterCitations.jl for smarter referencing.

TODO

  • Check for remaining references to papers in the source code
  • Check for papers using MPSKit in the literature

@lkdvos lkdvos requested a review from leburgel January 13, 2025 00:03
@codecov Codecov
Copy link

codecov bot commented Jan 13, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 76.27119% with 14 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/algorithms/algorithm.jl 0.00% 10 Missing ⚠️
src/algorithms/approximate/idmrg.jl 81.81% 2 Missing ⚠️
src/algorithms/groundstate/idmrg.jl 87.50% 2 Missing ⚠️
Files with missing lines Coverage Δ
src/MPSKit.jl 100.00% <ø> (ø)
src/algorithms/changebonds/optimalexpand.jl 100.00% <100.00%> (ø)
src/algorithms/changebonds/randexpand.jl 100.00% <100.00%> (ø)
src/algorithms/changebonds/svdcut.jl 94.64% <100.00%> (+1.78%) ⬆️
src/algorithms/changebonds/vumpssvd.jl 100.00% <100.00%> (ø)
src/algorithms/excitation/chepigaansatz.jl 91.48% <100.00%> (ø)
src/algorithms/excitation/dmrgexcitation.jl 100.00% <100.00%> (ø)
...c/algorithms/excitation/quasiparticleexcitation.jl 65.71% <100.00%> (ø)
src/algorithms/groundstate/dmrg.jl 100.00% <100.00%> (ø)
src/algorithms/groundstate/gradient_grassmann.jl 75.00% <ø> (ø)
... and 16 more

@lkdvos lkdvos force-pushed the ld-algdocs branch 5 times, most recently from 5d08dc1 to 91de087 Compare January 15, 2025 00:38
@lkdvos
Copy link
Member Author

lkdvos commented Jan 15, 2025

Preview available: https://quantumkithub.github.io/MPSKit.jl/previews/PR226

@lkdvos lkdvos force-pushed the ld-algdocs branch 3 times, most recently from b2f30ac to be6b0cd Compare January 15, 2025 23:04
leburgel
leburgel reviewed Jan 16, 2025
View reviewed changes
Copy link
Member

@leburgel leburgel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, and DocStringExtensions.jl is extremely satisfying!

docs/src/lib/lib.md Show resolved Hide resolved
docs/src/man/operators.md Show resolved Hide resolved
docs/src/references.md Show resolved Hide resolved
src/algorithms/changebonds/optimalexpand.jl Outdated Show resolved Hide resolved
examples/classic2d/1.hard-hexagon/main.jl Show resolved Hide resolved
src/algorithms/groundstate/idmrg.jl Outdated Show resolved Hide resolved
src/algorithms/groundstate/dmrg.jl Outdated Show resolved Hide resolved
src/algorithms/timestep/tdvp.jl Outdated Show resolved Hide resolved
src/algorithms/timestep/tdvp.jl Outdated Show resolved Hide resolved
src/states/abstractmps.jl Outdated Show resolved Hide resolved
@lkdvos lkdvos force-pushed the ld-algdocs branch 2 times, most recently from 478fdd7 to 3c3923d Compare January 16, 2025 14:27
@lkdvos lkdvos enabled auto-merge (squash) January 16, 2025 14:40
@lkdvos lkdvos merged commit 925edc4 into master Jan 16, 2025
27 checks passed
@lkdvos lkdvos deleted the ld-algdocs branch January 16, 2025 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leburgel leburgel leburgel approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lkdvos @leburgel