Pulse library

Toolkit for pulse library.

The Boulder Opal Toolkits are currently in beta phase of development. Breaking changes may be introduced.

Graph nodes

Graph nodes to define common operations. You can access them from the pulses namespace of a Graph object. For example, to use cosine_pulse_pwc:

qctrl = Qctrl()
graph = qctrl.create_graph()
graph.pulses.cosine_pulse_pwc(...)

Following is a list of graph nodes in the pulses toolkit:

cosine_pulse_pwc

Create a Pwc representing a cosine pulse.

gaussian_pulse_pwc

Create a Pwc representing a Gaussian pulse.

gaussian_pulse_stf

Create an Stf representing a Gaussian pulse.

hann_series_pwc

Create a Pwc representing a sum of Hann window functions.

hann_series_stf

Create an Stf representing a sum of Hann window functions.

linear_ramp_pwc

Create a Pwc representing a linear ramp.

linear_ramp_stf

Create an Stf representing a linear ramp.

sech_pulse_pwc

Create a Pwc representing a hyperbolic secant pulse.

sech_pulse_stf

Create an Stf representing a hyperbolic secant pulse.

sinusoid_pwc

Create a Pwc representing a sinusoidal oscillation.

sinusoid_stf

Create an Stf representing a sinusoidal oscillation.

square_pulse_pwc

Create a Pwc representing a square pulse.

tanh_ramp_pwc

Create a Pwc representing a hyperbolic tangent ramp.

tanh_ramp_stf

Create an Stf representing a hyperbolic tangent ramp.

Functions

Methods to perform common tasks. You can access them from the pulses namespace of the Qctrl object. For example, to use cosine_pulse:

qctrl = Qctrl()
qctrl.pulses.cosine_pulse(...)

Following is a list of functions in the pulses toolkit:

cosine_pulse

Create a Pulse object representing a cosine pulse.

gaussian_pulse

Create a Pulse object representing a Gaussian pulse.

hann_series

Create a Pulse object representing a sum of Hann window functions.

linear_ramp

Create a Pulse object representing a linear ramp.

sech_pulse

Create a Pulse object representing a hyperbolic secant pulse.

sinusoid

Create a Pulse object representing a sinusoidal oscillation.

square_pulse

Create a Pulse object representing a square pulse.

tanh_ramp

Create a Pulse object representing a hyperbolic tangent ramp.

Classes

Classes to store common data types for the methods in the toolkit. You can access them from the pulses namespace of the Qctrl object. For example, to use Pulse:

qctrl = Qctrl()
qctrl.pulses.Pulse(...)

Following is a list of classes in the pulses toolkit:

Pulse

A class that contains information about a pulse that can be discretized.