150 lines
4.0 KiB
Plaintext
150 lines
4.0 KiB
Plaintext
---
|
||
title: FakeEssex (v0.29)
|
||
description: API reference for qiskit_ibm_runtime.fake_provider.FakeEssex in qiskit-ibm-runtime v0.29
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex
|
||
---
|
||
|
||
# FakeEssex
|
||
|
||
<Class id="qiskit_ibm_runtime.fake_provider.FakeEssex" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py#L39-L54" signature="FakeEssex" modifiers="class">
|
||
A fake 5 qubit backend.
|
||
|
||
```text
|
||
0 ↔ 1 ↔ 2
|
||
↕
|
||
3
|
||
↕
|
||
4
|
||
```
|
||
|
||
FakeBackend initializer.
|
||
|
||
**Parameters**
|
||
|
||
* **configuration** (*BackendConfiguration*) – backend configuration
|
||
* **time\_alive** (*int*) – time to wait before returning result
|
||
|
||
## Attributes
|
||
|
||
### backend\_name
|
||
|
||
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssex.backend_name" attributeValue="'fake_essex'" />
|
||
|
||
### conf\_filename
|
||
|
||
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssex.conf_filename" attributeValue="'conf_essex.json'" />
|
||
|
||
### dirname
|
||
|
||
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssex.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/essex'" />
|
||
|
||
### options
|
||
|
||
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssex.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()`](#qiskit_ibm_runtime.fake_provider.FakeEssex.run "qiskit_ibm_runtime.fake_provider.FakeEssex.run") method.
|
||
</Attribute>
|
||
|
||
### props\_filename
|
||
|
||
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssex.props_filename" attributeValue="'props_essex.json'" />
|
||
|
||
### version
|
||
|
||
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssex.version" attributeValue="1" />
|
||
|
||
## Methods
|
||
|
||
### configuration
|
||
|
||
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssex.configuration" signature="configuration()">
|
||
Return the backend configuration.
|
||
|
||
**Returns**
|
||
|
||
the configuration for the backend.
|
||
|
||
**Return type**
|
||
|
||
BackendConfiguration
|
||
</Function>
|
||
|
||
### name
|
||
|
||
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssex.name" signature="name()">
|
||
Return the backend name.
|
||
|
||
**Returns**
|
||
|
||
the name of the backend.
|
||
|
||
**Return type**
|
||
|
||
str
|
||
</Function>
|
||
|
||
### properties
|
||
|
||
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssex.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L43-L47" signature="properties()">
|
||
Returns a snapshot of device properties
|
||
|
||
**Return type**
|
||
|
||
`BackendProperties`
|
||
</Function>
|
||
|
||
### provider
|
||
|
||
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssex.provider" signature="provider()">
|
||
Return the backend Provider.
|
||
|
||
**Returns**
|
||
|
||
the Provider responsible for the backend.
|
||
|
||
**Return type**
|
||
|
||
Provider
|
||
</Function>
|
||
|
||
### run
|
||
|
||
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssex.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L744-L775" signature="run(run_input, **kwargs)">
|
||
Main job in simulator
|
||
</Function>
|
||
|
||
### set\_options
|
||
|
||
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssex.set_options" signature="set_options(**fields)">
|
||
Set the options fields for the backend
|
||
|
||
This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options.
|
||
|
||
**Parameters**
|
||
|
||
**fields** – The fields to update the options
|
||
|
||
**Raises**
|
||
|
||
**AttributeError** – If the field passed in is not part of the options
|
||
</Function>
|
||
|
||
### status
|
||
|
||
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssex.status" signature="status()">
|
||
Return the backend status.
|
||
|
||
**Returns**
|
||
|
||
the status of the backend.
|
||
|
||
**Return type**
|
||
|
||
BackendStatus
|
||
</Function>
|
||
</Class>
|
||
|