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

LSWT docs #101

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

LSWT docs #101

wants to merge 2 commits into from

Conversation

kbarros
Copy link
Member

@kbarros kbarros commented Jul 21, 2023

Two new docs from Hao and Cristian. This will require some discussion and work before merging. This PR can serve as a forum for discussion and planning.

  1. There is already stevens.lyx which overlaps somewhat with LSWT_dipole.lyx. Material from these two documents should be merged, and redundancies removed.
  2. SunnySWT.lyx looks like it might still be evolving, and has extra materials besides just LSWT. We might want to extract a simplified subset of the material that focuses on SU(N) LSWT.
  3. The two notes LSWT_dipole.lyx and SunnySWT.lyx were auto-converted from Latex to Lyx. This leads to some artifacts that should be cleaned up.

I am also wondering if we eventually want to convert these to Markdown format and include them in our online docs.

@Hao-Phys
Copy link
Contributor

For point 2, I am sorry that I included the wrong file version. I agree we should use Markdown eventually.

@Lazersmoke
Copy link
Contributor

For the online docs: It might be appropriate to make a "Calculation Details" header (and put it after "Examples") to collect all the information people need to understand the calculations which are performed by Sunny:

  • These LSWT notes (I envision the src/SpinWaveTheory/SpinWaveTheory.jl and/or SWTCalculations.jl [or more likely combining these into one file] as becoming Literate files used as source for the documentation page, with the notes adapted into markdown comments)
  • Histogram tutorial
  • What is currently the "Structure Factor Calculations" docs page
  • A page about multipolar moments, e.g. using the spin-1 chain example from Bai et al
  • etc

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

Successfully merging this pull request may close these issues.

3 participants