API reference

Solvers

Time-domain and spatial-propagation solvers.

mb_solve.MBSolve
ob_solve.OBSolve	Time-domain master equation solver for a single spatial point.

Atoms and fields

ob_atom.OBAtom
field.Field	Field object to address the OBAtom object, describing the atomic levels

Time functions

t_funcs.square	Return a square (top-hat) pulse time function.
t_funcs.gaussian	Return a Gaussian pulse time function.
t_funcs.sech	Return a sech pulse time function.
t_funcs.ramp_on	Return a ramp-on time function.
t_funcs.ramp_off	Return a ramp-off time function.
t_funcs.ramp_onoff	Return a ramp-on / ramp-off time function.
t_funcs.ramp_offon	Return a ramp-off / ramp-on time function.
t_funcs.sinc	Return a sinc pulse time function.
t_funcs.intp	Return an interpolated time function.

Spectral analysis

spectral.freq_list	Fourier transform of the tlist into the frequency domain for
spectral.rabi_freq	Fourier transform of the field result of field index.
spectral.absorption	Field absorption in the frequency domain.
spectral.dispersion	Field dispersion in the frequency domain.
spectral.susceptibility_two_linear_known	In the linear regime for a two-level system, the susceptibility is
spectral.absorption_two_linear_known	The field absorption, equal to the imaginary part of the susceptibility.
spectral.dispersion_two_linear_known	The field dispersion, equal to the real part of the susceptibility.
spectral.voigt_two_linear_known	Returns the Voigt profile for a two-level system in the linear regime.

Hyperfine structure

hyperfine.Atom1e	Represents an atom object and contains a list of J levels.
hyperfine.LevelF	Represents an F hyperfine structure level and holds its magnetic
hyperfine.LevelMF	Represents an m_F hyperfine sublevel.

Utilities

utility.maxwell_boltzmann	Maxwell-Boltzmann probability distribution.
utility.half_max_roots	Return the half-maximum value and the two roots where y crosses it.
utility.full_width_at_half_max	Return the full width at half maximum (FWHM) of a peak.