Skip to content

Documentation overhaul#61

Open
lkdvos wants to merge 24 commits intomainfrom
ld-docs
Open

Documentation overhaul#61
lkdvos wants to merge 24 commits intomainfrom
ld-docs

Conversation

@lkdvos
Copy link
Member

@lkdvos lkdvos commented Jan 30, 2026

This is ongoing work to start properly documenting this package.
It is based on the work in TensorKit, credits go to @Jutho for that.

The docs now consist of two large parts: The first part defines the interface of Sector, while the second is a list of the concrete types provided by this package.

I think the first part fixes #56 and is somewhat ready for review.
I am pretty happy with the general lay-out, but comments are obviously more than welcome.
Many of the formulas will require checking for errors, I have been doing this on the side while waiting for other PRs, so many things will have slipped my full attention.

For the second part, (related to #57) I for now only filled out the SU2Irrep page in an attempt to show what I had in mind to document the different conventions. Before I continue with the rest (or others can chime in), I wanted to get a round of review in.

@lkdvos lkdvos added the documentation Improvements or additions to documentation label Jan 30, 2026
@lkdvos lkdvos linked an issue Jan 30, 2026 that may be closed by this pull request
@github-actions
Copy link

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

@codecov
Copy link

codecov bot commented Jan 30, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing lines Coverage Δ
src/irreps/su2irrep.jl 100.00% <ø> (ø)
src/sectors.jl 88.88% <100.00%> (-0.51%) ⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Jutho
Copy link
Member

Jutho commented Jan 30, 2026

Starts to look great; this will be a very useful addition.

```math
\sum_g R^{ab}_g F^{abx}_{cg} R^{ax}_c = \sum_{f,h} F^{bax}_{cf} R^{af}_h F^{axb}_{ch}
```
and the analogous equation with ``a`` and ``b`` swapped.
Copy link
Member

Choose a reason for hiding this comment

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

There's more to it than just swapping a and b, but it's probably not worth going into it. Maybe meet halfway and say something about over- and underbraiding?

Copy link
Member Author

Choose a reason for hiding this comment

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

yeah, although I guess I really just need to sit down and put some actual figures together 😢

| [`FermionNumber`](@ref) | fU₁ | Unique | Fermionic | Yes | Fermion number conservation |
| [`FermionSpin`](@ref) | fSU₂ | Simple | Fermionic | Yes | Fermions with spin symmetry |
| [`ProductSector`](@ref) | Product categories | Varies | Varies | Varies | Multiple simultaneous symmetries |
| [`TimeReversed`](@ref) | Inverted braiding | Varies | Varies | Varies | ?? |
Copy link
Member

Choose a reason for hiding this comment

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

Symmetries of the bra state or Drinfeld centers of modular tensor categories are what I can come up with on the spot

Copy link
Member

Choose a reason for hiding this comment

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

I also wonder if the last column is really useful, but I guess it doesn't hurt to mention?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not even sure if this table is all that useful to begin with, but copilot generated it and I like how it looks...

@borisdevos
Copy link
Member

Overall amazing work! The pages are pretty short, so I'm wondering if it's beneficial to have this depth to the headers?

Also, do you think these docs should also mention the other packages supporting Sectors, like SUNRepresentations, CategoryData and QWignerSymbols?

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.

[Docs] Explain Sector interface in documentation

3 participants