CurrentSource#

Class Arguments

Argument	Type	Default Value
min_current	TFloat	-inf
max_current	TFloat	inf
default_ramp_steps	TInt32	30

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

   {
    "currentsource_example": {
        "classname": "atomiq.components.electronics.currentsource.CurrentSource",
        "arguments": {
            "min_current": -1e999,
            "max_current": 1e999,
            "default_ramp_steps": 30
        }
    }
}

Class Description

class atomiq.components.electronics.currentsource.CurrentSource(min_current=- inf, max_current=inf, default_ramp_steps=30, *args, **kwargs)

Bases: Component, Parametrizable

Current Source

This abstract class represents any device that can output a defined, controllable current.

Parameters:

min_current (TFloat) -- The minimum current the device can output [A]
max_current (TFloat) -- The maximum current the device can output [A]
default_ramp_steps (TInt32) -- The default number of steps that this device should use if the current is ramped. This value is only used if no ramp_steps are given in the ramp_current() method.

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

set_current(current)

Set the current delivered by the current source

Parameters:: current (TFloat) -- Current in A

ramp_current(duration, current_start, current_end, ramp_timestep=- 1.0, ramp_steps=- 1)

Ramp current over a given duration.

This method advances the timeline by duration

Parameters:

duration (TFloat) -- ramp duration [s]
current_start (TFloat) -- initial current [V]
current_end (TFloat) -- end current [V]
ramp_timestep (TFloat) --
ramp_steps (TInt32) --