166 lines
4.9 KiB
Plaintext
166 lines
4.9 KiB
Plaintext
---
|
||
title: FakeKolkata
|
||
description: API reference for qiskit.providers.fake_provider.FakeKolkata
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.providers.fake_provider.FakeKolkata
|
||
---
|
||
|
||
# FakeKolkata
|
||
|
||
<Class id="qiskit.providers.fake_provider.FakeKolkata" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py" signature="FakeKolkata" modifiers="class">
|
||
Bases: `FakePulseBackend`
|
||
|
||
A fake 27 qubit backend.
|
||
|
||
FakeBackend initializer.
|
||
|
||
**Parameters**
|
||
|
||
* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – backend configuration
|
||
* **time\_alive** (*int*) – time to wait before returning result
|
||
|
||
## Methods
|
||
|
||
<span id="qiskit-providers-fake-provider-fakekolkata-configuration" />
|
||
|
||
### configuration
|
||
|
||
<Function id="qiskit.providers.fake_provider.FakeKolkata.configuration" signature="FakeKolkata.configuration()">
|
||
Return the backend configuration.
|
||
|
||
**Returns**
|
||
|
||
the configuration for the backend.
|
||
|
||
**Return type**
|
||
|
||
[BackendConfiguration](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-fake-provider-fakekolkata-defaults" />
|
||
|
||
### defaults
|
||
|
||
<Function id="qiskit.providers.fake_provider.FakeKolkata.defaults" signature="FakeKolkata.defaults()">
|
||
Returns a snapshot of device defaults
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-fake-provider-fakekolkata-name" />
|
||
|
||
### name
|
||
|
||
<Function id="qiskit.providers.fake_provider.FakeKolkata.name" signature="FakeKolkata.name()">
|
||
Return the backend name.
|
||
|
||
**Returns**
|
||
|
||
the name of the backend.
|
||
|
||
**Return type**
|
||
|
||
str
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-fake-provider-fakekolkata-properties" />
|
||
|
||
### properties
|
||
|
||
<Function id="qiskit.providers.fake_provider.FakeKolkata.properties" signature="FakeKolkata.properties()">
|
||
Returns a snapshot of device properties
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-fake-provider-fakekolkata-provider" />
|
||
|
||
### provider
|
||
|
||
<Function id="qiskit.providers.fake_provider.FakeKolkata.provider" signature="FakeKolkata.provider()">
|
||
Return the backend Provider.
|
||
|
||
**Returns**
|
||
|
||
the Provider responsible for the backend.
|
||
|
||
**Return type**
|
||
|
||
[Provider](qiskit.providers.Provider "qiskit.providers.Provider")
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-fake-provider-fakekolkata-run" />
|
||
|
||
### run
|
||
|
||
<Function id="qiskit.providers.fake_provider.FakeKolkata.run" signature="FakeKolkata.run(run_input, **kwargs)">
|
||
Main job in simulator
|
||
</Function>
|
||
|
||
<span id="qiskit-providers-fake-provider-fakekolkata-set-options" />
|
||
|
||
### set\_options
|
||
|
||
<Function id="qiskit.providers.fake_provider.FakeKolkata.set_options" signature="FakeKolkata.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>
|
||
|
||
<span id="qiskit-providers-fake-provider-fakekolkata-status" />
|
||
|
||
### status
|
||
|
||
<Function id="qiskit.providers.fake_provider.FakeKolkata.status" signature="FakeKolkata.status()">
|
||
Return the backend status.
|
||
|
||
**Returns**
|
||
|
||
the status of the backend.
|
||
|
||
**Return type**
|
||
|
||
[BackendStatus](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus")
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### backend\_name
|
||
|
||
<Attribute id="qiskit.providers.fake_provider.FakeKolkata.backend_name" attributeValue="'fake_kolkata'" />
|
||
|
||
### conf\_filename
|
||
|
||
<Attribute id="qiskit.providers.fake_provider.FakeKolkata.conf_filename" attributeValue="'conf_kolkata.json'" />
|
||
|
||
### defs\_filename
|
||
|
||
<Attribute id="qiskit.providers.fake_provider.FakeKolkata.defs_filename" attributeValue="'defs_kolkata.json'" />
|
||
|
||
### dirname
|
||
|
||
<Attribute id="qiskit.providers.fake_provider.FakeKolkata.dirname" attributeValue="'/home/computertreker/git/qiskit/qiskit/.tox/docs/lib/python3.8/site-packages/qiskit/providers/fake_provider/backends/kolkata'" />
|
||
|
||
### options
|
||
|
||
<Attribute id="qiskit.providers.fake_provider.FakeKolkata.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.FakeKolkata#run "qiskit.providers.fake_provider.FakeKolkata.run") method.
|
||
</Attribute>
|
||
|
||
### props\_filename
|
||
|
||
<Attribute id="qiskit.providers.fake_provider.FakeKolkata.props_filename" attributeValue="'props_kolkata.json'" />
|
||
|
||
### version
|
||
|
||
<Attribute id="qiskit.providers.fake_provider.FakeKolkata.version" attributeValue="1" />
|
||
</Class>
|
||
|