QasmSimulatorPy
QasmSimulatorPy(configuration=None, provider=None)
Python implementation of a qasm simulator.
Base 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
- provider (BaseProvider) – provider responsible for this backend
Raises
QiskitError – if an error occurred when instantiating the backend.
Attributes
DEFAULT_CONFIGURATION
= {'backend_name': 'qasm_simulator', 'backend_version': '2.0.0', 'basis_gates': ['u1', 'u2', 'u3', 'cx', 'id', 'unitary'], 'conditional': True, 'coupling_map': None, 'description': 'A python simulator for qasm experiments', 'gates': [{'name': 'u1', 'parameters': ['lambda'], 'qasm_def': 'gate u1(lambda) q { U(0,0,lambda) q; }'}, {'name': 'u2', 'parameters': ['phi', 'lambda'], 'qasm_def': 'gate u2(phi,lambda) q { U(pi/2,phi,lambda) q; }'}, {'name': 'u3', 'parameters': ['theta', 'phi', 'lambda'], 'qasm_def': 'gate u3(theta,phi,lambda) q { U(theta,phi,lambda) q; }'}, {'name': 'cx', 'parameters': ['c', 't'], 'qasm_def': 'gate cx c,t { CX c,t; }'}, {'name': 'id', 'parameters': ['a'], 'qasm_def': 'gate id a { U(0,0,0) a; }'}, {'name': 'unitary', 'parameters': ['matrix'], 'qasm_def': 'unitary(matrix) q1, q2,...'}], 'local': True, 'max_shots': 65536, 'memory': True, 'n_qubits': 24, 'open_pulse': False, 'simulator': True, 'url': 'https://github.com/Qiskit/qiskit-terra'}
DEFAULT_OPTIONS
= {'chop_threshold': 1e-15, 'initial_statevector': None}
MAX_QUBITS_MEMORY
= 32
SHOW_FINAL_STATE
= False
Methods
configuration
QasmSimulatorPy.configuration()
Return the backend configuration.
Returns
the configuration for the backend.
Return type
name
QasmSimulatorPy.name()
Return the backend name.
Returns
the name of the backend.
Return type
str
properties
QasmSimulatorPy.properties()
Return the backend properties.
Returns
the configuration for the backend. If the backend does not support properties, it returns None.
Return type
provider
QasmSimulatorPy.provider()
run
QasmSimulatorPy.run(qobj, backend_options=None)
Run qobj asynchronously.
Parameters
- qobj (Qobj) – payload of the experiment
- backend_options (dict) – backend options
Returns
derived from BaseJob
Return type
Additional Information:
backend_options: Is a dict of options for the backend. It may contain
- “initial_statevector”: vector_like
The “initial_statevector” option specifies a custom initial initial statevector for the simulator to be used instead of the all zero state. This size of this vector must be correct for the number of qubits in all experiments in the qobj.
Example:
backend_options = {
"initial_statevector": np.array([1, 0, 0, 1j]) / np.sqrt(2),
}run_experiment
QasmSimulatorPy.run_experiment(experiment)
Run an experiment (circuit) and return a single experiment result.
Parameters
experiment (QobjExperiment) – experiment from qobj experiments list
Returns
A result dictionary which looks something like:
{
"name": name of this experiment (obtained from qobj.experiment header)
"seed": random seed used for simulation
"shots": number of shots used in the simulation
"data":
{
"counts": {'0x9: 5, ...},
"memory": ['0x9', '0xF', '0x1D', ..., '0x9']
},
"status": status string for the simulation
"success": boolean
"time_taken": simulation time of this single experiment
}Return type
dict
Raises
BasicAerError – if an error occurred.
status
QasmSimulatorPy.status()
version
QasmSimulatorPy.version()
Return the backend version.
Returns
the X.X.X version of the backend.
Return type
str