# Superconducting

The superconducting module provides convenient methods to simulate and optimize superconducting systems.

To run a simulation or optimization, begin by describing the system using the classes below representing the components and interactions in the system. For example to create a superconducting transmon use boulderopal.superconducting.Transmon. If any Hamiltonian term is optimizable, use a boulderopal.superconducting.OptimizableCoefficient class to describe it. Then pass the classes to either boulderopal.superconducting.simulate or boulderopal.superconducting.optimize depending on whether you want to run a simulation or an optimization.

For a quick introduction, see the Simulate and optimize dynamics with the superconducting systems module tutorial.

## Classes

Cavity | Class that stores all the physical system data for a cavity. |

CavityCavityInteraction | Class that stores all the physical system data for the interaction between two cavities. |

ComplexOptimizableConstant | A complex-valued optimizable constant coefficient for a Hamiltonian term. |

ComplexOptimizableSignal | A complex-valued optimizable time-dependent piecewise-constant coefficient for a Hamiltonian term. |

OptimizableCoefficient | Abstract class for optimizable Hamiltonian coefficients. |

RealOptimizableConstant | A real-valued optimizable constant coefficient for a Hamiltonian term. |

RealOptimizableSignal | A real-valued optimizable time-dependent piecewise-constant coefficient for a Hamiltonian term. |

Transmon | Class that stores all the physical system data for a transmon. |

TransmonCavityInteraction | Class that stores all the physical system data for the interaction between a transmon and a cavity. |

TransmonTransmonInteraction | Class that stores all the physical system data for the interaction between two transmons. |

## Functions

optimize | Find optimal pulses or parameters for a system composed of transmons and cavities, in order to achieve a target state or implement a target operation. |

simulate | Simulate a system composed of transmons and cavities. |