Element Classes

Capacitor

class SQcircuit.Capacitor(value, unit=None, Q='default', error=0, id_str=None)[source]

Class that contains the capacitor properties.

Parameters

value (float) – The value of the capacitor.
unit (Optional[str]) – The unit of input value. If unit is “THz”, “GHz”, and ,etc., the value specifies the charging energy of the capacitor. If unit is “fF”, “pF”, and ,etc., the value specifies the capacitance in farad. If unit is None, the default unit of capacitor is “GHz”.
Q (Union[Any, Callable[[float], float]]) – Quality factor of the dielectric of the capacitor which is one over tangent loss. It can be either a float number or a Python function of angular frequency.
error (float) – The error in fabrication as a percentage.
id_str (Optional[str]) – ID string for the capacitor.

energy()[source]

Return the charging energy of the capacitor in frequency unit of SQcircuit (gigahertz by default).

Return type: float

value(random=False)[source]

Return the value of the capacitor in farad units. If random is True, it samples from a normal distribution with variance defined by the fabrication error.

Parameters: random (bool) – A boolean flag which specifies whether the output is deterministic or random.
Return type: float

Inductor

class SQcircuit.Inductor(value, unit=None, cap=None, Q='default', error=0, loops=None, id_str=None)[source]

Class that contains the inductor properties.

Parameters

value (float) – The value of the inductor.
unit (Optional[str]) – The unit of input value. If unit is “THz”, “GHz”, and ,etc., the value specifies the inductive energy of the inductor. If unit is “fH”, “pH”, and ,etc., the value specifies the inductance in henry. If unit is None, the default unit of inductor is “GHz”.
loops (Optional[List[Loop]]) – List of loops in which the inductor resides.
cap (Optional[Capacitor]) – Capacitor associated to the inductor, necessary for correct time-dependent external fluxes scheme.
Q (Union[Any, Callable[[float, float], float]]) – Quality factor of the inductor needed for inductive loss calculation. It can be either a float number or a Python function of angular frequency and temperature.
error (float) – The error in fabrication as a percentage.
id_str (Optional[str]) – ID string for the inductor.

energy()[source]

Return the inductive energy of the capacitor in frequency unit of SQcircuit (gigahertz by default).

Return type: float

value(random=False)[source]

Return the value of the inductor in henry units. If random is True, it samples from a normal distribution with variance defined by the fabrication error.

Parameters: random (bool) – A boolean flag which specifies whether the output is deterministic or random.
Return type: float

Junction

class SQcircuit.Junction(value, unit=None, cap=None, A=1e-07, x=3e-06, delta=0.00034, Y='default', error=0, loops=None, id_str=None)[source]

Class that contains the Josephson junction properties.

Parameters

value (float) – The value of the Josephson junction.
unit (str) – The unit of input value. The unit can be “THz”, “GHz”, and ,etc., that specifies the junction energy of the inductor. If unit is None, the default unit of junction is “GHz”.
loops (Optional[List[Loop]]) – List of loops in which the Josephson junction reside.
cap (Optional[str]) – Capacitor associated to the josephson junction, necessary for the correct time-dependent external fluxes scheme.
A (float) – Normalized noise amplitude related to critical current noise.
x (float) – Quasiparticle density
delta (float) – Superconducting gap
Y (Union[Any, Callable[[float, float], float]]) – Real part of admittance.
error (float) – The error in fabrication as a percentage.
id_str (Optional[str]) – ID string for the junction.

value(random=False)[source]

Return the value of the Josephson Junction in angular frequency. If random is True, it samples from a normal distribution with variance defined by the fabrication error.

Parameters: random (bool) – A boolean flag which specifies whether the output is deterministic or random.
Return type: float

Loop

class SQcircuit.Loop(value=0, A=1e-06, id_str=None)[source]

Class that contains the inductive loop properties, closed path of inductive elements.

Parameters

value (float) – Value of the external flux at the loop.
A (float) – Normalized noise amplitude related to flux noise.
id_str (Optional[str]) – ID string for the loop.

set_flux(value)[source]

Set the external flux associated to the loop.

Parameters: value (float) – The external flux value
Return type: None

value(random=False)[source]

Return the value of the external flux. If random is True, it samples from a normal distribution with variance defined by the flux noise amplitude.

Parameters: random (bool) – A boolean flag which specifies whether the output is deterministic or random.
Return type: float