Usage

A BathFitter instance is created as follows

from hqs_noise_app import BathFitter

bath_fitter = BathFitter(
    number_boson_modes=2,
    spins_per_bosonic_mode=1,
    broadening_constraint=[0.1, 0.1],
    background_broadening_ratio=0.1,
    minimum_eigenfrequencies=-2,
    maximum_eigenfrequencies=2,
    fitting_window=(-0.5, 1, 10),
    # specified if we are fitting a system-bath with a spin system
    coupling_types=["X"],
    max_fitting_iterations=5,
    max_fitting_error=0.05,
)

# Print docstring of a function in BathFitter
help(bath_fitter.fit_spin_bath_to_boson_bath)

The parameters of BathFitter are:

  • number_boson_modes: Number of bosonic modes used for the fit of bosonic baths
  • spins_per_bosonic_mode: Number of spin modes used to represent one bosonic mode.
  • broadening_constraint (Optional[List[float]]): The optional broadening constraints. When set to None, broadenings of bosonic modes are fitted freely. When given as a list, the relative broadening of all modes is fixed and only a prefactor is fitted. The prefactor corresponds to the Trotter timestep in a quantum cirucit.
  • background_broadening_ratio (float): Adds a constant background offset to the diagonal spectral functions when fitting. Given as a ratio of the average broadening.
  • minimum_eigenfrequencies (Optional[float]): Minimal value allowed for bath eigenfrequencies.
  • maximum_eigenfrequencies (Optional[float]): Maximum value allowed for bath eigenfrequencies.
  • fitting_window (Optional[Tuple[float, float, int]]): The frequency window used for the fitting (start, end, steps). If no values are provided, the functions uses the whole frequency range to determine the fit.
  • coupling_types (Optional[Union[Dict[Tuple[int, int], List[str]], List[str]]]): A list of the couplings to include (only relevant for spin systems). If None, all the couplings are used: X, Y, Z. The user can also specify this input as a dictionary, where the keys are pairs of indices (system spin index, bath boson index), and the values are the list of couplings (X, Y, Z) which apply to these indices.
  • coupling_indices (Optional[List[Tuple[int, int]]]): A list of allowed fermionic hopping operators of the form \(c^\dagger_j c_k\) that are allowed to couple to bosonic modes (only relevant for fermionic systems). For example [(0,0), (0,1)] only allows coupling operators \(c^\dagger_0 c_0\) and \(c^\dagger_0 c_1\).
  • max_fitting_iterations (int): The number of retries allowed when fitting the spectrum.
  • max_fitting_error (float): The maximum allowed fitting error in fitting the spectrum.

The HQS Bath Fitter uses a simple metric for the quality of the fit: Let \(A\) be the sum of squares of the difference between the fitter and target and \(B\) be the sum of squares of the fitted spectral function. The quality of the fit is defined as the ratio \(\frac{A}{B}\) where a small ratio corresponds to a good fit. By default, a deviation of 5% is allowed. If the criterion is not met, the fitting is retried and if the number of retries exceeds the maximum the fit fails. By default, the number of retries is 5.

More information about the input arguments and the returned systems can be obtained from help(bath_fitter.fit_spin_bath_to_boson_bath) for example.

More examples on how to use the BathFitter and different functions are in the examples section.