SunnySuite / Sunny.jl

Spin dynamics and generalization to SU(N) coherent states
Other
86 stars 19 forks source link

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

Closed ColeMiles closed 2 months ago

ColeMiles commented 2 years ago

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 commented 2 years ago

Partially addressed in Commit https://github.com/MagSims/Sunny.jl/commit/ec0d584c7ef97db6868611373870f0dba90499be

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

kbarros commented 2 months ago

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