PulseSimulator

class PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)

Bases: qiskit.providers.aer.backends.aerbackend.AerBackend

Pulse schedule simulator backend.

The PulseSimulator simulates continuous time Hamiltonian dynamics of a quantum system, with controls specified by pulse Schedule objects, and the model of the physical system specified by PulseSystemModel objects. Results are returned in the same format as when jobs are submitted to actual devices.

Examples

The minimal information a PulseSimulator needs to simulate is a PulseSystemModel, which can be supplied either by setting the backend option before calling run, e.g.:

backend_sim = qiskit.providers.aer.PulseSimulator()

# Set the pulse system model for the simulator
backend_sim.set_options(system_model=system_model)

# Assemble schedules using PulseSimulator as the backend
pulse_qobj = assemble(schedules, backend=backend_sim)

# Run simulation
results = backend_sim.run(pulse_qobj)

or by supplying the system model at runtime, e.g.:

backend_sim = qiskit.providers.aer.PulseSimulator()

# Assemble schedules using PulseSimulator as the backend
pulse_qobj = assemble(schedules, backend=backend_sim)

# Run simulation on a PulseSystemModel object
results = backend_sim.run(pulse_qobj, system_model=system_model)

Alternatively, an instance of the PulseSimulator may be further configured to contain more information present in a real backend. The simplest way to do this is to instantiate the PulseSimulator from a real backend:

armonk_sim = qiskit.providers.aer.PulseSimulator.from_backend(FakeArmonk())
pulse_qobj = assemble(schedules, backend=armonk_sim)
armonk_sim.run(pulse_qobj)

In the above example, the PulseSimulator copies all configuration and default data from FakeArmonk(), and as such has the same affect as FakeArmonk() when passed as an argument to assemble. Furthermore it constructs a PulseSystemModel from the model details in the supplied backend, which is then used in simulation.

Supported PulseQobj parameters

• qubit_lo_freq: Local oscillator frequencies for each DriveChannel. Defaults to either the value given in the PulseSystemModel, or is calculated directly from the Hamiltonian.

• meas_level: Type of desired measurement output, in [1, 2]. 1 gives complex numbers (IQ values), and 2 gives discriminated states |0> and |1>. Defaults to 2.

• meas_return: Measurement type, 'single' or 'avg'. Defaults to 'avg'.

• shots: Number of shots per experiment. Defaults to 1024.

Simulation details

The simulator uses the zvode differential equation solver method through scipy. Simulation is performed in the rotating frame of the diagonal of the drift Hamiltonian contained in the PulseSystemModel. Measurements are performed in the dressed basis of the drift Hamiltonian.

Other options

Additional valid keyword arguments for run():

• 'solver_options': A dict for solver options. Accepted keys are 'atol', 'rtol', 'nsteps', 'max_step', 'num_cpus', 'norm_tol', and 'norm_steps'.

Aer class for backends.

This method should initialize the module and its configuration, and raise an exception if a component of the module is not available.

Parameters

• configuration (BackendConfiguration) – backend configuration.

• properties (BackendProperties or None) – Optional, backend properties.

• defaults (PulseDefaults or None) – Optional, backend pulse defaults.

• available_methods (list or None) – Optional, the available simulation methods if backend supports multiple methods.

• provider (Provider) – Optional, provider responsible for this backend.

• backend_options (dict or None) – Optional set custom backend options.

Raises

AerError – if there is no name in the configuration

Methods

available_methods	Return the available simulation methods.
clear_options	Reset the simulator options to default values.
configuration	Return the simulator backend configuration.
defaults	Return the simulator backend pulse defaults.
from_backend	Initialize simulator from backend.
name	Return the backend name.
properties	Return the simulator backend properties if set.
provider	Return the backend Provider.
run	Run a qobj on the backend.
set_option	Set pulse simulation options and update backend.
set_options	Set the options fields for the backend
status	Return backend status.

Attributes

options

Return the options for the backend

The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the run() method.

version = 1