QutipEmulator

class pulser_simulation.QutipEmulator(sampled_seq, register, device, sampling_rate=1.0, config=None, evaluation_times='Full')

Bases: object

Emulator of a pulse sequence using QuTiP.

Parameters:

sampled_seq (SequenceSamples) – A pulse sequence samples used in the emulation.
register (BaseRegister) – The register associating coordinates to the qubits targeted by the pulses within the samples.
device (BaseDevice) – The device specifications used in the emulation. Register and samples have to satisfy its constraints.
sampling_rate (float, default: 1.0) – The fraction of samples that we wish to extract from the samples to simulate. Has to be a value between 0.05 and 1.0.
config (SimConfig | None, default: None) – Configuration to be used for this simulation.
evaluation_times (float | str | ArrayLike, default: 'Full') –
Choose between:
- ”Full”: The times are set to be the ones used to define the Hamiltonian to the solver.
- ”Minimal”: The times are set to only include initial and final times.
- An ArrayLike object of times in µs if you wish to only include those specific times.
- A float to act as a sampling rate for the resulting state.

Attributes

`basis`	The basis in which result is expressed.
`basis_name`	The name of the basis.
`config`	The current configuration, as a SimConfig instance.
`dim`	The dimension of the basis.
`evaluation_times`	The times at which the results of this simulation are returned.
`initial_state`	The initial state of the simulation.
`sampling_times`	The times at which hamiltonian is sampled.

Methods

`add_config`	Updates the current configuration with parameters of another one.
`build_operator`	Creates an operator with non-trivial actions on some qubits.
`draw`	Draws the samples of a sequence of operations used for simulation.
`from_sequence`	Simulation of a pulse sequence using QuTiP.
`get_hamiltonian`	Get the Hamiltonian created from the sequence at a fixed time.
`reset_config`	Resets configuration to default.
`run`	Simulates the sequence using QuTiP's solvers.
`set_config`	Sets current config to cfg and updates simulation parameters.
`set_evaluation_times`	Sets times at which the results of this simulation are returned.
`set_initial_state`	Sets the initial state of the simulation.
`show_config`	Shows current configuration.

Signatures

add_config(config)

Updates the current configuration with parameters of another one.

Mostly useful when dealing with multiple noise types in different configurations and wanting to merge these configurations together. Adds simulation parameters to noises that weren’t available in the former SimConfig. Noises specified in both SimConfigs will keep former noise parameters.

Parameters:: config (SimConfig) – SimConfig to retrieve parameters from.
Return type:: None

build_operator(operations)

Creates an operator with non-trivial actions on some qubits.

Takes as argument a list of tuples [(operator_1, qubits_1), (operator_2, qubits_2)...]. Returns the operator given by the tensor product of {operator_i applied on qubits_i} and Id on the rest. (operator, 'global') returns the sum for all j of operator applied at qubit_j and identity elsewhere.

Example for 4 qubits: [(Z, [1, 2]), (Y, [3])] returns ZZYI and [(X, 'global')] returns XIII + IXII + IIXI + IIIX

Parameters:: operations (list | tuple) – List of tuples (operator, qubits). operator can be a qutip.Quobj or a string key for self.op_matrix. qubits is the list on which operator will be applied. The qubits can be passed as their index or their label in the register.
Return type:: Qobj
Returns:: The final operator.

draw(draw_phase_area=False, draw_phase_shifts=False, draw_phase_curve=False, fig_name=None, kwargs_savefig={})

Draws the samples of a sequence of operations used for simulation.

Parameters:

draw_phase_area (bool, default: False) – Whether phase and area values need to be shown as text on the plot, defaults to False.
draw_phase_shifts (bool, default: False) – Whether phase shift and reference information should be added to the plot, defaults to False.
draw_phase_curve (bool, default: False) – Draws the changes in phase in its own curve (ignored if the phase doesn’t change throughout the channel).
fig_name (str | None, default: None) – The name on which to save the figure. If None the figure will not be saved.
kwargs_savefig (dict, default: {}) – Keywords arguments for matplotlib.pyplot.savefig. Not applicable if fig_name is None.

Return type:

None