Global parameters

This module provides the Parameters class which contains all the necessary global parameters required for spin dynamics simulations. It is instantiated when the Spinguin package is imported and can be accessed by:

import spinguin as sg
sg.parameters.PARAMETERNAME = VALUE

class Parameters

Parameters class contains all the global settings for the Spinguin package.

property magnetic_field: float

External magnetic field (in Tesla).

property parallel_dim: int

If the number of items in the basis is larger than this value, parallelization is used to speed up the calculation of the Redfield relaxation superoperator.

property propagator_density: float

Threshold (between 0 and 1) that specifies the array type of the time propagator. If the density of the progagator is greater than this value, dense array is returned. Otherwise, sparse array is returned.

property sparse_hamiltonian: bool

Specifies whether to return the Hamiltonian as sparse or dense array.

property sparse_operator: bool

Specifies whether to return the Hilbert-space operators as sparse or dense arrays.

property sparse_pulse: bool

Specifies whether to return pulse superoperators as sparse or dense arrays.

property sparse_relaxation: bool

Specifies whether to return the relaxation superoperator as sparse or dense array.

property sparse_state: bool

Specifies whether to return the state vectors as sparse or dense arrays.

property sparse_superoperator: bool

Specifies whether to return the superoperators as sparse or dense arrays.

property temperature: float

Temperature of the sample (in Kelvin).

property zero_aux: float

Threshold under which a value is considered to be zero in auxiliary matrix method which is used in the Redfield relaxation theory.

property zero_equilibrium: float

Threshold under which a value is considered to be zero when performing the matrix exponential while constructing the equilibrium state.

property zero_hamiltonian: float

Threshold under which a value is considered to be zero in Hamiltonian.

property zero_interaction: float

If the 1-norm of an interaction tensor (upper bound for its eigenvalues) is smaller than this threshold, the interaction is ignored when constructing the Redfield relaxation superoperator.

property zero_propagator: float

Threshold under which a value is considered to be zero in propagator. This value is used to as the convergence criterion of the Taylor series that is used to compute the matrix exponential.

property zero_pulse: float

Threshold under which a value is considered to be zero in pulse. This value is used as the convergence criterion of the Taylor series that is used to compute the matrix exponential.

property zero_relaxation: float

Threshold under which a value is considered to be zero in relaxation superoperator.

property zero_thermalization: float

Threshold under which a value is considered to be zero when performing the matrix exponential while applying the Levitt-di Bari thermalization. This value is used as the convergence criterion of the Taylor series.