Data structures (overview)#
A number of data structures are defined in magnopy. Two of them are inherited from the wulfric package (Cell and Atoms). Some are used to store the parameters of spin Hamiltonian (Spin Hamiltonian and Convention) or specify its ground state (Spin directions). Other represent levels of theory and serve as a collection of the things that can be computed (LSWT, Energy).
For the technical reference on how each function, class, method or attribute behaves see API reference.
The image below highlights connections between some of magnopy's data structures.
The picture can be read as:
magnopy.SpinHamiltoniancan be created from Cell, Atoms andmagnopy.Convention;magnopy.Energycan be created frommagnopy.SpinHamiltonian;magnopy.LSWTcan be created frommagnopy.SpinHamiltonianand Spin directions.