148 lines
4.4 KiB
Plaintext
148 lines
4.4 KiB
Plaintext
---
|
||
title: FakeYorktown
|
||
description: API reference for qiskit.providers.fake_provider.FakeYorktown
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.providers.fake_provider.FakeYorktown
|
||
---
|
||
|
||
# FakeYorktown
|
||
|
||
<Class id="qiskit.providers.fake_provider.FakeYorktown" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py" signature="qiskit.providers.fake_provider.FakeYorktown" modifiers="class">
|
||
Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend")
|
||
|
||
A fake 5 qubit backend.
|
||
|
||
```python
|
||
1
|
||
/ |
|
||
0 - 2 - 3
|
||
| /
|
||
4
|
||
```
|
||
|
||
FakeBackend initializer.
|
||
|
||
**Parameters**
|
||
|
||
* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – backend configuration
|
||
* **time\_alive** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – time to wait before returning result
|
||
|
||
## Attributes
|
||
|
||
### backend\_name
|
||
|
||
<Attribute id="qiskit.providers.fake_provider.FakeYorktown.backend_name" attributeValue="'fake_yorktown'" />
|
||
|
||
### conf\_filename
|
||
|
||
<Attribute id="qiskit.providers.fake_provider.FakeYorktown.conf_filename" attributeValue="'conf_yorktown.json'" />
|
||
|
||
### dirname
|
||
|
||
<Attribute id="qiskit.providers.fake_provider.FakeYorktown.dirname" attributeValue="'/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/yorktown'" />
|
||
|
||
### options
|
||
|
||
<Attribute id="qiskit.providers.fake_provider.FakeYorktown.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.providers.fake_provider.FakeYorktown.run "qiskit.providers.fake_provider.FakeYorktown.run") method.
|
||
</Attribute>
|
||
|
||
### props\_filename
|
||
|
||
<Attribute id="qiskit.providers.fake_provider.FakeYorktown.props_filename" attributeValue="'props_yorktown.json'" />
|
||
|
||
### version
|
||
|
||
<Attribute id="qiskit.providers.fake_provider.FakeYorktown.version" attributeValue="1" />
|
||
|
||
## Methods
|
||
|
||
### configuration
|
||
|
||
<Function id="qiskit.providers.fake_provider.FakeYorktown.configuration" signature="configuration()">
|
||
Return the backend configuration.
|
||
|
||
**Returns**
|
||
|
||
the configuration for the backend.
|
||
|
||
**Return type**
|
||
|
||
[BackendConfiguration](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")
|
||
</Function>
|
||
|
||
### name
|
||
|
||
<Function id="qiskit.providers.fake_provider.FakeYorktown.name" signature="name()">
|
||
Return the backend name.
|
||
|
||
**Returns**
|
||
|
||
the name of the backend.
|
||
|
||
**Return type**
|
||
|
||
[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")
|
||
</Function>
|
||
|
||
### properties
|
||
|
||
<Function id="qiskit.providers.fake_provider.FakeYorktown.properties" signature="properties()">
|
||
Returns a snapshot of device properties
|
||
</Function>
|
||
|
||
### provider
|
||
|
||
<Function id="qiskit.providers.fake_provider.FakeYorktown.provider" signature="provider()">
|
||
Return the backend Provider.
|
||
|
||
**Returns**
|
||
|
||
the Provider responsible for the backend.
|
||
|
||
**Return type**
|
||
|
||
[Provider](qiskit.providers.Provider "qiskit.providers.Provider")
|
||
</Function>
|
||
|
||
### run
|
||
|
||
<Function id="qiskit.providers.fake_provider.FakeYorktown.run" signature="run(run_input, **kwargs)">
|
||
Main job in simulator
|
||
</Function>
|
||
|
||
### set\_options
|
||
|
||
<Function id="qiskit.providers.fake_provider.FakeYorktown.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**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.12)") – If the field passed in is not part of the options
|
||
</Function>
|
||
|
||
### status
|
||
|
||
<Function id="qiskit.providers.fake_provider.FakeYorktown.status" signature="status()">
|
||
Return the backend status.
|
||
|
||
**Returns**
|
||
|
||
the status of the backend.
|
||
|
||
**Return type**
|
||
|
||
[BackendStatus](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus")
|
||
</Function>
|
||
</Class>
|
||
|