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.

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

Minor improvement to comments / docs for Symmetry/AllowedCouplings.jl #5

Closed
ColeMiles opened this issue Nov 1, 2021 · 2 comments
Closed

Comments

@ColeMiles
Copy link
Contributor

The current comment at the top of Symmetry/AllowedCouplings.jl is a bit confusing -- it seems to imply that the constraints on allowed exchange matrices are:

$J = R J R^T$

for all R that map bonds within a symmetry equivalency class. But these constraints are only for R which map bonds to themselves.

Maybe as part of this issue, a new section in the "Internals" documentation could be made which explains the ideas of the symmetry analysis and how the algorithms work?

@kbarros
Copy link
Member

kbarros commented Nov 3, 2021

Partially addressed in Commit ec0d584

Helped wanted to split this out into a nice Markdown document.

@kbarros
Copy link
Member

kbarros commented Aug 19, 2024

I think the current code comments are good. Comprehensive markdown docs would of course be better, but that will require a separate effort.

@kbarros kbarros closed this as completed Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants