FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Add symmetric tensor tutorial to docs as appendix by leburgel · Pull Request #316 · QuantumKitHub/TensorKit.jl · GitHub

Add symmetric tensor tutorial to docs as appendix - #316

Merged
Jutho merged 27 commits into
mainfrom
lb/add_tutorial
Dec 1, 2025
Merged

Jutho merged 27 commits into
mainfrom
lb/add_tutorial

Conversation

Copy link
Copy Markdown
Member

Adds the symmetric tensor tutorial from the quantumghent tensor tutorials to the docs as an appendix, as discussed in #289.

In the process, I add subblock and subblocks to the library docs, since these were missing before so I couldn't reference their docstrings.

codecov Bot commented Nov 17, 2025 •
edited
Loading

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.

Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Member Author

Not really the main point here, but I would also prefer it if all toc depths in docs/src/index.md were set to 2. I've always thought the depth-3 ones look very busy.

lkdvos left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Will try and go through in more detail, some small comments:

It might make the notation a bit lighter if we replace ComplexF64 with Float64 for the cases where this is applicable, I know we don't default to this in MPSKit for various reasons, but here it seems a bit much to me.

For git reasons it might be convenient to break lines at sentences instead of splitting at linewidth. It also tends to make paragraphs less jumpy for small changes/comments

Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
leburgel requested review from Jutho and lkdvos November 19, 2025 13:42
Comment thread docs/src/index.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Jutho previously approved these changes Nov 25, 2025

Jutho left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Great tutorial. I left some minor comments and suggestions.

Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Co-authored-by: Jutho <Jutho@users.noreply.github.com>
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
lkdvos previously approved these changes Nov 28, 2025

lkdvos left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Left some final comments but otherwise definitely good to go for me. Great work, thank you!

Comment thread docs/src/index.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Co-authored-by: Lukas Devos <ldevos98@gmail.com>
leburgel requested review from Jutho and lkdvos December 1, 2025 09:36
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Co-authored-by: Jutho <Jutho@users.noreply.github.com>
Comment thread docs/src/appendix/symmetric_tutorial.md Outdated

Jutho commented Dec 1, 2025

Copy link
Copy Markdown
Member

Ok, I think these are the final suggestions. If these are addressed, I will approve and merge.

Comment thread docs/src/appendix/symmetric_tutorial.md Outdated
Jutho merged commit 318f921 into main Dec 1, 2025
39 of 42 checks passed
Jutho deleted the lb/add_tutorial branch December 1, 2025 23:33
Jutho referenced this pull request Dec 9, 2025
* initial basic design SectorVector

* some additional functionality

* relax `foreachblock` signature

* replace `SectorDict` with `SectorVector` for eig/svdvals

* export `svd_vals`

* clean up SectorVector design

* small fix

* add finitedifferences support

* update changelog

* some simplifications and extensions

* some further fixes

* some more fixes

* update dates

---------

Co-authored-by: Jutho Haegeman <jutho.haegeman@ugent.be>
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants


Back | FazBrowse Home | New Git URL