qiskit-documentation/docs/api/qiskit-ibm-runtime/0.18/qiskit_ibm_runtime.fake_pro...

152 lines
4.0 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: FakeAlmaden (v0.18)
description: API reference for qiskit_ibm_runtime.fake_provider.FakeAlmaden in qiskit-ibm-runtime v0.18
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden
---
# FakeAlmaden
<Class id="qiskit_ibm_runtime.fake_provider.FakeAlmaden" isDedicatedPage={true} github="https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.18/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py" signature="FakeAlmaden" modifiers="class">
A fake Almaden backend.
```text
00 ↔ 01 ↔ 02 ↔ 03 ↔ 04
↕ ↕
05 ↔ 06 ↔ 07 ↔ 08 ↔ 09
↕ ↕ ↕
10 ↔ 11 ↔ 12 ↔ 13 ↔ 14
↕ ↕
15 ↔ 16 ↔ 17 ↔ 18 ↔ 19
```
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.FakeAlmaden.backend_name" attributeValue="'fake_almaden'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmaden.conf_filename" attributeValue="'conf_almaden.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmaden.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/almaden'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmaden.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.FakeAlmaden.run "qiskit_ibm_runtime.fake_provider.FakeAlmaden.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmaden.props_filename" attributeValue="'props_almaden.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmaden.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmaden.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.FakeAlmaden.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.FakeAlmaden.properties" signature="properties()">
Returns a snapshot of device properties
**Return type**
`BackendProperties`
</Function>
### provider
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmaden.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.FakeAlmaden.run" signature="run(run_input, **kwargs)">
Main job in simulator
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmaden.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.FakeAlmaden.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>