Coil

Class Arguments

Argument	Type	Default Value
current_source	CurrentSource
calibration	Calibration
switch	Switchable	None

Bold arguments are mandatory. For more documentation on the listed arguments refer to the class definition below. If parameters appear in this list but not in the class definition below, please recursively check the linked base classes for the definition of the parameter.

Inheritance Diagram

Example Component Dictionary

   {
    "coil_example": {
        "classname": "atomiq.components.coil.Coil",
        "arguments": {
            "current_source": "<mandatory parameter (CurrentSource)>",
            "calibration": "<mandatory parameter (Calibration)>",
            "switch": null
        }
    }
}

Class Description

class atomiq.components.coil.Coil(current_source, calibration, switch=None, *args, **kwargs)

Bases: Component, Parametrizable, Switchable

A single coil driven by a current source.

It is characterized by a calibration that returns the B field for a given current through the coil.

Parameters:

• current_source (CurrentSource) -- The current source that drives the coil

• calibration (Calibration) -- The conversion between current in the coil and magnetic field at the point of interest.

• switch (Switchable) -- An optional switch to switch on and off the current in the coil. If none is given and the current source is switchable, the current source is used for switching. If no switch is given and the current source is not switchable, an error is raised.

A Parametrizable is an entity that can be controlled by one or more continuous parameter(s)