SpinToolkit

This is the documentation of Python API for the SpinToolkit library.

Indices and Tables

• Index
• Module Index
• Search Page

Lattice

• Class
  • lattice

Model

• Class
  • model_spin
• Functions
  • spin_cart2spherical()
  • spin_spherical2cart()
  • set_Ising_random()
  • set_dipole_random()
  • set_SUN_random()
  • set_RPA_random()
  • spins_magnetization()

Spin Wave

• Classes
  • k_cut
  • k_map
• Core Functions
  • SSSF()
  • DOS_LSW()
  • DOS_GLSW()
  • DSSF_GLSW()
  • DSSF_LSW()
• Extension Functions
  • generate_lsw_mat()
  • generate_glsw_mat()
  • Bogoliubov()
  • fourier_spin()
  • fourier_spin_fft()

Classical Monte Carlo

• Classes
  • mc_base
  • mc_Ising
  • mc_dipole
  • mc_SUN

Rotation

• Class
  • Mat3_rotation

Crystal

• Classes
  • BondRaw
  • Bond
  • SymOP
  • SiteSymmetry
  • Crystal
• Functions
  • lattice_basis2angle()
  • lattice_angle2basis()

Units

• Class
  • units

Linear Algebra

• Classes
  • Vec3
  • Vec4
  • Vec5
  • cx_Vec3
  • Mat3
  • Mat4
  • cx_Mat3
  • MatrixD
  • MatrixZ
  • spin_matrices
  • stevens_matrices
  • Vec3List
  • VecZList
• Allowed Operators
• Functions
  • cross()
  • normalize()
  • dot()
  • kron()
  • solve()
  • solve_triangular()
  • solve_symmetric()
  • chol()
  • svd()
  • eig_gen()
  • eig_sym()

Miscellaneous Functions

• Functions
  • date_and_time()
  • total_omp_threads()
  • print_system_info()
  • round2int()
  • save_state_dipole()
  • save_state_SUN()
  • load_state_dipole()
  • load_state_SUN()