SpinToolkit python documentation

Class

class spintoolkit_py.units

Bases: pybind11_builtins.pybind11_object

Physical constants in units of reference energy and length.

__init__(self: spintoolkit_py.units, *, energy: str = 'K', length: str = 'angstrom') → None

Constructor. Sets the reference energy and length scales. All other constants are converted to these base units.

Parameters:

• energy – Reference energy unit. Possible values: [“meV”, “K”, “THz”, “inverse_cm”, “T”]. (Default: “K”)

• length – Reference length unit. Possible values: [“angstrom”, “nm”]. (Default: “angstrom”)

property K

Conversion factor for 1 Kelvin to the reference energy.

property T

Conversion factor for 1 Tesla to the reference energy.

property THz

Conversion factor for 1 Terahertz to the reference energy.

property angstrom

Conversion factor for 1 Angstrom to the reference length.

property energy

The chosen reference energy unit.

property inverse_cm

Conversion factor for centimeter to the reference energy.

property length

The chosen reference length unit.

property meV

Conversion factor for 1 millielectronvolt to the reference energy.

property nm

Conversion factor for 1 nanometer to the reference length.

property vacuum_permeability

Vacuum permeability \(\mu_0\) in consistent units.