magnopy.SpinHamiltonian.units

property

property SpinHamiltonian.units: str

Units of the Hamiltonian's interaction parameters.

Added in version 0.3.0.

The parameters of the Hamiltonian are stored in some units of energy (or energy-like).

When user adds a parameters to the Hamiltonian (SpinHamiltonian.add()) the parameter argument is understood to be given in the units of SpinHamiltonian.units.

By default the Hamiltonian stores and expects parameters in "meV", but the user can choose out of the supported units. See Hamiltonian's parameters for the full list of supported units.

When Hamiltonian already has some parameters in it, then the change of SpinHamiltonian.units converts all parameter to the new units. The parameters that the user tries to add afterwards are expected to be in the new units.

Returns:

unitsstr

Notes

List of supported units can be fount in Units page.

Examples

See Units for more details on how to use this property.