API reference

Release:

0.2.1

The main interface to the package should be imported as

>>> import magnopy

Sub-modules

• Input-output (io)
• scenarios
• examples
• experimental

Classes

Convention([multiple_counting, ...])	Convention of the spin Hamiltonian.
SpinHamiltonian(cell, atoms, convention)	Spin Hamiltonian.
Energy(spinham)	Ground state energy of the given 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[, sort_by_first_N])	Diagonalize grand-dynamical matrix following the method of Colpa (section 3, remark 1 of [Readbd59eda8c-1]).
span_local_rf(direction_vector[, hybridize])	Span local right-handed reference frame based on the direction vector.
span_local_rfs(directional_vectors[, hybridize])	Span a series of local right-handed reference frames based on a series of the direction vectors.
logo([info, line_length, flat, date_time, ...])	Logo generator for Magnopy package.
multiprocess_over_k(kpoints, function[, ...])	Parallelize calculation over the kpoints using multiprocessing module.
make_supercell(spinham, supercell)	Creates a spin Hamiltonian on the supercell of the given one.

Parameter converters

converter22
converter422

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.