Physics

This subpackage contains the physical classes and functions closely related to energy and magnetic parameter calculation.

Physical classes

Builder([ref_xcf_orientations])	This class contains the data and the methods related to the Simulation.
Contour([eset, esetp, emin, emax, ...])	This class contains and creates the data of the energy contour for the integration.
Hamiltonian(infile[, scf_xcf_orientation])	This class contains the data and the methods related to the Hamiltonian and geometry.
Kspace([kset])	This class contains and creates the data of the reciprocal space integral.
MagneticEntity(infile[, atom, l, orb])	This class contains the data and the methods related to the magnetic entities.
Pair(M1, M2[, supercell_shift])	This class contains the data and the methods related to the pairs of magnetic entities.
PairList([pairs])	List of Pairs.
MagneticEntityList([magnetic_entities])	List of MagneticEntities.

Background information

This module contains the high level API of the package. It was purposefully written to be highly modular, which is ideal for complicated systems that are easier to set up and develop in a jupyter notebook environment.