API reference

Release:

0.5.3

Main interface to the package should be imported as

>>> import magnopy

Sub-modules

• magnopy.io
• magnopy.scenarios
• magnopy.examples
• magnopy.si
• magnopy.experimental

Classes

Convention([multiple_counting, ...])	Convention of the spin Hamiltonian.
SpinHamiltonian(cell, atoms, convention[, units])	Spin Hamiltonian.
Energy(spinham)	Classical energy of the spin Hamiltonian.
LSWT(spinham, spin_directions)	Linear Spin Wave theory.
PlotlyEngine([fig, _sphinx_gallery_fix, ...])	Plotting engine based on Plotly.

Functions

solve_via_colpa(D)	Diagonalizes grand-dynamical matrix following the method of Colpa.
span_local_rf(direction_vector[, hybridize, ...])	Spans local right-handed reference frame from the direction vector.
span_local_rfs(directional_vectors[, ...])	Spans a set of local right-handed reference frames from a set of the direction vectors.
logo([info, line_length, flat, date_time, ...])	Generates a logo of Magnopy.
multiprocess_over_k(kpoints, function[, ...])	Parallelizes calculation over the kpoints using multiprocessing module.
make_supercell(spinham, supercell)	Creates a spin Hamiltonian on the supercell.
is_eigenstate(spinham, spin_directions[, ...])	Checks all eigenstate conditions as described in the supplementary note 4 of paper about Magnopy (eqs.

Interaction parameters

converter22	Routines for conversion of the full 3x3 tensor of 22 parameter into its parts and back.
converter43	Routines for conversion of the full 3x3x3x3 tensor of 43 parameter into its parts and back.
get_equivalent_parameters(nus, alphas[, ...])	Computes equivalent parameters as described in supplementary information of paper about Magnopy (eqs.

Exceptions

ConventionError(convention, property)	Raised if convention or part of the convention of spin Hamiltonian is not defined.
ColpaFailed()	Raised when diagonalization via Colpa fails.