scnc
/
qiskit-documentation
mirror of https://github.com/Qiskit/documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Generate Runtime 0.30 (#2025)

This commit is contained in:
Eric Arellano 2024-09-24 12:14:09 -04:00 committed by GitHub
parent 14c80a2a79
commit 84023c225e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
350 changed files with 41559 additions and 1589 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api/qiskit-ibm-runtime/0.29/_package.json Normal file
View File

@ -0,0 +1,4 @@
{
"name": "qiskit-ibm-runtime",
"version": "0.29.0"
}

655
docs/api/qiskit-ibm-runtime/0.29/_toc.json Normal file
View File

@ -0,0 +1,655 @@
{
"title": "Qiskit Runtime Client",
"children": [
{
"title": "API index",
"url": "/api/qiskit-ibm-runtime/0.29"
},
{
"title": "qiskit_ibm_runtime",
"children": [
{
"title": "Module overview",
"url": "/api/qiskit-ibm-runtime/0.29/runtime_service"
},
{
"title": "Batch",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.Batch"
},
{
"title": "Estimator",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.Estimator"
},
{
"title": "EstimatorV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.EstimatorV2"
},
{
"title": "IBMBackend",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.IBMBackend"
},
{
"title": "QiskitRuntimeService",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.QiskitRuntimeService"
},
{
"title": "RuntimeDecoder",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.RuntimeDecoder"
},
{
"title": "RuntimeEncoder",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.RuntimeEncoder"
},
{
"title": "RuntimeJob",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.RuntimeJob"
},
{
"title": "RuntimeJobV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.RuntimeJobV2"
},
{
"title": "Sampler",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.Sampler"
},
{
"title": "SamplerV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.SamplerV2"
},
{
"title": "Session",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.Session"
}
]
},
{
"title": "qiskit_ibm_runtime.execution_span",
"children": [
{
"title": "Module overview",
"url": "/api/qiskit-ibm-runtime/0.29/execution_span"
},
{
"title": "ExecutionSpan",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.execution_span.ExecutionSpan"
},
{
"title": "ExecutionSpans",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.execution_span.ExecutionSpans"
},
{
"title": "ShapeType",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.execution_span.ShapeType"
},
{
"title": "SliceSpan",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.execution_span.SliceSpan"
}
]
},
{
"title": "qiskit_ibm_runtime.fake_provider",
"children": [
{
"title": "Module overview",
"url": "/api/qiskit-ibm-runtime/0.29/fake_provider"
},
{
"title": "FakeAlgiers",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeAlgiers"
},
{
"title": "FakeAlmaden",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeAlmaden"
},
{
"title": "FakeAlmadenV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2"
},
{
"title": "FakeArmonk",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeArmonk"
},
{
"title": "FakeArmonkV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeArmonkV2"
},
{
"title": "FakeAthens",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeAthens"
},
{
"title": "FakeAthensV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeAthensV2"
},
{
"title": "FakeAuckland",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeAuckland"
},
{
"title": "FakeBelem",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBelem"
},
{
"title": "FakeBelemV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBelemV2"
},
{
"title": "FakeBoeblingen",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBoeblingen"
},
{
"title": "FakeBoeblingenV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2"
},
{
"title": "FakeBogota",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBogota"
},
{
"title": "FakeBogotaV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBogotaV2"
},
{
"title": "FakeBrisbane",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBrisbane"
},
{
"title": "FakeBrooklyn",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBrooklyn"
},
{
"title": "FakeBrooklynV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2"
},
{
"title": "FakeBurlington",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBurlington"
},
{
"title": "FakeBurlingtonV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2"
},
{
"title": "FakeCairo",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeCairo"
},
{
"title": "FakeCairoV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeCairoV2"
},
{
"title": "FakeCambridge",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeCambridge"
},
{
"title": "FakeCambridgeV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2"
},
{
"title": "FakeCasablanca",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeCasablanca"
},
{
"title": "FakeCasablancaV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2"
},
{
"title": "FakeCusco",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeCusco"
},
{
"title": "FakeEssex",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeEssex"
},
{
"title": "FakeEssexV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeEssexV2"
},
{
"title": "FakeFractionalBackend",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend"
},
{
"title": "FakeGeneva",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeGeneva"
},
{
"title": "FakeGuadalupe",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeGuadalupe"
},
{
"title": "FakeGuadalupeV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2"
},
{
"title": "FakeHanoi",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeHanoi"
},
{
"title": "FakeHanoiV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeHanoiV2"
},
{
"title": "FakeJakarta",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeJakarta"
},
{
"title": "FakeJakartaV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeJakartaV2"
},
{
"title": "FakeJohannesburg",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeJohannesburg"
},
{
"title": "FakeJohannesburgV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2"
},
{
"title": "FakeKawasaki",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeKawasaki"
},
{
"title": "FakeKolkata",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeKolkata"
},
{
"title": "FakeKolkataV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeKolkataV2"
},
{
"title": "FakeKyiv",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeKyiv"
},
{
"title": "FakeKyoto",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeKyoto"
},
{
"title": "FakeLagos",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeLagos"
},
{
"title": "FakeLagosV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeLagosV2"
},
{
"title": "FakeLima",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeLima"
},
{
"title": "FakeLimaV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeLimaV2"
},
{
"title": "FakeLondon",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeLondon"
},
{
"title": "FakeLondonV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeLondonV2"
},
{
"title": "FakeManhattan",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeManhattan"
},
{
"title": "FakeManhattanV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeManhattanV2"
},
{
"title": "FakeManila",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeManila"
},
{
"title": "FakeManilaV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeManilaV2"
},
{
"title": "FakeMelbourne",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeMelbourne"
},
{
"title": "FakeMelbourneV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2"
},
{
"title": "FakeMontreal",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeMontreal"
},
{
"title": "FakeMontrealV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeMontrealV2"
},
{
"title": "FakeMumbai",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeMumbai"
},
{
"title": "FakeMumbaiV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2"
},
{
"title": "FakeNairobi",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeNairobi"
},
{
"title": "FakeNairobiV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeNairobiV2"
},
{
"title": "FakeOsaka",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeOsaka"
},
{
"title": "FakeOslo",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeOslo"
},
{
"title": "FakeOurense",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeOurense"
},
{
"title": "FakeOurenseV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeOurenseV2"
},
{
"title": "FakeParis",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeParis"
},
{
"title": "FakeParisV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeParisV2"
},
{
"title": "FakePeekskill",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakePeekskill"
},
{
"title": "FakePerth",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakePerth"
},
{
"title": "FakePoughkeepsie",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie"
},
{
"title": "FakePoughkeepsieV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2"
},
{
"title": "FakePrague",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakePrague"
},
{
"title": "FakeProvider",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeProvider"
},
{
"title": "FakeProviderForBackendV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2"
},
{
"title": "FakeQuebec",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeQuebec"
},
{
"title": "FakeQuito",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeQuito"
},
{
"title": "FakeQuitoV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeQuitoV2"
},
{
"title": "FakeRochester",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeRochester"
},
{
"title": "FakeRochesterV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeRochesterV2"
},
{
"title": "FakeRome",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeRome"
},
{
"title": "FakeRomeV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeRomeV2"
},
{
"title": "FakeRueschlikon",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeRueschlikon"
},
{
"title": "FakeSantiago",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeSantiago"
},
{
"title": "FakeSantiagoV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2"
},
{
"title": "FakeSherbrooke",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeSherbrooke"
},
{
"title": "FakeSingapore",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeSingapore"
},
{
"title": "FakeSingaporeV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2"
},
{
"title": "FakeSydney",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeSydney"
},
{
"title": "FakeSydneyV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeSydneyV2"
},
{
"title": "FakeTenerife",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeTenerife"
},
{
"title": "FakeTokyo",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeTokyo"
},
{
"title": "FakeTorino",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeTorino"
},
{
"title": "FakeToronto",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeToronto"
},
{
"title": "FakeTorontoV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeTorontoV2"
},
{
"title": "FakeValencia",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeValencia"
},
{
"title": "FakeValenciaV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeValenciaV2"
},
{
"title": "FakeVigo",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeVigo"
},
{
"title": "FakeVigoV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeVigoV2"
},
{
"title": "FakeWashington",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeWashington"
},
{
"title": "FakeWashingtonV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2"
},
{
"title": "FakeYorktown",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeYorktown"
},
{
"title": "FakeYorktownV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeYorktownV2"
}
]
},
{
"title": "qiskit_ibm_runtime.noise_learner",
"children": [
{
"title": "Module overview",
"url": "/api/qiskit-ibm-runtime/0.29/noise_learner"
},
{
"title": "NoiseLearner",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.noise_learner.NoiseLearner"
}
]
},
{
"title": "qiskit_ibm_runtime.options",
"children": [
{
"title": "Module overview",
"url": "/api/qiskit-ibm-runtime/0.29/options"
},
{
"title": "DynamicalDecouplingOptions",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.options.DynamicalDecouplingOptions"
},
{
"title": "EnvironmentOptions",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.options.EnvironmentOptions"
},
{
"title": "EstimatorOptions",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.options.EstimatorOptions"
},
{
"title": "ExecutionOptionsV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.options.ExecutionOptionsV2"
},
{
"title": "LayerNoiseLearningOptions",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.options.LayerNoiseLearningOptions"
},
{
"title": "MeasureNoiseLearningOptions",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions"
},
{
"title": "NoiseLearnerOptions",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.options.NoiseLearnerOptions"
},
{
"title": "PecOptions",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.options.PecOptions"
},
{
"title": "ResilienceOptionsV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.options.ResilienceOptionsV2"
},
{
"title": "SamplerExecutionOptionsV2",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2"
},
{
"title": "SamplerOptions",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.options.SamplerOptions"
},
{
"title": "SimulatorOptions",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.options.SimulatorOptions"
},
{
"title": "TwirlingOptions",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.options.TwirlingOptions"
},
{
"title": "ZneOptions",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.options.ZneOptions"
}
]
},
{
"title": "qiskit_ibm_runtime.transpiler.passes",
"children": [
{
"title": "Module overview",
"url": "/api/qiskit-ibm-runtime/0.29/transpiler"
},
{
"title": "ConvertIdToDelay",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay"
}
]
},
{
"title": "qiskit_ibm_runtime.transpiler.passes.scheduling",
"children": [
{
"title": "Module overview",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.transpiler.passes.scheduling"
},
{
"title": "ALAPScheduleAnalysis",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis"
},
{
"title": "ASAPScheduleAnalysis",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis"
},
{
"title": "BlockBasePadder",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder"
},
{
"title": "DynamicCircuitInstructionDurations",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations"
},
{
"title": "PadDelay",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay"
},
{
"title": "PadDynamicalDecoupling",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling"
}
]
},
{
"title": "qiskit_ibm_runtime.utils.noise_learner_result",
"children": [
{
"title": "Module overview",
"url": "/api/qiskit-ibm-runtime/0.29/noise_learner_result"
},
{
"title": "LayerError",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.utils.noise_learner_result.LayerError"
},
{
"title": "PauliLindbladError",
"url": "/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError"
}
]
},
{
"title": "Release notes",
"url": "/api/qiskit-ibm-runtime/release-notes"
}
],
"collapsed": true
}

31
docs/api/qiskit-ibm-runtime/0.29/execution_span.mdx Normal file
View File

@ -0,0 +1,31 @@
---
title: execution_span
description: API reference for qiskit_ibm_runtime.execution_span
in_page_toc_min_heading_level: 2
python_api_type: module
python_api_name: qiskit_ibm_runtime.execution_span
---
<span id="execution-spans-qiskit-ibm-runtime-execution-span" />
<span id="module-qiskit_ibm_runtime.execution_span" />
# Execution Spans
<span id="module-qiskit_ibm_runtime.execution_span" />
`qiskit_ibm_runtime.execution_span`
## Overview
An [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans") class instance is an iterable of [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan")s, where each iterand gives timing information about a chunk of data. Execution spans are returned as part of the metadata of a primitive job result.
## Classes
| | |
| ----------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan")(start, stop) | Abstract parent for classes that store an execution time span for a subset of job data. |
| [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans")(spans) | A collection of timings for pub results. |
| [`ShapeType`](qiskit_ibm_runtime.execution_span.ShapeType "qiskit_ibm_runtime.execution_span.ShapeType") | alias of `Tuple`\[`int`, ...] |
| [`SliceSpan`](qiskit_ibm_runtime.execution_span.SliceSpan "qiskit_ibm_runtime.execution_span.SliceSpan")(start, stop, data\_slices) | An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format. |

203
docs/api/qiskit-ibm-runtime/0.29/fake_provider.mdx Normal file
View File

@ -0,0 +1,203 @@
---
title: fake_provider
description: API reference for qiskit_ibm_runtime.fake_provider
in_page_toc_min_heading_level: 2
python_api_type: module
python_api_name: qiskit_ibm_runtime.fake_provider
---
<span id="fake-provider-qiskit-ibm-runtime-fake-provider" />
<span id="module-qiskit_ibm_runtime.fake_provider" />
# Fake Provider
<span id="module-qiskit_ibm_runtime.fake_provider" />
`qiskit_ibm_runtime.fake_provider`
## Overview
The fake provider module contains fake providers and fake backends classes. The fake backends are built to mimic the behaviors of IBM Quantum systems using system snapshots. The system snapshots contain important information about the quantum system such as coupling map, basis gates, qubit properties (T1, T2, error rate, etc.) which are useful for testing the transpiler and performing noisy simulations of the system.
## Example Usage
Here is an example of using a fake backend for transpilation and simulation.
```python
from qiskit import QuantumCircuit
from qiskit import transpile
from qiskit.visualization import plot_histogram
from qiskit_ibm_runtime import SamplerV2
from qiskit_ibm_runtime.fake_provider import FakeManilaV2
# Get a fake backend from the fake provider
backend = FakeManilaV2()
# Create a simple circuit
circuit = QuantumCircuit(3)
circuit.h(0)
circuit.cx(0,1)
circuit.cx(0,2)
circuit.measure_all()
circuit.draw('mpl', style="iqp")
# Transpile the ideal circuit to a circuit that can be directly executed by the backend
transpiled_circuit = transpile(circuit, backend)
transpiled_circuit.draw('mpl', style="iqp")
# Run the transpiled circuit using the simulated fake backend
sampler = SamplerV2(backend)
job = sampler.run([transpiled_circuit])
pub_result = job.result()[0]
counts = pub_result.data.meas.get_counts()
plot_histogram(counts)
```
![../\_images/fake\_provider-1\_00.png](/images/api/qiskit-ibm-runtime/0.29/fake_provider-1_00.png)
![../\_images/fake\_provider-1\_01.png](/images/api/qiskit-ibm-runtime/0.29/fake_provider-1_01.png)
![../\_images/fake\_provider-1\_02.png](/images/api/qiskit-ibm-runtime/0.29/fake_provider-1_02.png)
<Admonition title="Important" type="danger">
Please note that the simulation is done using a noise model generated from system snapshots obtained in the past (sometimes a few years ago) and the results are not representative of the latest behaviours of the real quantum system which the fake backend is mimicking. If you want to run noisy simulations to compare with the real quantum system, you should use the `qiskit_aer` library. After installation, you can follow the steps below to generate a simulator that mimics a real quantum system with the latest calibration results.
```python
from qiskit_ibm_runtime import QiskitRuntimeService
from qiskit_aer import AerSimulator
# get a real backend from the runtime service
service = QiskitRuntimeService()
backend = service.backend('ibmq_manila')
# generate a simulator that mimics the real quantum system with the latest calibration results
backend_sim = AerSimulator.from_backend(backend)
```
</Admonition>
## Fake Providers
Fake providers provide access to a list of fake backends.
| | |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| [`FakeProviderForBackendV2`](qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 "qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2")() | Fake provider containing fake V2 backends. |
| [`FakeProvider`](qiskit_ibm_runtime.fake_provider.FakeProvider "qiskit_ibm_runtime.fake_provider.FakeProvider")() | Fake provider containing fake V1 backends. |
## Fake Backends
### Fake V2 Backends
Fake V2 backends are fake backends with IBM Quantum systems snapshots implemented with `BackendV2` interface. They are all subclasses of `FakeBackendV2`.
| | |
| -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| [`FakeAlgiers`](qiskit_ibm_runtime.fake_provider.FakeAlgiers "qiskit_ibm_runtime.fake_provider.FakeAlgiers")() | A fake 27 qubit backend. |
| [`FakeAlmadenV2`](qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 "qiskit_ibm_runtime.fake_provider.FakeAlmadenV2")() | A fake Almaden V2 backend. |
| [`FakeArmonkV2`](qiskit_ibm_runtime.fake_provider.FakeArmonkV2 "qiskit_ibm_runtime.fake_provider.FakeArmonkV2")() | A fake 1 qubit backend. |
| [`FakeAthensV2`](qiskit_ibm_runtime.fake_provider.FakeAthensV2 "qiskit_ibm_runtime.fake_provider.FakeAthensV2")() | A fake 5 qubit backend. |
| [`FakeAuckland`](qiskit_ibm_runtime.fake_provider.FakeAuckland "qiskit_ibm_runtime.fake_provider.FakeAuckland")() | A fake 27 qubit backend. |
| [`FakeBelemV2`](qiskit_ibm_runtime.fake_provider.FakeBelemV2 "qiskit_ibm_runtime.fake_provider.FakeBelemV2")() | A fake 5 qubit backend. |
| [`FakeBoeblingenV2`](qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 "qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2")() | A fake Boeblingen V2 backend. |
| [`FakeBogotaV2`](qiskit_ibm_runtime.fake_provider.FakeBogotaV2 "qiskit_ibm_runtime.fake_provider.FakeBogotaV2")() | A fake 5 qubit backend. |
| [`FakeBrisbane`](qiskit_ibm_runtime.fake_provider.FakeBrisbane "qiskit_ibm_runtime.fake_provider.FakeBrisbane")() | A fake 127 qubit backend. |
| [`FakeBrooklynV2`](qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 "qiskit_ibm_runtime.fake_provider.FakeBrooklynV2")() | A fake Brooklyn V2 backend. |
| [`FakeBurlingtonV2`](qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 "qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2")() | A fake 5 qubit backend. |
| [`FakeCairoV2`](qiskit_ibm_runtime.fake_provider.FakeCairoV2 "qiskit_ibm_runtime.fake_provider.FakeCairoV2")() | A fake 27 qubit backend. |
| [`FakeCambridgeV2`](qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 "qiskit_ibm_runtime.fake_provider.FakeCambridgeV2")() | A fake Cambridge backend. |
| [`FakeCasablancaV2`](qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 "qiskit_ibm_runtime.fake_provider.FakeCasablancaV2")() | A fake 7 qubit backend. |
| [`FakeCusco`](qiskit_ibm_runtime.fake_provider.FakeCusco "qiskit_ibm_runtime.fake_provider.FakeCusco")() | A fake 127 qubit backend. |
| [`FakeEssexV2`](qiskit_ibm_runtime.fake_provider.FakeEssexV2 "qiskit_ibm_runtime.fake_provider.FakeEssexV2")() | A fake 5 qubit backend. |
| [`FakeGeneva`](qiskit_ibm_runtime.fake_provider.FakeGeneva "qiskit_ibm_runtime.fake_provider.FakeGeneva")() | A fake 27 qubit backend. |
| [`FakeGuadalupeV2`](qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 "qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2")() | A fake 16 qubit backend. |
| [`FakeHanoiV2`](qiskit_ibm_runtime.fake_provider.FakeHanoiV2 "qiskit_ibm_runtime.fake_provider.FakeHanoiV2")() | A fake 27 qubit backend. |
| [`FakeJakartaV2`](qiskit_ibm_runtime.fake_provider.FakeJakartaV2 "qiskit_ibm_runtime.fake_provider.FakeJakartaV2")() | A fake 7 qubit V2 backend. |
| [`FakeJohannesburgV2`](qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 "qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2")() | A fake Johannesburg V2 backend. |
| [`FakeKawasaki`](qiskit_ibm_runtime.fake_provider.FakeKawasaki "qiskit_ibm_runtime.fake_provider.FakeKawasaki")() | A fake 127 qubit backend. |
| [`FakeKolkataV2`](qiskit_ibm_runtime.fake_provider.FakeKolkataV2 "qiskit_ibm_runtime.fake_provider.FakeKolkataV2")() | A fake 27 qubit backend. |
| [`FakeKyiv`](qiskit_ibm_runtime.fake_provider.FakeKyiv "qiskit_ibm_runtime.fake_provider.FakeKyiv")() | A fake 127 qubit backend. |
| [`FakeKyoto`](qiskit_ibm_runtime.fake_provider.FakeKyoto "qiskit_ibm_runtime.fake_provider.FakeKyoto")() | A fake 127 qubit backend. |
| [`FakeLagosV2`](qiskit_ibm_runtime.fake_provider.FakeLagosV2 "qiskit_ibm_runtime.fake_provider.FakeLagosV2")() | A fake 7 qubit backend. |
| [`FakeLimaV2`](qiskit_ibm_runtime.fake_provider.FakeLimaV2 "qiskit_ibm_runtime.fake_provider.FakeLimaV2")() | A fake 5 qubit backend. |
| [`FakeFractionalBackend`](qiskit_ibm_runtime.fake_provider.FakeFractionalBackend "qiskit_ibm_runtime.fake_provider.FakeFractionalBackend")() | A fake 5 qubit backend with dynamic and fractional feature modeled based on FakeLima. |
| [`FakeLondonV2`](qiskit_ibm_runtime.fake_provider.FakeLondonV2 "qiskit_ibm_runtime.fake_provider.FakeLondonV2")() | A fake 5 qubit backend. |
| [`FakeManhattanV2`](qiskit_ibm_runtime.fake_provider.FakeManhattanV2 "qiskit_ibm_runtime.fake_provider.FakeManhattanV2")() | A fake Manhattan backend. |
| [`FakeManilaV2`](qiskit_ibm_runtime.fake_provider.FakeManilaV2 "qiskit_ibm_runtime.fake_provider.FakeManilaV2")() | A fake 5 qubit backend. |
| [`FakeMelbourneV2`](qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 "qiskit_ibm_runtime.fake_provider.FakeMelbourneV2")() | A fake 14 qubit backend. |
| [`FakeMontrealV2`](qiskit_ibm_runtime.fake_provider.FakeMontrealV2 "qiskit_ibm_runtime.fake_provider.FakeMontrealV2")() | A fake 27 qubit backend. |
| [`FakeMumbaiV2`](qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 "qiskit_ibm_runtime.fake_provider.FakeMumbaiV2")() | A fake 27 qubit backend. |
| [`FakeNairobiV2`](qiskit_ibm_runtime.fake_provider.FakeNairobiV2 "qiskit_ibm_runtime.fake_provider.FakeNairobiV2")() | A fake 7 qubit backend. |
| [`FakeOsaka`](qiskit_ibm_runtime.fake_provider.FakeOsaka "qiskit_ibm_runtime.fake_provider.FakeOsaka")() | A fake 127 qubit backend. |
| [`FakeOslo`](qiskit_ibm_runtime.fake_provider.FakeOslo "qiskit_ibm_runtime.fake_provider.FakeOslo")() | A fake 7 qubit backend. |
| [`FakeOurenseV2`](qiskit_ibm_runtime.fake_provider.FakeOurenseV2 "qiskit_ibm_runtime.fake_provider.FakeOurenseV2")() | A fake 5 qubit backend. |
| [`FakeParisV2`](qiskit_ibm_runtime.fake_provider.FakeParisV2 "qiskit_ibm_runtime.fake_provider.FakeParisV2")() | A fake Paris backend. |
| [`FakePeekskill`](qiskit_ibm_runtime.fake_provider.FakePeekskill "qiskit_ibm_runtime.fake_provider.FakePeekskill")() | A fake 27 qubit backend. |
| [`FakePerth`](qiskit_ibm_runtime.fake_provider.FakePerth "qiskit_ibm_runtime.fake_provider.FakePerth")() | A fake 7 qubit backend. |
| [`FakePrague`](qiskit_ibm_runtime.fake_provider.FakePrague "qiskit_ibm_runtime.fake_provider.FakePrague")() | A fake 33 qubit backend. |
| [`FakePoughkeepsieV2`](qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 "qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2")() | A fake Poughkeepsie backend. |
| [`FakeQuebec`](qiskit_ibm_runtime.fake_provider.FakeQuebec "qiskit_ibm_runtime.fake_provider.FakeQuebec")() | A fake 127 qubit backend. |
| [`FakeQuitoV2`](qiskit_ibm_runtime.fake_provider.FakeQuitoV2 "qiskit_ibm_runtime.fake_provider.FakeQuitoV2")() | A fake 5 qubit backend. |
| [`FakeRochesterV2`](qiskit_ibm_runtime.fake_provider.FakeRochesterV2 "qiskit_ibm_runtime.fake_provider.FakeRochesterV2")() | A fake Rochester backend. |
| [`FakeRomeV2`](qiskit_ibm_runtime.fake_provider.FakeRomeV2 "qiskit_ibm_runtime.fake_provider.FakeRomeV2")() | A fake 5 qubit backend. |
| [`FakeSantiagoV2`](qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 "qiskit_ibm_runtime.fake_provider.FakeSantiagoV2")() | A fake Santiago backend. |
| [`FakeSherbrooke`](qiskit_ibm_runtime.fake_provider.FakeSherbrooke "qiskit_ibm_runtime.fake_provider.FakeSherbrooke")() | A fake 127 qubit backend. |
| [`FakeSingaporeV2`](qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 "qiskit_ibm_runtime.fake_provider.FakeSingaporeV2")() | A fake Singapore backend. |
| [`FakeSydneyV2`](qiskit_ibm_runtime.fake_provider.FakeSydneyV2 "qiskit_ibm_runtime.fake_provider.FakeSydneyV2")() | A fake 27 qubit backend. |
| [`FakeTorino`](qiskit_ibm_runtime.fake_provider.FakeTorino "qiskit_ibm_runtime.fake_provider.FakeTorino")() | A fake 133 qubit backend. |
| [`FakeTorontoV2`](qiskit_ibm_runtime.fake_provider.FakeTorontoV2 "qiskit_ibm_runtime.fake_provider.FakeTorontoV2")() | A fake 27 qubit backend. |
| [`FakeValenciaV2`](qiskit_ibm_runtime.fake_provider.FakeValenciaV2 "qiskit_ibm_runtime.fake_provider.FakeValenciaV2")() | A fake 5 qubit backend. |
| [`FakeVigoV2`](qiskit_ibm_runtime.fake_provider.FakeVigoV2 "qiskit_ibm_runtime.fake_provider.FakeVigoV2")() | A fake 5 qubit backend. |
| [`FakeWashingtonV2`](qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 "qiskit_ibm_runtime.fake_provider.FakeWashingtonV2")() | A fake 127 qubit backend. |
| [`FakeYorktownV2`](qiskit_ibm_runtime.fake_provider.FakeYorktownV2 "qiskit_ibm_runtime.fake_provider.FakeYorktownV2")() | A fake 5 qubit backend. |
### Fake V1 Backends
Fake V1 backends are fake backends with IBM Quantum systems snapshots implemented with `BackendV1` interface.
| | |
| ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
| [`FakeAlmaden`](qiskit_ibm_runtime.fake_provider.FakeAlmaden "qiskit_ibm_runtime.fake_provider.FakeAlmaden")() | A fake Almaden backend. |
| [`FakeArmonk`](qiskit_ibm_runtime.fake_provider.FakeArmonk "qiskit_ibm_runtime.fake_provider.FakeArmonk")() | A fake 1 qubit backend. |
| [`FakeAthens`](qiskit_ibm_runtime.fake_provider.FakeAthens "qiskit_ibm_runtime.fake_provider.FakeAthens")() | A fake 5 qubit backend. |
| [`FakeBelem`](qiskit_ibm_runtime.fake_provider.FakeBelem "qiskit_ibm_runtime.fake_provider.FakeBelem")() | A fake 5 qubit backend. |
| [`FakeBoeblingen`](qiskit_ibm_runtime.fake_provider.FakeBoeblingen "qiskit_ibm_runtime.fake_provider.FakeBoeblingen")() | A fake Boeblingen backend. |
| [`FakeBogota`](qiskit_ibm_runtime.fake_provider.FakeBogota "qiskit_ibm_runtime.fake_provider.FakeBogota")() | A fake 5 qubit backend. |
| [`FakeBrooklyn`](qiskit_ibm_runtime.fake_provider.FakeBrooklyn "qiskit_ibm_runtime.fake_provider.FakeBrooklyn")() | A fake Brooklyn backend. |
| [`FakeBurlington`](qiskit_ibm_runtime.fake_provider.FakeBurlington "qiskit_ibm_runtime.fake_provider.FakeBurlington")() | A fake 5 qubit backend. |
| [`FakeCairo`](qiskit_ibm_runtime.fake_provider.FakeCairo "qiskit_ibm_runtime.fake_provider.FakeCairo")() | A fake 27 qubit backend. |
| [`FakeCambridge`](qiskit_ibm_runtime.fake_provider.FakeCambridge "qiskit_ibm_runtime.fake_provider.FakeCambridge")() | A fake Cambridge backend. |
| [`FakeCasablanca`](qiskit_ibm_runtime.fake_provider.FakeCasablanca "qiskit_ibm_runtime.fake_provider.FakeCasablanca")() | A fake 7 qubit backend. |
| [`FakeEssex`](qiskit_ibm_runtime.fake_provider.FakeEssex "qiskit_ibm_runtime.fake_provider.FakeEssex")() | A fake 5 qubit backend. |
| [`FakeGuadalupe`](qiskit_ibm_runtime.fake_provider.FakeGuadalupe "qiskit_ibm_runtime.fake_provider.FakeGuadalupe")() | A fake 16 qubit backend. |
| [`FakeHanoi`](qiskit_ibm_runtime.fake_provider.FakeHanoi "qiskit_ibm_runtime.fake_provider.FakeHanoi")() | A fake 27 qubit backend. |
| [`FakeJakarta`](qiskit_ibm_runtime.fake_provider.FakeJakarta "qiskit_ibm_runtime.fake_provider.FakeJakarta")() | A fake 7 qubit backend. |
| [`FakeJohannesburg`](qiskit_ibm_runtime.fake_provider.FakeJohannesburg "qiskit_ibm_runtime.fake_provider.FakeJohannesburg")() | A fake Johannesburg backend. |
| [`FakeKolkata`](qiskit_ibm_runtime.fake_provider.FakeKolkata "qiskit_ibm_runtime.fake_provider.FakeKolkata")() | A fake 27 qubit backend. |
| [`FakeLagos`](qiskit_ibm_runtime.fake_provider.FakeLagos "qiskit_ibm_runtime.fake_provider.FakeLagos")() | A fake 7 qubit backend. |
| [`FakeLima`](qiskit_ibm_runtime.fake_provider.FakeLima "qiskit_ibm_runtime.fake_provider.FakeLima")() | A fake 5 qubit backend. |
| [`FakeLondon`](qiskit_ibm_runtime.fake_provider.FakeLondon "qiskit_ibm_runtime.fake_provider.FakeLondon")() | A fake 5 qubit backend. |
| [`FakeManhattan`](qiskit_ibm_runtime.fake_provider.FakeManhattan "qiskit_ibm_runtime.fake_provider.FakeManhattan")() | A fake Manhattan backend. |
| [`FakeManila`](qiskit_ibm_runtime.fake_provider.FakeManila "qiskit_ibm_runtime.fake_provider.FakeManila")() | A fake 5 qubit backend. |
| [`FakeMelbourne`](qiskit_ibm_runtime.fake_provider.FakeMelbourne "qiskit_ibm_runtime.fake_provider.FakeMelbourne")() | A fake 14 qubit backend. |
| [`FakeMontreal`](qiskit_ibm_runtime.fake_provider.FakeMontreal "qiskit_ibm_runtime.fake_provider.FakeMontreal")() | A fake 27 qubit backend. |
| [`FakeMumbai`](qiskit_ibm_runtime.fake_provider.FakeMumbai "qiskit_ibm_runtime.fake_provider.FakeMumbai")() | A fake 27 qubit backend. |
| [`FakeNairobi`](qiskit_ibm_runtime.fake_provider.FakeNairobi "qiskit_ibm_runtime.fake_provider.FakeNairobi")() | A fake 7 qubit backend. |
| [`FakeOurense`](qiskit_ibm_runtime.fake_provider.FakeOurense "qiskit_ibm_runtime.fake_provider.FakeOurense")() | A fake 5 qubit backend. |
| [`FakeParis`](qiskit_ibm_runtime.fake_provider.FakeParis "qiskit_ibm_runtime.fake_provider.FakeParis")() | A fake Paris backend. |
| [`FakePoughkeepsie`](qiskit_ibm_runtime.fake_provider.FakePoughkeepsie "qiskit_ibm_runtime.fake_provider.FakePoughkeepsie")() | A fake Poughkeepsie backend. |
| [`FakeQuito`](qiskit_ibm_runtime.fake_provider.FakeQuito "qiskit_ibm_runtime.fake_provider.FakeQuito")() | A fake 5 qubit backend. |
| [`FakeRochester`](qiskit_ibm_runtime.fake_provider.FakeRochester "qiskit_ibm_runtime.fake_provider.FakeRochester")() | A fake Rochester backend. |
| [`FakeRome`](qiskit_ibm_runtime.fake_provider.FakeRome "qiskit_ibm_runtime.fake_provider.FakeRome")() | A fake 5 qubit backend. |
| [`FakeRueschlikon`](qiskit_ibm_runtime.fake_provider.FakeRueschlikon "qiskit_ibm_runtime.fake_provider.FakeRueschlikon")() | A fake 16 qubit backend. |
| [`FakeSantiago`](qiskit_ibm_runtime.fake_provider.FakeSantiago "qiskit_ibm_runtime.fake_provider.FakeSantiago")() | A fake Santiago backend. |
| [`FakeSingapore`](qiskit_ibm_runtime.fake_provider.FakeSingapore "qiskit_ibm_runtime.fake_provider.FakeSingapore")() | A fake Singapore backend. |
| [`FakeSydney`](qiskit_ibm_runtime.fake_provider.FakeSydney "qiskit_ibm_runtime.fake_provider.FakeSydney")() | A fake 27 qubit backend. |
| [`FakeTenerife`](qiskit_ibm_runtime.fake_provider.FakeTenerife "qiskit_ibm_runtime.fake_provider.FakeTenerife")() | A fake 5 qubit backend. |
| [`FakeTokyo`](qiskit_ibm_runtime.fake_provider.FakeTokyo "qiskit_ibm_runtime.fake_provider.FakeTokyo")() | A fake 20 qubit backend. |
| [`FakeToronto`](qiskit_ibm_runtime.fake_provider.FakeToronto "qiskit_ibm_runtime.fake_provider.FakeToronto")() | A fake 27 qubit backend. |
| [`FakeValencia`](qiskit_ibm_runtime.fake_provider.FakeValencia "qiskit_ibm_runtime.fake_provider.FakeValencia")() | A fake 5 qubit backend. |
| [`FakeVigo`](qiskit_ibm_runtime.fake_provider.FakeVigo "qiskit_ibm_runtime.fake_provider.FakeVigo")() | A fake 5 qubit backend. |
| [`FakeWashington`](qiskit_ibm_runtime.fake_provider.FakeWashington "qiskit_ibm_runtime.fake_provider.FakeWashington")() | A fake 127 qubit backend. |
| [`FakeYorktown`](qiskit_ibm_runtime.fake_provider.FakeYorktown "qiskit_ibm_runtime.fake_provider.FakeYorktown")() | A fake 5 qubit backend. |

16
docs/api/qiskit-ibm-runtime/0.29/index.mdx Normal file
View File

@ -0,0 +1,16 @@
---
title: Qiskit Runtime Client API Docs
description: API documentation for the qiskit-ibm-runtime client
---
# qiskit-ibm-runtime API reference
* [Qiskit Runtime (`qiskit_ibm_runtime`)](runtime_service)
* [Noise learner (`qiskit_ibm_runtime.noise_learner.NoiseLearner`)](noise_learner)
* [NoiseLearner result classes (`qiskit_ibm_runtime.utils.noise_learner_result`)](noise_learner_result)
* [Primitive options (`qiskit_ibm_runtime.options`)](options)
* [Transpiler passes (`qiskit_ibm_runtime.transpiler.passes`)](transpiler)
* [Transpiler scheduling passes (`qiskit_ibm_runtime.transpiler.passes.scheduling`)](qiskit_ibm_runtime.transpiler.passes.scheduling)
* [Fake Provider (`qiskit_ibm_runtime.fake_provider`)](fake_provider)
* [Execution Spans (`qiskit_ibm_runtime.execution_span`)](execution_span)

26
docs/api/qiskit-ibm-runtime/0.29/noise_learner.mdx Normal file
View File

@ -0,0 +1,26 @@
---
title: noise_learner
description: API reference for qiskit_ibm_runtime.noise_learner
in_page_toc_min_heading_level: 2
python_api_type: module
python_api_name: qiskit_ibm_runtime.noise_learner
---
<span id="noise-learner-qiskit-ibm-runtime-noise-learner-noiselearner" />
<span id="module-qiskit_ibm_runtime.noise_learner" />
# Noise learner
<span id="module-qiskit_ibm_runtime.noise_learner" />
`qiskit_ibm_runtime.noise_learner.NoiseLearner`
The tools to characterize the noise processes affecting the gates in noisy quantum circuits.
## Classes
| | |
| --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| [`NoiseLearner`](qiskit_ibm_runtime.noise_learner.NoiseLearner "qiskit_ibm_runtime.noise_learner.NoiseLearner")(\[mode, options]) | Class for executing noise learning experiments. |

23
docs/api/qiskit-ibm-runtime/0.29/noise_learner_result.mdx Normal file
View File

@ -0,0 +1,23 @@
---
title: noise_learner_result
description: API reference for qiskit_ibm_runtime.utils.noise_learner_result
in_page_toc_min_heading_level: 2
python_api_type: module
python_api_name: qiskit_ibm_runtime.utils.noise_learner_result
---
<span id="noiselearner-result-classes-qiskit-ibm-runtime-utils-noise-learner-result" />
<span id="module-qiskit_ibm_runtime.utils.noise_learner_result" />
# NoiseLearner result classes
<span id="module-qiskit_ibm_runtime.utils.noise_learner_result" />
`qiskit_ibm_runtime.utils.noise_learner_result`
| | |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------- |
| [`PauliLindbladError`](qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError "qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError")(generators, rates) | A Pauli error channel generated by a Pauli Lindblad dissipators. |
| [`LayerError`](qiskit_ibm_runtime.utils.noise_learner_result.LayerError "qiskit_ibm_runtime.utils.noise_learner_result.LayerError")(circuit, qubits, error) | The error channel (in Pauli-Lindblad format) of a single layer of instructions. |

76
docs/api/qiskit-ibm-runtime/0.29/options.mdx Normal file
View File

@ -0,0 +1,76 @@
---
title: options
description: API reference for qiskit_ibm_runtime.options
in_page_toc_min_heading_level: 2
python_api_type: module
python_api_name: qiskit_ibm_runtime.options
---
<span id="primitive-options-qiskit-ibm-runtime-options" />
<span id="module-qiskit_ibm_runtime.options" />
# Primitive options
<span id="module-qiskit_ibm_runtime.options" />
`qiskit_ibm_runtime.options`
Options that can be passed to the Qiskit Runtime primitives.
## V2 Primitives
`SamplerV2` and `EstimatorV2` each have their own options. You can use the `options` attribute to set the options. For example:
```python
from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2
service = QiskitRuntimeService()
backend = service.least_busy(operational=True, simulator=False)
estimator = EstimatorV2(backend=backend)
estimator.options.resilience_level = 1
```
You can also use the `update()` method to do bulk update. For example:
```python
from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2
service = QiskitRuntimeService()
backend = service.least_busy(operational=True, simulator=False)
estimator = EstimatorV2(backend=backend)
estimator.options.update(resilience_level=1)
```
Refer to [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.SamplerOptions") and [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.EstimatorOptions") for V2 Sampler and V2 Estimator options, respectively.
<Admonition title="Note" type="note">
If an option is not specified, the server default value is used. The default values are subject to change. Refer to this current module’s documentation for the latest defaults.
</Admonition>
## Classes
### Base primitive options
| | |
| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
| [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.EstimatorOptions")(\*args, \*\*kwargs) | Options for V2 Estimator. |
| [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.SamplerOptions")(\*args, \*\*kwargs) | Options for V2 Sampler. |
### Suboptions
| | |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`NoiseLearnerOptions`](qiskit_ibm_runtime.options.NoiseLearnerOptions "qiskit_ibm_runtime.options.NoiseLearnerOptions")(\*args, \*\*kwargs) | Options for [`NoiseLearner`](qiskit_ibm_runtime.noise_learner.NoiseLearner "qiskit_ibm_runtime.noise_learner.NoiseLearner"). |
| [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions")(\*args, \*\*kwargs) | Options for dynamical decoupling (DD). |
| [`ResilienceOptionsV2`](qiskit_ibm_runtime.options.ResilienceOptionsV2 "qiskit_ibm_runtime.options.ResilienceOptionsV2")(\*args, \*\*kwargs) | Resilience options for V2 Estimator. |
| [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions")(\*args, \*\*kwargs) | Options for learning layer noise. |
| [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions")(\*args, \*\*kwargs) | Options for measurement noise learning. |
| [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions")(\*args, \*\*kwargs) | Probabalistic error cancellation mitigation options. |
| [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions")(\*args, \*\*kwargs) | Zero noise extrapolation mitigation options. |
| [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions")(\*args, \*\*kwargs) | Twirling options. |
| [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2")(\*args, \*\*kwargs) | Execution options for V2 primitives. |
| [`SamplerExecutionOptionsV2`](qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 "qiskit_ibm_runtime.options.SamplerExecutionOptionsV2")(\*args, \*\*kwargs) | Extension of [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for the sampler primitive. |
| [`EnvironmentOptions`](qiskit_ibm_runtime.options.EnvironmentOptions "qiskit_ibm_runtime.options.EnvironmentOptions")(\*args, \*\*kwargs) | Options related to the execution environment. |
| [`SimulatorOptions`](qiskit_ibm_runtime.options.SimulatorOptions "qiskit_ibm_runtime.options.SimulatorOptions")(\*args, \*\*kwargs) | Simulator options. |

239
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.Batch.mdx Normal file
View File

@ -0,0 +1,239 @@
---
title: Batch
description: API reference for qiskit_ibm_runtime.Batch
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.Batch
---
# Batch
<Class id="qiskit_ibm_runtime.Batch" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/batch.py#L24-L141" signature="Batch(service=None, backend=None, max_time=None)" modifiers="class">
Class for running jobs in batch execution mode.
The `batch` mode is designed to efficiently perform experiments that comprise multiple independent jobs.
**Using the `batch` mode provides the following benefits:**
* The jobs’ classical computation, such as compilation, is run in parallel. Thus, running multiple jobs in a batch is significantly faster than running them serially.
* There is usually minimal delay between job, which can help avoid drift.
* If you partition your workload into multiple jobs and run them in `batch` mode, you can get results from individual jobs, which makes them more flexible to work with. For example, if a job’s results do not meet your expectations, you can cancel the remaining jobs, or simply re-submit that individual job and avoid re-running the entire workload.
Batch mode can shorten processing time if all jobs are provided at the outset. If you want to submit iterative jobs, use `session` mode instead.
You can open a Qiskit Runtime batch by using this `Batch` class, then submit jobs to one or more primitives.
For example:
```python
import numpy as np
from qiskit.circuit.library import IQP
from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
from qiskit.quantum_info import random_hermitian
from qiskit_ibm_runtime import QiskitRuntimeService, SamplerV2 as Sampler, Batch
n_qubits = 127
service = QiskitRuntimeService()
backend = service.least_busy(operational=True, simulator=False, min_num_qubits=n_qubits)
rng = np.random.default_rng()
mats = [np.real(random_hermitian(n_qubits, seed=rng)) for _ in range(30)]
circuits = [IQP(mat) for mat in mats]
for circuit in circuits:
circuit.measure_all()
pm = generate_preset_pass_manager(backend=backend, optimization_level=1)
isa_circuits = pm.run(circuits)
max_circuits = 10
all_partitioned_circuits = []
for i in range(0, len(isa_circuits), max_circuits):
all_partitioned_circuits.append(isa_circuits[i : i + max_circuits])
jobs = []
start_idx = 0
with Batch(backend=backend):
sampler = Sampler()
for partitioned_circuits in all_partitioned_circuits:
job = sampler.run(partitioned_circuits)
jobs.append(job)
```
For more details, check the “[Run jobs in a batch](/guides/run-jobs-batch)” page.
Batch constructor.
**Parameters**
* **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – (DEPRECATED) Optional instance of the `QiskitRuntimeService` class. If `None`, the service associated with the backend, if known, is used. Otherwise `QiskitRuntimeService()` is used to initialize your default saved account.
* **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.2)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)"), `None`]) – Instance of `Backend` class or backend string name. Note that passing a backend name is deprecated.
* **max\_time** (`Union`\[`int`, `str`, `None`]) – Maximum amount of time a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/guides/max-execution-time).
**Raises**
**ValueError** – If an input value is invalid.
## Attributes
### service
<Attribute id="qiskit_ibm_runtime.Batch.service">
Return service associated with this session.
**Return type**
[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")
**Returns**
[`qiskit_ibm_runtime.QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") associated with this session.
</Attribute>
### session\_id
<Attribute id="qiskit_ibm_runtime.Batch.session_id">
Return the session ID.
**Return type**
`Optional`\[`str`]
**Returns**
Session ID. None if the backend is a simulator.
</Attribute>
## Methods
### backend
<Function id="qiskit_ibm_runtime.Batch.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/session.py#L254-L262" signature="backend()">
Return backend for this session.
**Return type**
`Optional`\[`str`]
**Returns**
Backend for this session. None if unknown.
</Function>
### cancel
<Function id="qiskit_ibm_runtime.Batch.cancel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/session.py#L240-L244" signature="cancel()">
Cancel all pending jobs in a session.
**Return type**
`None`
</Function>
### close
<Function id="qiskit_ibm_runtime.Batch.close" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/session.py#L246-L252" signature="close()">
Close the session so new jobs will no longer be accepted, but existing queued or running jobs will run to completion. The session will be terminated once there are no more pending jobs.
**Return type**
`None`
</Function>
### details
<Function id="qiskit_ibm_runtime.Batch.details" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/session.py#L291-L333" signature="details()">
Return session details.
**Return type**
`Optional`\[`Dict`\[`str`, `Any`]]
**Returns**
A dictionary with the sessions details.
* `id`: id of the session.
* `backend_name`: backend used for the session.
* `interactive_timeout`: The maximum idle time (in seconds) between jobs that is allowed to occur before the session is deactivated.
* `max_time`: Maximum allowed time (in seconds) for the session, subject to plan limits.
* `active_timeout`: The maximum time (in seconds) a session can stay active.
* `state`: State of the session - open, active, inactive, or closed.
* `accepting_jobs`: Whether or not the session is accepting jobs.
* `last_job_started`: Timestamp of when the last job in the session started.
* `last_job_completed`: Timestamp of when the last job in the session completed.
* `started_at`: Timestamp of when the session was started.
* `closed_at`: Timestamp of when the session was closed.
* `activated_at`: Timestamp of when the session state was changed to active.
* `mode`: Execution mode of the session.
* `usage_time`: The usage time, in seconds, of this Session or Batch. Usage is defined as the time a quantum system is committed to complete a job.
</Function>
### from\_id
<Function id="qiskit_ibm_runtime.Batch.from_id" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/session.py#L353-L386" signature="from_id(session_id, service)" modifiers="classmethod">
Construct a Session object with a given session\_id
**Parameters**
* **session\_id** (`str`) – the id of the session to be created. This must be an already existing session id.
* **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) –
instance of the `QiskitRuntimeService` class.
**Raises:**
IBMInputValueError: If given session\_id does not exist.
**Return type**
[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")
**Returns**
A new Session with the given `session_id`
</Function>
### run
<Function id="qiskit_ibm_runtime.Batch.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/session.py#L176-L233" signature="run(program_id, inputs, options=None, callback=None, result_decoder=None)">
Run a program in the session.
**Parameters**
* **program\_id** (`str`) – Program ID.
* **inputs** (`Dict`) – Program input parameters. These input values are passed to the runtime program.
* **options** (`Optional`\[`Dict`]) – Runtime options that control the execution environment.
* **callback** (`Optional`\[`Callable`]) – Callback function to be invoked for any interim results and final result.
**Return type**
`Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), [`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.runtime_job_v2.RuntimeJobV2")]
**Returns**
Submitted job.
</Function>
### status
<Function id="qiskit_ibm_runtime.Batch.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/session.py#L264-L289" signature="status()">
Return current session status.
**Return type**
`Optional`\[`str`]
**Returns**
Session status as a string.
* `Pending`: Session is created but not active. It will become active when the next job of this session is dequeued.
* `In progress, accepting new jobs`: session is active and accepting new jobs.
* `In progress, not accepting new jobs`: session is active and not accepting new jobs.
* `Closed`: max\_time expired or session was explicitly closed.
* `None`: status details are not available.
</Function>
</Class>

14
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.Estimator.mdx Normal file
View File

@ -0,0 +1,14 @@
---
title: Estimator
description: API reference for qiskit_ibm_runtime.Estimator
in_page_toc_min_heading_level: 1
python_api_type: attribute
python_api_name: qiskit_ibm_runtime.Estimator
---
# Estimator
<Attribute id="qiskit_ibm_runtime.Estimator" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/estimator.py#L46-L230">
alias of [`EstimatorV2`](qiskit_ibm_runtime.EstimatorV2 "qiskit_ibm_runtime.estimator.EstimatorV2")
</Attribute>

149
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.EstimatorV2.mdx Normal file
View File

@ -0,0 +1,149 @@
---
title: EstimatorV2
description: API reference for qiskit_ibm_runtime.EstimatorV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.EstimatorV2
---
# EstimatorV2
<Class id="qiskit_ibm_runtime.EstimatorV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/estimator.py#L46-L230" signature="EstimatorV2(mode=None, backend=None, session=None, options=None)" modifiers="class">
Class for interacting with Qiskit Runtime Estimator primitive service.
Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables.
The [`run()`](#qiskit_ibm_runtime.EstimatorV2.run "qiskit_ibm_runtime.EstimatorV2.run") can be used to submit circuits, observables, and parameters to the Estimator primitive.
Following construction, an estimator is used by calling its [`run()`](#qiskit_ibm_runtime.EstimatorV2.run "qiskit_ibm_runtime.EstimatorV2.run") method with a list of PUBs (Primitive Unified Blocs). Each PUB contains four values that, together, define a computation unit of work for the estimator to complete:
* a single [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), possibly parametrized, whose final state we define as $\psi(\theta)$,
* one or more observables (specified as any `ObservablesArrayLike`, including `Pauli`, `SparsePauliOp`, `str`) that specify which expectation values to estimate, denoted $H_j$, and
* a collection parameter value sets to bind the circuit against, $\theta_k$.
* an optional target precision for expectation value estimates.
Here is an example of how the estimator is used.
```python
from qiskit.circuit.library import RealAmplitudes
from qiskit.quantum_info import SparsePauliOp
from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2 as Estimator
service = QiskitRuntimeService()
backend = service.least_busy(operational=True, simulator=False)
psi = RealAmplitudes(num_qubits=2, reps=2)
hamiltonian = SparsePauliOp.from_list([("II", 1), ("IZ", 2), ("XI", 3)])
theta = [0, 1, 1, 2, 3, 5]
pm = generate_preset_pass_manager(backend=backend, optimization_level=1)
isa_psi = pm.run(psi)
isa_observables = hamiltonian.apply_layout(isa_psi.layout)
estimator = Estimator(backend=backend)
# calculate [ <psi(theta1)|hamiltonian|psi(theta)> ]
job = estimator.run([(isa_psi, isa_observables, [theta])])
pub_result = job.result()[0]
print(f"Expectation values: {pub_result.data.evs}")
```
Initializes the Estimator primitive.
**Parameters**
* **mode** (`Union`\[[`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.2)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)"), [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.batch.Batch"), `str`, `None`]) –
The execution mode used to make the primitive query. It can be:
* A `Backend` if you are using job mode.
* A [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") if you are using session execution mode.
* A [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch") if you are using batch execution mode.
Refer to the [Qiskit Runtime documentation](/guides/execution-modes). for more information about the `Execution modes`.
* **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.2)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)"), `None`]) – (DEPRECATED) Backend to run the primitive. This can be a backend name or an [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") instance. If a name is specified, the default account (e.g. `QiskitRuntimeService()`) is used.
* **session** (`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")]) –
(DEPRECATED) Session in which to call the primitive.
If both `session` and `backend` are specified, `session` takes precedence. If neither is specified, and the primitive is created inside a [`qiskit_ibm_runtime.Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") context manager, then the session is used. Otherwise if IBM Cloud channel is used, a default backend is selected.
* **options** (`Union`\[`Dict`, [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.estimator_options.EstimatorOptions"), `None`]) – Estimator options, see `EstimatorOptions` for detailed description.
**Raises**
**NotImplementedError** – If “q-ctrl” channel strategy is used.
## Attributes
### mode
<Attribute id="qiskit_ibm_runtime.EstimatorV2.mode">
Return the execution mode used by this primitive.
**Return type**
Optional\[[Session](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") | [Batch](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch")]
**Returns**
Mode used by this primitive, or `None` if an execution mode is not used.
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.EstimatorV2.options">
Return options
**Return type**
`TypeVar`(`OptionsT`, bound= `BaseOptions`)
</Attribute>
### session
<Attribute id="qiskit_ibm_runtime.EstimatorV2.session">
Return session used by this primitive.
**Return type**
`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")]
**Returns**
Session used by this primitive, or `None` if session is not used.
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.EstimatorV2.version" attributeValue="2" />
## Methods
### run
<Function id="qiskit_ibm_runtime.EstimatorV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/estimator.py#L170-L193" signature="run(pubs, *, precision=None)">
Submit a request to the estimator primitive.
**Parameters**
* **pubs** (*Iterable\[EstimatorPubLike]*) – An iterable of pub-like (primitive unified bloc) objects, such as tuples `(circuit, observables)` or `(circuit, observables, parameter_values)`.
* **precision** (*float | None*) – The target precision for expectation value estimates of each run Estimator Pub that does not specify its own precision. If None the estimator’s default precision value will be used.
**Return type**
[RuntimeJobV2](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.RuntimeJobV2")
**Returns**
Submitted job.
**Raises**
**ValueError** – if precision value is not strictly greater than 0.
</Function>
</Class>

701
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.IBMBackend.mdx Normal file
View File

@ -0,0 +1,701 @@
---
title: IBMBackend
description: API reference for qiskit_ibm_runtime.IBMBackend
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.IBMBackend
---
# IBMBackend
<Class id="qiskit_ibm_runtime.IBMBackend" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/ibm_backend.py#L74-L916" signature="IBMBackend(configuration, service, api_client, instance=None)" modifiers="class">
Backend class interfacing with an IBM Quantum backend.
<Admonition title="Note" type="note">
* You should not instantiate the `IBMBackend` class directly. Instead, use the methods provided by an [`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") instance to retrieve and handle backends.
</Admonition>
This class represents an IBM Quantum backend. Its attributes and methods provide information about the backend. For example, the [`status()`](#qiskit_ibm_runtime.IBMBackend.status "qiskit_ibm_runtime.IBMBackend.status") method returns a `BackendStatus` instance. The instance contains the `operational` and `pending_jobs` attributes, which state whether the backend is operational and also the number of jobs in the server queue for the backend, respectively:
```python
status = backend.status()
is_operational = status.operational
jobs_in_queue = status.pending_jobs
```
Here is list of attributes available on the `IBMBackend` class:
> * name: backend name.
>
> * backend\_version: backend version in the form X.Y.Z.
>
> * num\_qubits: number of qubits.
>
> * target: A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
>
> * basis\_gates: list of basis gates names on the backend.
>
> * gates: list of basis gates on the backend.
>
> * local: backend is local or remote.
>
> * simulator: backend is a simulator.
>
> * conditional: backend supports conditional operations.
>
> * open\_pulse: backend supports open pulse.
>
> * memory: backend supports memory.
>
> * max\_shots: maximum number of shots supported.
>
> * coupling\_map (list): The coupling map for the device
>
> * supported\_instructions (List\[str]): Instructions supported by the backend.
>
> * dynamic\_reprate\_enabled (bool): whether delay between primitives can be set dynamically (ie via `rep_delay`). Defaults to False.
>
> * rep\_delay\_range (List\[float]): 2d list defining supported range of repetition delays for backend in μs. First entry is lower end of the range, second entry is higher end of the range. Optional, but will be specified when `dynamic_reprate_enabled=True`.
>
> * default\_rep\_delay (float): Value of `rep_delay` if not specified by user and `dynamic_reprate_enabled=True`.
>
> * n\_uchannels: Number of u-channels.
>
> * u\_channel\_lo: U-channel relationship on device los.
>
> * meas\_levels: Supported measurement levels.
>
> * qubit\_lo\_range: Qubit lo ranges for each qubit with form (min, max) in GHz.
>
> * meas\_lo\_range: Measurement lo ranges for each qubit with form (min, max) in GHz.
>
> * dt: Qubit drive channel timestep in nanoseconds.
>
> * dtm: Measurement drive channel timestep in nanoseconds.
>
> * rep\_times: Supported repetition times (program execution time) for backend in μs.
>
> * meas\_kernels: Supported measurement kernels.
>
> * discriminators: Supported discriminators.
>
> * hamiltonian: An optional dictionary with fields characterizing the system hamiltonian.
>
> * channel\_bandwidth (list): Bandwidth of all channels (qubit, measurement, and U)
>
> * acquisition\_latency (list): Array of dimension n\_qubits x n\_registers. Latency (in units of dt) to write a measurement result from qubit n into register slot m.
>
> * conditional\_latency (list): Array of dimension n\_channels \[d->u->m] x n\_registers. Latency (in units of dt) to do a conditional operation on channel n from register slot m
>
> * meas\_map (list): Grouping of measurement which are multiplexed
>
> * max\_circuits (int): The maximum number of experiments per job
>
> * sample\_name (str): Sample name for the backend
>
> * n\_registers (int): Number of register slots available for feedback (if conditional is True)
>
> * register\_map (list): An array of dimension n\_qubits X n\_registers that specifies whether a qubit can store a measurement in a certain register slot.
>
> * configurable (bool): True if the backend is configurable, if the backend is a simulator
>
> * credits\_required (bool): True if backend requires credits to run a job.
>
> * online\_date (datetime): The date that the device went online
>
> * display\_name (str): Alternate name field for the backend
>
> * description (str): A description for the backend
>
> * tags (list): A list of string tags to describe the backend
>
> * version: version of `Backend` class (Ex: 1, 2)
>
> * channels: An optional dictionary containing information of each channel – their purpose, type, and qubits operated on.
>
> * parametric\_pulses (list): A list of pulse shapes which are supported on the backend. For example: `['gaussian', 'constant']`
>
> * processor\_type (dict): Processor type for this backend. A dictionary of the form `{"family": <str>, "revision": <str>, segment: <str>}` such as `{"family": "Canary", "revision": "1.0", segment: "A"}`.
>
> > * family: Processor family of this backend.
> > * revision: Revision version of this processor.
> > * segment: Segment this processor belongs to within a larger chip.
IBMBackend constructor.
**Parameters**
* **configuration** (`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]) – Backend configuration.
* **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – Instance of QiskitRuntimeService.
* **api\_client** (`RuntimeClient`) – IBM client used to communicate with the server.
## Attributes
### coupling\_map
<Attribute id="qiskit_ibm_runtime.IBMBackend.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### dt
<Attribute id="qiskit_ibm_runtime.IBMBackend.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.IBMBackend.dtm">
Return the system time resolution of output signals
**Returns**
The output signal timestep in seconds.
**Return type**
dtm
</Attribute>
### id\_warning\_issued
<Attribute id="qiskit_ibm_runtime.IBMBackend.id_warning_issued" attributeValue="False" />
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.IBMBackend.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.IBMBackend.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.IBMBackend.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.IBMBackend.max_circuits">
The maximum number of circuits
The maximum number of circuits (or Pulse schedules) that can be run in a single job. If there is no limit this will return None.
**Return type**
`int`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.IBMBackend.meas_map">
Return the grouping of measurements which are multiplexed
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The grouping of measurements which are multiplexed
**Return type**
meas\_map
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.IBMBackend.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.IBMBackend.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.IBMBackend.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.IBMBackend.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.IBMBackend.run "qiskit_ibm_runtime.IBMBackend.run") method.
</Attribute>
### provider
<Attribute id="qiskit_ibm_runtime.IBMBackend.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### service
<Attribute id="qiskit_ibm_runtime.IBMBackend.service">
Return the `service` object
**Returns**
instance of QiskitRuntimeService
**Return type**
service
</Attribute>
### session
<Attribute id="qiskit_ibm_runtime.IBMBackend.session">
Return session
**Return type**
`Session`
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.IBMBackend.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
[`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)")
**Returns**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.IBMBackend.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.IBMBackend.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.IBMBackend.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.IBMBackend.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.IBMBackend.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### \_\_call\_\_
<Function id="qiskit_ibm_runtime.IBMBackend.__call__" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/ibm_backend.py#L520-L522" signature="__call__()">
Call self as a function.
**Return type**
[`IBMBackend`](#qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")
</Function>
### acquire\_channel
<Function id="qiskit_ibm_runtime.IBMBackend.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/ibm_backend.py#L494-L500" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### cancel\_session
<Function id="qiskit_ibm_runtime.IBMBackend.cancel_session" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/ibm_backend.py#L881-L895" signature="cancel_session()">
Cancel session. All pending jobs will be cancelled.
**Return type**
`None`
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.IBMBackend.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/ibm_backend.py#L544-L576" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### close\_session
<Function id="qiskit_ibm_runtime.IBMBackend.close_session" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/ibm_backend.py#L897-L912" signature="close_session()">
Close the session so new jobs will no longer be accepted, but existing queued or running jobs will run to completion. The session will be terminated once there are no more pending jobs.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.IBMBackend.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/ibm_backend.py#L452-L476" signature="configuration()">
Return the backend configuration.
Backend configuration contains fixed information about the backend, such as its name, number of qubits, basis gates, coupling map, quantum volume, etc.
The schema for backend configuration can be found in [Qiskit/ibm-quantum-schemas/backend\_configuration](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_configuration_schema.json).
More details about backend configuration properties can be found here [QasmBackendConfiguration](/api/qiskit/qiskit.providers.models.QasmBackendConfiguration).
**IBM backends may also include the following properties:**
* **`supported_features`: a list of strings of supported features like “qasm3” for dynamic**
circuits support.
* **`parallel_compilation`: a boolean of whether or not the backend can process multiple**
jobs at once. Parts of the classical computation will be parallelized.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
**Returns**
The configuration for the backend.
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.IBMBackend.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/ibm_backend.py#L502-L515" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The Qubit measurement acquisition line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.IBMBackend.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/ibm_backend.py#L429-L450" signature="defaults(refresh=False)">
Return the pulse defaults for the backend.
The schema for default pulse configuration can be found in [Qiskit/ibm-quantum-schemas/default\_pulse\_configuration](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/default_pulse_configuration_schema.json).
**Parameters**
**refresh** (`bool`) – If `True`, re-query the server for the backend pulse defaults. Otherwise, return a cached version.
**Return type**
`Optional`\[`PulseDefaults`]
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.IBMBackend.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/ibm_backend.py#L478-L484" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### get\_translation\_stage\_plugin
<Function id="qiskit_ibm_runtime.IBMBackend.get_translation_stage_plugin" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/ibm_backend.py#L914-L916" signature="get_translation_stage_plugin()">
Return the default translation stage plugin name for IBM backends.
**Return type**
`str`
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.IBMBackend.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/ibm_backend.py#L486-L492" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### open\_session
<Function id="qiskit_ibm_runtime.IBMBackend.open_session" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/ibm_backend.py#L851-L867" signature="open_session(max_time=None)">
Open session
**Return type**
`Session`
</Function>
### properties
<Function id="qiskit_ibm_runtime.IBMBackend.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/ibm_backend.py#L353-L403" signature="properties(refresh=False, datetime=None)">
Return the backend properties, subject to optional filtering.
This data describes qubits properties (such as T1 and T2), gates properties (such as gate length and error), and other general properties of the backend.
The schema for backend properties can be found in [Qiskit/ibm-quantum-schemas/backend\_properties](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_properties_schema.json).
**Parameters**
* **refresh** (`bool`) – If `True`, re-query the server for the backend properties. Otherwise, return a cached version.
* **datetime** (`Optional`\[`datetime`]) – By specifying datetime, this function returns an instance of the `BackendProperties` whose timestamp is closest to, but older than, the specified datetime. Note that this is only supported using `ibm_quantum` runtime.
**Return type**
`Optional`\[`BackendProperties`]
**Returns**
The backend properties or `None` if the backend properties are not currently available.
**Raises**
* **TypeError** – If an input argument is not of the correct type.
* **NotImplementedError** – If datetime is specified when cloud runtime is used.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.IBMBackend.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### run
<Function id="qiskit_ibm_runtime.IBMBackend.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/ibm_backend.py#L596-L767" signature="run(circuits, dynamic=None, job_tags=None, init_circuit=None, init_num_resets=None, header=None, shots=None, memory=None, meas_level=None, meas_return=None, rep_delay=None, init_qubits=None, use_measure_esp=None, noise_model=None, seed_simulator=None, **run_config)">
Run on the backend. If a keyword specified here is also present in the `options` attribute/object, the value specified here will be used for this run.
**Parameters**
* **circuits** (`Union`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `str`, `List`\[`Union`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `str`]]]) – An individual or a list of `QuantumCircuit`.
* **dynamic** (`Optional`\[`bool`]) – Whether the circuit is dynamic (uses in-circuit conditionals)
* **job\_tags** (`Optional`\[`List`\[`str`]]) – Tags to be assigned to the job. The tags can subsequently be used as a filter in the `jobs()` function call.
* **init\_circuit** (`Optional`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")]) – A quantum circuit to execute for initializing qubits before each circuit. If specified, `init_num_resets` is ignored. Applicable only if `dynamic=True` is specified.
* **init\_num\_resets** (`Optional`\[`int`]) – The number of qubit resets to insert before each circuit execution.
* **header** (`Optional`\[`Dict`]) – User input that will be attached to the job and will be copied to the corresponding result header. Headers do not affect the run. This replaces the old `Qobj` header. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **shots** (`Union`\[`int`, `float`, `None`]) – Number of repetitions of each circuit, for sampling. Default: 4000 or `max_shots` from the backend configuration, whichever is smaller. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **memory** (`Optional`\[`bool`]) – If `True`, per-shot measurement bitstrings are returned as well (provided the backend supports it). For OpenPulse jobs, only measurement level 2 supports this option. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **meas\_level** (`Union`\[`int`, `MeasLevel`, `None`]) –
Level of the measurement output for pulse experiments. See [OpenPulse specification](https://arxiv.org/pdf/1809.03452.pdf) for details:
* `0`, measurements of the raw signal (the measurement output pulse envelope)
* `1`, measurement kernel is selected (a complex number obtained after applying the measurement kernel to the measurement output signal)
* `2` (default), a discriminator is selected and the qubit state is stored (0 or 1)
This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **meas\_return** (`Union`\[`str`, `MeasReturnType`, `None`]) –
Level of measurement data for the backend to return. For `meas_level` 0 and 1:
* `single` returns information from every shot.
* `avg` returns average measurement output (averaged over number of shots).
This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **rep\_delay** (`Optional`\[`float`]) – Delay between primitives in seconds. Only supported on certain backends (if `backend.configuration().dynamic_reprate_enabled=True`). If supported, `rep_delay` must be from the range supplied by the backend (`backend.configuration().rep_delay_range`). Default is given by `backend.configuration().default_rep_delay`. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **init\_qubits** (`Optional`\[`bool`]) – Whether to reset the qubits to the ground state for each shot. Default: `True`. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **use\_measure\_esp** (`Optional`\[`bool`]) – Whether to use excited state promoted (ESP) readout for measurements which are the terminal instruction to a qubit. ESP readout can offer higher fidelity than standard measurement sequences. See [here](https://arxiv.org/pdf/2008.08571.pdf). Default: `True` if backend supports ESP readout, else `False`. Backend support for ESP readout is determined by the flag `measure_esp_enabled` in `backend.configuration()`. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **noise\_model** (`Optional`\[`Any`]) – Noise model (Simulators only). This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **seed\_simulator** (`Optional`\[`int`]) – Random seed to control sampling (Simulators only). This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **\*\*run\_config** – Extra arguments used to configure the run. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
**Return type**
[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob")
**Returns**
The job to be executed.
**Raises**
* **IBMBackendApiError** – If an unexpected error occurred while submitting the job.
* **IBMBackendApiProtocolError** – If an unexpected value received from the server.
* **IBMBackendValueError** –
* If an input parameter value is not valid. - If ESP readout is used and the backend does not support this.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.IBMBackend.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.IBMBackend.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/ibm_backend.py#L405-L427" signature="status()">
Return the backend status.
<Admonition title="Note" type="note">
If the returned `BackendStatus` instance has `operational=True` but `status_msg="internal"`, then the backend is accepting jobs but not processing them.
</Admonition>
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Raises**
**IBMBackendApiProtocolError** – If the status for the backend cannot be formatted properly.
</Function>
### target\_history
<Function id="qiskit_ibm_runtime.IBMBackend.target_history" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/ibm_backend.py#L342-L351" signature="target_history(datetime=None)">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
[`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)")
**Returns**
Target with properties found on datetime
</Function>
</Class>

441
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.QiskitRuntimeService.mdx Normal file
View File

@ -0,0 +1,441 @@
---
title: QiskitRuntimeService
description: API reference for qiskit_ibm_runtime.QiskitRuntimeService
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
---
# QiskitRuntimeService
<Class id="qiskit_ibm_runtime.QiskitRuntimeService" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/qiskit_runtime_service.py#L54-L1240" signature="QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None, private_endpoint=None)" modifiers="class">
Class for interacting with the Qiskit Runtime service.
QiskitRuntimeService constructor
An account is selected in the following order:
> * Account with the input name, if specified.
> * Default account for the channel type, if channel is specified but token is not.
> * Account defined by the input channel and token, if specified.
> * Account defined by the default\_channel if defined in filename
> * Account defined by the environment variables, if defined.
> * Default account for the `ibm_cloud` account, if one is available.
> * Default account for the `ibm_quantum` account, if one is available.
instance, proxies, and verify can be used to overwrite corresponding values in the loaded account.
**Parameters**
* **channel** (`Optional`\[`Literal`\[‘ibm\_cloud’, ‘ibm\_quantum’, ‘local’]]) – Channel type. `ibm_cloud`, `ibm_quantum` or `local`. If `local` is selected, the local testing mode will be used, and primitive queries will run on a local simulator. For more details, check the [Qiskit Runtime local testing mode](/guides/local-testing-mode) documentation.
* **token** (`Optional`\[`str`]) – IBM Cloud API key or IBM Quantum API token.
* **url** (`Optional`\[`str`]) – The API URL. Defaults to [https://cloud.ibm.com](https://cloud.ibm.com) (ibm\_cloud) or [https://auth.quantum-computing.ibm.com/api](https://auth.quantum-computing.ibm.com/api) (ibm\_quantum).
* **filename** (`Optional`\[`str`]) – Full path of the file where the account is created. Default: \_DEFAULT\_ACCOUNT\_CONFIG\_JSON\_FILE
* **name** (`Optional`\[`str`]) – Name of the account to load.
* **instance** (`Optional`\[`str`]) – The service instance to use. For `ibm_cloud` runtime, this is the Cloud Resource Name (CRN) or the service name. For `ibm_quantum` runtime, this is the hub/group/project in that format.
* **proxies** (`Optional`\[`dict`]) – Proxy configuration. Supported optional keys are `urls` (a dictionary mapping protocol or protocol and host to the URL of the proxy, documented at [https://docs.python-requests.org/en/latest/api/#requests.Session.proxies](https://docs.python-requests.org/en/latest/api/#requests.Session.proxies)), `username_ntlm`, `password_ntlm` (username and password to enable NTLM user authentication)
* **verify** (`Optional`\[`bool`]) – Whether to verify the server’s TLS certificate.
* **channel\_strategy** (`Optional`\[`str`]) – Error mitigation strategy.
* **private\_endpoint** (`Optional`\[`bool`]) – Connect to private API URL.
**Returns**
An instance of QiskitRuntimeService or QiskitRuntimeLocalService for local channel.
**Raises**
**IBMInputValueError** – If an input is invalid.
## Attributes
### channel
<Attribute id="qiskit_ibm_runtime.QiskitRuntimeService.channel">
Return the channel type used.
**Return type**
`str`
**Returns**
The channel type used.
</Attribute>
### global\_service
<Attribute id="qiskit_ibm_runtime.QiskitRuntimeService.global_service" attributeValue="None" />
## Methods
### active\_account
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.active_account" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/qiskit_runtime_service.py#L635-L641" signature="active_account()">
Return the IBM Quantum account currently in use for the session.
**Return type**
`Optional`\[`Dict`\[`str`, `str`]]
**Returns**
A dictionary with information about the account currently in the session.
</Function>
### backend
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/qiskit_runtime_service.py#L747-L796" signature="backend(name=None, instance=None, use_fractional_gates=False)">
Return a single backend matching the specified filtering.
**Parameters**
* **name** (`Optional`\[`str`]) – Name of the backend.
* **instance** (`Optional`\[`str`]) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format. If an instance is not given, among the providers with access to the backend, a premium provider will be prioritized. For users without access to a premium provider, the default open provider will be used.
* **use\_fractional\_gates** (`bool`) – Set True to allow for the backends to include fractional gates in target. Currently this feature cannot be used simulataneously with dynamic circuits, PEC, PEA, or gate twirling. When this flag is set, control flow instructions are automatically removed from the backend target. When you use the dynamic circuits feature (e.g. if\_else) in your algorithm, you must disable this flag to create executable ISA circuits. This flag might be modified or removed when our backend supports dynamic circuits and fractional gates simultaneously.
**Returns**
A backend matching the filtering.
**Return type**
Backend
**Raises**
**QiskitBackendNotFoundError** – if no backend could be found.
</Function>
### backends
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.backends" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/qiskit_runtime_service.py#L464-L577" signature="backends(name=None, min_num_qubits=None, instance=None, dynamic_circuits=None, filters=None, *, use_fractional_gates=False, **kwargs)">
Return all backends accessible via this account, subject to optional filtering.
**Parameters**
* **name** (`Optional`\[`str`]) – Backend name to filter by.
* **min\_num\_qubits** (`Optional`\[`int`]) – Minimum number of qubits the backend has to have.
* **instance** (`Optional`\[`str`]) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format.
* **dynamic\_circuits** (`Optional`\[`bool`]) – Filter by whether the backend supports dynamic circuits.
* **filters** (`Optional`\[`Callable`\[\[[`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")], `bool`]]) –
More complex filters, such as lambda functions. For example:
```python
QiskitRuntimeService.backends(
filters=lambda b: b.max_shots > 50000
)
QiskitRuntimeService.backends(
filters=lambda x: ("rz" in x.basis_gates )
)
```
* **use\_fractional\_gates** (`bool`) – Set True to allow for the backends to include fractional gates in target. Currently this feature cannot be used simulataneously with dynamic circuits, PEC, PEA, or gate twirling. When this flag is set, control flow instructions are automatically removed from the backend target. When you use the dynamic circuits feature (e.g. if\_else) in your algorithm, you must disable this flag to create executable ISA circuits. This flag might be modified or removed when our backend supports dynamic circuits and fractional gates simultaneously.
* **\*\*kwargs** –
Simple filters that require a specific value for an attribute in backend configuration or status. Examples:
```python
# Get the operational real backends
QiskitRuntimeService.backends(simulator=False, operational=True)
# Get the backends with at least 127 qubits
QiskitRuntimeService.backends(min_num_qubits=127)
# Get the backends that support OpenPulse
QiskitRuntimeService.backends(open_pulse=True)
```
For the full list of backend attributes, see the IBMBackend class documentation \<[api/qiskit/providers\_models](/api/qiskit/providers_models)>
**Return type**
`List`\[[`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")]
**Returns**
The list of available backends that match the filter.
**Raises**
* **IBMInputValueError** – If an input is invalid.
* **QiskitBackendNotFoundError** – If the backend is not in any instance.
</Function>
### check\_pending\_jobs
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.check_pending_jobs" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/qiskit_runtime_service.py#L931-L958" signature="check_pending_jobs()">
Check the number of pending jobs and wait for the oldest pending job if the maximum number of pending jobs has been reached.
**Return type**
`None`
</Function>
### delete\_account
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.delete_account" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/qiskit_runtime_service.py#L643-L661" signature="delete_account(filename=None, name=None, channel=None)" modifiers="static">
Delete a saved account from disk.
**Parameters**
* **filename** (`Optional`\[`str`]) – Name of file from which to delete the account.
* **name** (`Optional`\[`str`]) – Name of the saved account to delete.
* **channel** (`Optional`\[`Literal`\[‘ibm\_cloud’, ‘ibm\_quantum’, ‘local’]]) – Channel type of the default account to delete. Ignored if account name is provided.
**Return type**
`bool`
**Returns**
True if the account was deleted. False if no account was found.
</Function>
### delete\_job
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.delete_job" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/qiskit_runtime_service.py#L1077-L1094" signature="delete_job(job_id)">
Delete a runtime job.
Note that this operation cannot be reversed.
**Parameters**
**job\_id** (`str`) – ID of the job to delete.
**Raises**
* **RuntimeJobNotFound** – If the job doesn’t exist.
* **IBMRuntimeError** – If the request failed.
**Return type**
`None`
</Function>
### get\_backend
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.get_backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/utils/deprecation.py#L798-L801" signature="get_backend(name=None, **kwargs)">
Return a single backend matching the specified filtering.
**Return type**
[`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")
</Function>
### instances
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.instances" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/qiskit_runtime_service.py#L1212-L1220" signature="instances()">
Return the IBM Quantum instances list currently in use for the session.
**Return type**
`List`\[`str`]
**Returns**
A list with instances currently in the session.
</Function>
### job
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.job" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/qiskit_runtime_service.py#L960-L979" signature="job(job_id)">
Retrieve a runtime job.
**Parameters**
**job\_id** (`str`) – Job ID.
**Return type**
`Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), [`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.runtime_job_v2.RuntimeJobV2")]
**Returns**
Runtime job retrieved.
**Raises**
* **RuntimeJobNotFound** – If the job doesn’t exist.
* **IBMRuntimeError** – If the request failed.
</Function>
### jobs
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.jobs" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/qiskit_runtime_service.py#L981-L1075" signature="jobs(limit=10, skip=0, backend_name=None, pending=None, program_id=None, instance=None, job_tags=None, session_id=None, created_after=None, created_before=None, descending=True)">
Retrieve all runtime jobs, subject to optional filtering.
**Parameters**
* **limit** (`Optional`\[`int`]) – Number of jobs to retrieve. `None` means no limit.
* **skip** (`int`) – Starting index for the job retrieval.
* **backend\_name** (`Optional`\[`str`]) – Name of the backend to retrieve jobs from.
* **pending** (`Optional`\[`bool`]) – Filter by job pending state. If `True`, ‘QUEUED’ and ‘RUNNING’ jobs are included. If `False`, ‘DONE’, ‘CANCELLED’ and ‘ERROR’ jobs are included.
* **program\_id** (`Optional`\[`str`]) – Filter by Program ID.
* **instance** (`Optional`\[`str`]) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format.
* **job\_tags** (`Optional`\[`List`\[`str`]]) – Filter by tags assigned to jobs. Matched jobs are associated with all tags.
* **session\_id** (`Optional`\[`str`]) – Job ID of the first job in a runtime session.
* **created\_after** (`Optional`\[`datetime`]) – Filter by the given start date, in local time. This is used to find jobs whose creation dates are after (greater than or equal to) this local date/time.
* **created\_before** (`Optional`\[`datetime`]) – Filter by the given end date, in local time. This is used to find jobs whose creation dates are before (less than or equal to) this local date/time.
* **descending** (`bool`) – If `True`, return the jobs in descending order of the job creation date (i.e. newest first) until the limit is reached.
**Return type**
`List`\[`Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), [`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.runtime_job_v2.RuntimeJobV2")]]
**Returns**
A list of runtime jobs.
**Raises**
**IBMInputValueError** – If an input value is invalid.
</Function>
### least\_busy
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.least_busy" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/qiskit_runtime_service.py#L1175-L1210" signature="least_busy(min_num_qubits=None, instance=None, filters=None, **kwargs)">
Return the least busy available backend.
**Parameters**
* **min\_num\_qubits** (`Optional`\[`int`]) – Minimum number of qubits the backend has to have.
* **instance** (`Optional`\[`str`]) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format.
* **filters** (`Optional`\[`Callable`\[\[[`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")], `bool`]]) –
Filters can be defined as for the [`backends()`](#qiskit_ibm_runtime.QiskitRuntimeService.backends "qiskit_ibm_runtime.QiskitRuntimeService.backends") method. An example to get the operational backends with 5 qubits:
```python
QiskitRuntimeService.least_busy(n_qubits=5, operational=True)
```
**Return type**
[`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")
**Returns**
The backend with the fewest number of pending jobs.
**Raises**
**QiskitBackendNotFoundError** – If no backend matches the criteria.
</Function>
### run
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/qiskit_runtime_service.py#L803-L925" signature="run(program_id, inputs, options=None, callback=None, result_decoder=None, session_id=None, start_session=False)">
Execute the runtime program.
**Parameters**
* **program\_id** (`str`) – Program ID.
* **inputs** (`Dict`) – Program input parameters. These input values are passed to the runtime program.
* **options** (`Union`\[`RuntimeOptions`, `Dict`, `None`]) – Runtime options that control the execution environment.
* **callback** (`Optional`\[`Callable`]) –
Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters:
> 1. Job ID
> 2. Job result.
* **result\_decoder** (`Union`\[`Type`\[`ResultDecoder`], `Sequence`\[`Type`\[`ResultDecoder`]], `None`]) – A `ResultDecoder` subclass used to decode job results. If more than one decoder is specified, the first is used for interim results and the second final results. If not specified, a program-specific decoder or the default `ResultDecoder` is used.
* **session\_id** (`Optional`\[`str`]) – Job ID of the first job in a runtime session.
* **start\_session** (`Optional`\[`bool`]) – Set to True to explicitly start a runtime session. Defaults to False.
**Return type**
`Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), [`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.runtime_job_v2.RuntimeJobV2")]
**Returns**
A `RuntimeJob` instance representing the execution.
**Raises**
* **IBMInputValueError** – If input is invalid.
* **RuntimeProgramNotFound** – If the program cannot be found.
* **IBMRuntimeError** – An error occurred running the program.
</Function>
### save\_account
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.save_account" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/qiskit_runtime_service.py#L663-L715" signature="save_account(token=None, url=None, instance=None, channel=None, filename=None, name=None, proxies=None, verify=None, overwrite=False, channel_strategy=None, set_as_default=None, private_endpoint=False)" modifiers="static">
Save the account to disk for future use.
**Parameters**
* **token** (`Optional`\[`str`]) – IBM Cloud API key or IBM Quantum API token.
* **url** (`Optional`\[`str`]) – The API URL. Defaults to [https://cloud.ibm.com](https://cloud.ibm.com) (ibm\_cloud) or [https://auth.quantum-computing.ibm.com/api](https://auth.quantum-computing.ibm.com/api) (ibm\_quantum).
* **instance** (`Optional`\[`str`]) – The CRN (ibm\_cloud) or hub/group/project (ibm\_quantum).
* **channel** (`Optional`\[`Literal`\[‘ibm\_cloud’, ‘ibm\_quantum’, ‘local’]]) – Channel type. ibm\_cloud or ibm\_quantum.
* **filename** (`Optional`\[`str`]) – Full path of the file where the account is saved.
* **name** (`Optional`\[`str`]) – Name of the account to save.
* **proxies** (`Optional`\[`dict`]) – Proxy configuration. Supported optional keys are `urls` (a dictionary mapping protocol or protocol and host to the URL of the proxy, documented at [https://docs.python-requests.org/en/latest/api/#requests.Session.proxies](https://docs.python-requests.org/en/latest/api/#requests.Session.proxies)), `username_ntlm`, `password_ntlm` (username and password to enable NTLM user authentication)
* **verify** (`Optional`\[`bool`]) – Verify the server’s TLS certificate.
* **overwrite** (`Optional`\[`bool`]) – `True` if the existing account is to be overwritten.
* **channel\_strategy** (`Optional`\[`str`]) – Error mitigation strategy.
* **set\_as\_default** (`Optional`\[`bool`]) – If `True`, the account is saved in filename, as the default account.
* **private\_endpoint** (`Optional`\[`bool`]) – Connect to private API URL.
**Return type**
`None`
</Function>
### saved\_accounts
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.saved_accounts" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/qiskit_runtime_service.py#L717-L745" signature="saved_accounts(default=None, channel=None, filename=None, name=None)" modifiers="static">
List the accounts saved on disk.
**Parameters**
* **default** (`Optional`\[`bool`]) – If set to True, only default accounts are returned.
* **channel** (`Optional`\[`Literal`\[‘ibm\_cloud’, ‘ibm\_quantum’, ‘local’]]) – Channel type. ibm\_cloud or ibm\_quantum.
* **filename** (`Optional`\[`str`]) – Name of file whose accounts are returned.
* **name** (`Optional`\[`str`]) – If set, only accounts with the given name are returned.
**Return type**
`dict`
**Returns**
A dictionary with information about the accounts saved on disk.
**Raises**
**ValueError** – If an invalid account is found on disk.
</Function>
### usage
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.usage" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/qiskit_runtime_service.py#L1096-L1109" signature="usage()">
Return monthly open plan usage information.
**Return type**
`Dict`\[`str`, `Any`]
**Returns**
Dict with usage details.
**Raises**
**IBMInputValueError** – If method is called when using the ibm\_cloud channel
</Function>
</Class>

52
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.RuntimeDecoder.mdx Normal file
View File

@ -0,0 +1,52 @@
---
title: RuntimeDecoder
description: API reference for qiskit_ibm_runtime.RuntimeDecoder
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.RuntimeDecoder
---
# RuntimeDecoder
<Class id="qiskit_ibm_runtime.RuntimeDecoder" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/utils/json.py#L368-L469" signature="RuntimeDecoder(*args, **kwargs)" modifiers="class">
JSON Decoder used by runtime service.
`object_hook`, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given `dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting).
`object_pairs_hook`, if specified will be called with the result of every JSON object decoded with an ordered list of pairs. The return value of `object_pairs_hook` will be used instead of the `dict`. This feature can be used to implement custom decoders. If `object_hook` is also defined, the `object_pairs_hook` takes priority.
`parse_float`, if specified, will be called with the string of every JSON float to be decoded. By default this is equivalent to float(num\_str). This can be used to use another datatype or parser for JSON floats (e.g. decimal.Decimal).
`parse_int`, if specified, will be called with the string of every JSON int to be decoded. By default this is equivalent to int(num\_str). This can be used to use another datatype or parser for JSON integers (e.g. float).
`parse_constant`, if specified, will be called with one of the following strings: -Infinity, Infinity, NaN. This can be used to raise an exception if invalid JSON numbers are encountered.
If `strict` is false (true is the default), then control characters will be allowed inside strings. Control characters in this context are those with character codes in the 0-31 range, including `'\t'` (tab), `'\n'`, `'\r'` and `'\0'`.
## Methods
### decode
<Function id="qiskit_ibm_runtime.RuntimeDecoder.decode" signature="decode(s, _w=<built-in method match of re.Pattern object>)">
Return the Python representation of `s` (a `str` instance containing a JSON document).
</Function>
### object\_hook
<Function id="qiskit_ibm_runtime.RuntimeDecoder.object_hook" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/utils/json.py#L376-L469" signature="object_hook(obj)">
Called to decode object.
**Return type**
`Any`
</Function>
### raw\_decode
<Function id="qiskit_ibm_runtime.RuntimeDecoder.raw_decode" signature="raw_decode(s, idx=0)">
Decode a JSON document from `s` (a `str` beginning with a JSON document) and return a 2-tuple of the Python representation and the index in `s` where the document ended.
This can be used to decode a JSON document from a string that may have extraneous data at the end.
</Function>
</Class>

93
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.RuntimeEncoder.mdx Normal file
View File

@ -0,0 +1,93 @@
---
title: RuntimeEncoder
description: API reference for qiskit_ibm_runtime.RuntimeEncoder
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.RuntimeEncoder
---
# RuntimeEncoder
<Class id="qiskit_ibm_runtime.RuntimeEncoder" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/utils/json.py#L230-L365" signature="RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)" modifiers="class">
JSON Encoder used by runtime service.
Constructor for JSONEncoder, with sensible defaults.
If skipkeys is false, then it is a TypeError to attempt encoding of keys that are not str, int, float or None. If skipkeys is True, such items are simply skipped.
If ensure\_ascii is true, the output is guaranteed to be str objects with all incoming non-ASCII characters escaped. If ensure\_ascii is false, the output can contain non-ASCII characters.
If check\_circular is true, then lists, dicts, and custom encoded objects will be checked for circular references during encoding to prevent an infinite recursion (which would cause an RecursionError). Otherwise, no such check takes place.
If allow\_nan is true, then NaN, Infinity, and -Infinity will be encoded as such. This behavior is not JSON specification compliant, but is consistent with most JavaScript based encoders and decoders. Otherwise, it will be a ValueError to encode such floats.
If sort\_keys is true, then the output of dictionaries will be sorted by key; this is useful for regression tests to ensure that JSON serializations can be compared on a day-to-day basis.
If indent is a non-negative integer, then JSON array elements and object members will be pretty-printed with that indent level. An indent level of 0 will only insert newlines. None is the most compact representation.
If specified, separators should be an (item\_separator, key\_separator) tuple. The default is (’, ‘, ‘: ‘) if *indent* is `None` and (‘,’, ‘: ‘) otherwise. To get the most compact JSON representation, you should specify (‘,’, ‘:’) to eliminate whitespace.
If specified, default is a function that gets called for objects that can’t otherwise be serialized. It should return a JSON encodable version of the object or raise a `TypeError`.
## Attributes
### item\_separator
<Attribute id="qiskit_ibm_runtime.RuntimeEncoder.item_separator" attributeValue="', '" />
### key\_separator
<Attribute id="qiskit_ibm_runtime.RuntimeEncoder.key_separator" attributeValue="': '" />
## Methods
### default
<Function id="qiskit_ibm_runtime.RuntimeEncoder.default" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/utils/json.py#L233-L365" signature="default(obj)">
Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`).
For example, to support arbitrary iterators, you could implement default like this:
```python
def default(self, o):
try:
iterable = iter(o)
except TypeError:
pass
else:
return list(iterable)
# Let the base class default method raise the TypeError
return JSONEncoder.default(self, o)
```
**Return type**
`Any`
</Function>
### encode
<Function id="qiskit_ibm_runtime.RuntimeEncoder.encode" signature="encode(o)">
Return a JSON string representation of a Python data structure.
```python
>>> from json.encoder import JSONEncoder
>>> JSONEncoder().encode({"foo": ["bar", "baz"]})
'{"foo": ["bar", "baz"]}'
```
</Function>
### iterencode
<Function id="qiskit_ibm_runtime.RuntimeEncoder.iterencode" signature="iterencode(o, _one_shot=False)">
Encode the given object and yield each string representation as available.
For example:
```python
for chunk in JSONEncoder().iterencode(bigobject):
mysocket.write(chunk)
```
</Function>
</Class>

539
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.RuntimeJob.mdx Normal file
View File

@ -0,0 +1,539 @@
---
title: RuntimeJob
description: API reference for qiskit_ibm_runtime.RuntimeJob
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.RuntimeJob
---
# RuntimeJob
<Class id="qiskit_ibm_runtime.RuntimeJob" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job.py#L46-L408" signature="RuntimeJob(backend, api_client, client_params, job_id, program_id, service, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None, version=None)" modifiers="class">
Representation of a runtime primitive execution.
A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime primitive, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job.
If the primitive execution is successful, you can inspect the job’s status by calling [`status()`](#qiskit_ibm_runtime.RuntimeJob.status "qiskit_ibm_runtime.RuntimeJob.status"). Job status can be one of the [`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.2)") members.
Some of the methods in this class are blocking, which means control may not be returned immediately. [`result()`](#qiskit_ibm_runtime.RuntimeJob.result "qiskit_ibm_runtime.RuntimeJob.result") is an example of a blocking method:
```python
job = service.run(...)
try:
job_result = job.result() # It will block until the job finishes.
print("The job finished with result {}".format(job_result))
except RuntimeJobFailureError as ex:
print("Job failed!: {}".format(ex))
```
If the primitive has any interim results, you can use the `callback` parameter of the [`run()`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") method to stream the interim results along with the final result. Alternatively, you can use the [`stream_results()`](#qiskit_ibm_runtime.RuntimeJob.stream_results "qiskit_ibm_runtime.RuntimeJob.stream_results") method to stream the results at a later time, but before the job finishes.
RuntimeJob constructor.
**Parameters**
* **backend** ([`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)")) – The backend instance used to run this job.
* **api\_client** (`RuntimeClient`) – Object for connecting to the server.
* **client\_params** (`ClientParameters`) – Parameters used for server connection.
* **job\_id** (`str`) – Job ID.
* **program\_id** (`str`) – ID of the program this job is for.
* **creation\_date** (`Optional`\[`str`]) – Job creation date, in UTC.
* **user\_callback** (`Optional`\[`Callable`]) – User callback function.
* **result\_decoder** (`Union`\[`Type`\[`ResultDecoder`], `Sequence`\[`Type`\[`ResultDecoder`]], `None`]) – A `ResultDecoder` subclass used to decode job results.
* **image** (`Optional`\[`str`]) – Runtime image used for this job: image\_name:tag.
* **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – Runtime service.
* **session\_id** (`Optional`\[`str`]) – Job ID of the first job in a runtime session.
* **tags** (`Optional`\[`List`]) – Tags assigned to the job.
* **version** (`Optional`\[`int`]) – Primitive version.
## Attributes
### ERROR
<Attribute id="qiskit_ibm_runtime.RuntimeJob.ERROR" attributeTypeHint="str | RuntimeJobStatus" attributeValue="'job incurred error'" />
### JOB\_FINAL\_STATES
<Attribute id="qiskit_ibm_runtime.RuntimeJob.JOB_FINAL_STATES" attributeTypeHint="Tuple[Any, ...]" attributeValue="(JobStatus.DONE, JobStatus.CANCELLED, JobStatus.ERROR)" />
### creation\_date
<Attribute id="qiskit_ibm_runtime.RuntimeJob.creation_date">
Job creation date in local time.
**Return type**
`Optional`\[`datetime`]
**Returns**
The job creation date as a datetime object, in local time, or `None` if creation date is not available.
</Attribute>
### image
<Attribute id="qiskit_ibm_runtime.RuntimeJob.image">
Return the runtime image used for the job.
**Returns**
image\_name:tag or “” if the default image is used.
**Return type**
Runtime image
</Attribute>
### inputs
<Attribute id="qiskit_ibm_runtime.RuntimeJob.inputs">
Job input parameters.
**Return type**
`Dict`
**Returns**
Input parameters used in this job.
</Attribute>
### instance
<Attribute id="qiskit_ibm_runtime.RuntimeJob.instance">
For ibm\_quantum channel jobs, return the instance where the job was run. For ibm\_cloud, None is returned.
**Return type**
`Optional`\[`str`]
</Attribute>
### primitive\_id
<Attribute id="qiskit_ibm_runtime.RuntimeJob.primitive_id">
Primitive name. :rtype: `str` :returns: Primitive this job is for.
</Attribute>
### program\_id
<Attribute id="qiskit_ibm_runtime.RuntimeJob.program_id">
Program ID.
**Return type**
`str`
**Returns**
ID of the program this job is for.
</Attribute>
### session\_id
<Attribute id="qiskit_ibm_runtime.RuntimeJob.session_id">
Session ID.
**Return type**
`str`
**Returns**
Session ID. None if the backend is a simulator.
</Attribute>
### tags
<Attribute id="qiskit_ibm_runtime.RuntimeJob.tags">
Job tags.
**Return type**
`List`
**Returns**
Tags assigned to the job that can be used for filtering.
</Attribute>
### usage\_estimation
<Attribute id="qiskit_ibm_runtime.RuntimeJob.usage_estimation">
Return the usage estimation infromation for this job.
**Return type**
`Dict`\[`str`, `Any`]
**Returns**
`quantum_seconds` which is the estimated system execution time of the job in seconds. Quantum time represents the time that the system is dedicated to processing your job.
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.RuntimeJob.version" attributeValue="1" />
## Methods
### backend
<Function id="qiskit_ibm_runtime.RuntimeJob.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job.py#L342-L356" signature="backend(timeout=None)">
Return the backend where this job was executed. Retrieve data again if backend is None.
**Raises**
**IBMRuntimeError** – If a network error occurred.
**Return type**
`Optional`\[[`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)")]
</Function>
### cancel
<Function id="qiskit_ibm_runtime.RuntimeJob.cancel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job.py#L171-L185" signature="cancel()">
Cancel the job.
**Raises**
* **RuntimeInvalidStateError** – If the job is in a state that cannot be cancelled.
* **IBMRuntimeError** – If unable to cancel job.
**Return type**
`None`
</Function>
### cancel\_result\_streaming
<Function id="qiskit_ibm_runtime.RuntimeJob.cancel_result_streaming" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/base_runtime_job.py#L132-L136" signature="cancel_result_streaming()">
Cancel result streaming.
**Return type**
`None`
</Function>
### cancelled
<Function id="qiskit_ibm_runtime.RuntimeJob.cancelled" signature="cancelled()">
Return whether the job has been cancelled.
**Return type**
`bool`
</Function>
### done
<Function id="qiskit_ibm_runtime.RuntimeJob.done" signature="done()">
Return whether the job has successfully run.
**Return type**
`bool`
</Function>
### error\_message
<Function id="qiskit_ibm_runtime.RuntimeJob.error_message" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/base_runtime_job.py#L195-L202" signature="error_message()">
Returns the reason if the job failed.
**Return type**
`Optional`\[`str`]
**Returns**
Error message string or `None`.
</Function>
### errored
<Function id="qiskit_ibm_runtime.RuntimeJob.errored" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job.py#L200-L202" signature="errored()">
Return whether the job has failed.
**Return type**
`bool`
</Function>
### in\_final\_state
<Function id="qiskit_ibm_runtime.RuntimeJob.in_final_state" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job.py#L196-L198" signature="in_final_state()">
Return whether the job is in a final job state such as `DONE` or `ERROR`.
**Return type**
`bool`
</Function>
### interim\_results
<Function id="qiskit_ibm_runtime.RuntimeJob.interim_results" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/utils/deprecation.py#L389-L408" signature="interim_results(decoder=None)">
Return the interim results of the job.
**Parameters**
**decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode interim results.
**Return type**
`Any`
**Returns**
Runtime job interim results.
**Raises**
**RuntimeJobFailureError** – If the job failed.
</Function>
### job\_id
<Function id="qiskit_ibm_runtime.RuntimeJob.job_id" signature="job_id()">
Return a unique id identifying the job.
**Return type**
`str`
</Function>
### logs
<Function id="qiskit_ibm_runtime.RuntimeJob.logs" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job.py#L293-L312" signature="logs()">
Return job logs.
<Admonition title="Note" type="note">
Job logs are only available after the job finishes.
</Admonition>
**Return type**
`str`
**Returns**
Job logs, including standard output and error.
**Raises**
**IBMRuntimeError** – If a network error occurred.
</Function>
### metrics
<Function id="qiskit_ibm_runtime.RuntimeJob.metrics" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/base_runtime_job.py#L138-L150" signature="metrics()">
Return job metrics.
**Return type**
`Dict`\[`str`, `Any`]
**Returns**
Job metrics, which includes timestamp information.
**Raises**
**IBMRuntimeError** – If a network error occurred.
</Function>
### properties
<Function id="qiskit_ibm_runtime.RuntimeJob.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/base_runtime_job.py#L181-L193" signature="properties(refresh=False)">
Return the backend properties for this job.
**Parameters**
**refresh** (`bool`) – If `True`, re-query the server for the backend properties. Otherwise, return a cached version.
**Return type**
`Optional`\[`BackendProperties`]
**Returns**
The backend properties used for this job, at the time the job was run, or `None` if properties are not available.
</Function>
### queue\_info
<Function id="qiskit_ibm_runtime.RuntimeJob.queue_info" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job.py#L259-L291" signature="queue_info()">
Return queue information for this job.
The queue information may include queue position, estimated start and end time, and dynamic priorities for the hub, group, and project. See `QueueInfo` for more information.
<Admonition title="Note" type="note">
The queue information is calculated after the job enters the queue. Therefore, some or all of the information may not be immediately available, and this method may return `None`.
</Admonition>
**Return type**
`Optional`\[`QueueInfo`]
**Returns**
A `QueueInfo` instance that contains queue information for this job, or `None` if queue information is unknown or not applicable.
</Function>
### queue\_position
<Function id="qiskit_ibm_runtime.RuntimeJob.queue_position" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job.py#L232-L257" signature="queue_position(refresh=False)">
Return the position of the job in the server queue.
<Admonition title="Note" type="note">
The position returned is within the scope of the provider and may differ from the global queue position.
</Admonition>
**Parameters**
**refresh** (`bool`) – If `True`, re-query the server to get the latest value. Otherwise return the cached value.
**Return type**
`Optional`\[`int`]
**Returns**
Position in the queue or `None` if position is unknown or not applicable.
</Function>
### result
<Function id="qiskit_ibm_runtime.RuntimeJob.result" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job.py#L136-L169" signature="result(timeout=None, decoder=None)">
Return the results of the job.
**Parameters**
* **timeout** (`Optional`\[`float`]) – Number of seconds to wait for job.
* **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode job results.
**Return type**
`Any`
**Returns**
Runtime job result.
**Raises**
* **RuntimeJobFailureError** – If the job failed.
* **RuntimeJobMaxTimeoutError** – If the job does not complete within given timeout.
* **RuntimeInvalidStateError** – If the job was cancelled, and attempting to retrieve result.
</Function>
### running
<Function id="qiskit_ibm_runtime.RuntimeJob.running" signature="running()">
Return whether the job is actively running.
**Return type**
`bool`
</Function>
### status
<Function id="qiskit_ibm_runtime.RuntimeJob.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job.py#L187-L194" signature="status()">
Return the status of the job.
**Return type**
[`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.2)")
**Returns**
Status of this job.
</Function>
### stream\_results
<Function id="qiskit_ibm_runtime.RuntimeJob.stream_results" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/utils/deprecation.py#L358-L387" signature="stream_results(callback, decoder=None)">
Start streaming job results.
**Parameters**
* **callback** (`Callable`) –
Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters:
> 1. Job ID
> 2. Job result.
* **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode job results.
**Raises**
**RuntimeInvalidStateError** – If a callback function is already streaming results or if the job already finished.
**Return type**
`None`
</Function>
### submit
<Function id="qiskit_ibm_runtime.RuntimeJob.submit" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job.py#L218-L230" signature="submit()">
Unsupported method. .. note:
```python
This method is not supported, please use
:meth:`~qiskit_ibm_runtime.QiskitRuntimeService.run`
to submit a job.
```
**Raises**
**NotImplementedError** – Upon invocation.
**Return type**
`None`
</Function>
### update\_tags
<Function id="qiskit_ibm_runtime.RuntimeJob.update_tags" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/base_runtime_job.py#L152-L179" signature="update_tags(new_tags)">
Update the tags associated with this job.
**Parameters**
**new\_tags** (`List`\[`str`]) – New tags to assign to the job.
**Return type**
`List`\[`str`]
**Returns**
The new tags associated with this job.
**Raises**
**IBMApiError** – If an unexpected error occurred when communicating with the server or updating the job tags.
</Function>
### wait\_for\_final\_state
<Function id="qiskit_ibm_runtime.RuntimeJob.wait_for_final_state" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job.py#L314-L340" signature="wait_for_final_state(timeout=None)">
Poll for the job status from the API until the status is in a final state.
**Parameters**
**timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely.
**Raises**
**RuntimeJobTimeoutError** – If the job does not complete within given timeout.
**Return type**
`None`
</Function>
</Class>

455
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.RuntimeJobV2.mdx Normal file
View File

@ -0,0 +1,455 @@
---
title: RuntimeJobV2
description: API reference for qiskit_ibm_runtime.RuntimeJobV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.RuntimeJobV2
---
# RuntimeJobV2
<Class id="qiskit_ibm_runtime.RuntimeJobV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job_v2.py#L53-L325" signature="RuntimeJobV2(backend, api_client, client_params, job_id, program_id, service, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None, version=None)" modifiers="class">
Representation of a runtime V2 primitive exeuction.
RuntimeJob constructor.
**Parameters**
* **backend** ([`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)")) – The backend instance used to run this job.
* **api\_client** (`RuntimeClient`) – Object for connecting to the server.
* **client\_params** (`ClientParameters`) – Parameters used for server connection.
* **job\_id** (`str`) – Job ID.
* **program\_id** (`str`) – ID of the program this job is for.
* **creation\_date** (`Optional`\[`str`]) – Job creation date, in UTC.
* **user\_callback** (`Optional`\[`Callable`]) – User callback function.
* **result\_decoder** (`Union`\[`Type`\[`ResultDecoder`], `Sequence`\[`Type`\[`ResultDecoder`]], `None`]) – A `ResultDecoder` subclass used to decode job results.
* **image** (`Optional`\[`str`]) – Runtime image used for this job: image\_name:tag.
* **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – Runtime service.
* **session\_id** (`Optional`\[`str`]) – Job ID of the first job in a runtime session.
* **tags** (`Optional`\[`List`]) – Tags assigned to the job.
* **version** (`Optional`\[`int`]) – Primitive version.
## Attributes
### ERROR
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.ERROR" attributeTypeHint="str | RuntimeJobStatus" attributeValue="'ERROR'" />
### JOB\_FINAL\_STATES
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.JOB_FINAL_STATES" attributeTypeHint="Tuple[Literal['INITIALIZING', 'QUEUED', 'RUNNING', 'CANCELLED', 'DONE', 'ERROR'], ...]" attributeValue="('DONE', 'CANCELLED', 'ERROR')" />
### creation\_date
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.creation_date">
Job creation date in local time.
**Return type**
`Optional`\[`datetime`]
**Returns**
The job creation date as a datetime object, in local time, or `None` if creation date is not available.
</Attribute>
### image
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.image">
Return the runtime image used for the job.
**Returns**
image\_name:tag or “” if the default image is used.
**Return type**
Runtime image
</Attribute>
### inputs
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.inputs">
Job input parameters.
**Return type**
`Dict`
**Returns**
Input parameters used in this job.
</Attribute>
### instance
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.instance">
For ibm\_quantum channel jobs, return the instance where the job was run. For ibm\_cloud, None is returned.
**Return type**
`Optional`\[`str`]
</Attribute>
### primitive\_id
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.primitive_id">
Primitive name. :rtype: `str` :returns: Primitive this job is for.
</Attribute>
### program\_id
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.program_id">
Program ID.
**Return type**
`str`
**Returns**
ID of the program this job is for.
</Attribute>
### session\_id
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.session_id">
Session ID.
**Return type**
`str`
**Returns**
Session ID. None if the backend is a simulator.
</Attribute>
### tags
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.tags">
Job tags.
**Return type**
`List`
**Returns**
Tags assigned to the job that can be used for filtering.
</Attribute>
### usage\_estimation
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.usage_estimation">
Return the usage estimation infromation for this job.
**Return type**
`Dict`\[`str`, `Any`]
**Returns**
`quantum_seconds` which is the estimated system execution time of the job in seconds. Quantum time represents the time that the system is dedicated to processing your job.
</Attribute>
## Methods
### backend
<Function id="qiskit_ibm_runtime.RuntimeJobV2.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job_v2.py#L259-L273" signature="backend(timeout=None)">
Return the backend where this job was executed. Retrieve data again if backend is None.
**Raises**
**IBMRuntimeError** – If a network error occurred.
**Return type**
`Optional`\[[`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)")]
</Function>
### cancel
<Function id="qiskit_ibm_runtime.RuntimeJobV2.cancel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job_v2.py#L148-L162" signature="cancel()">
Cancel the job.
**Raises**
* **RuntimeInvalidStateError** – If the job is in a state that cannot be cancelled.
* **IBMRuntimeError** – If unable to cancel job.
**Return type**
`None`
</Function>
### cancel\_result\_streaming
<Function id="qiskit_ibm_runtime.RuntimeJobV2.cancel_result_streaming" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/base_runtime_job.py#L132-L136" signature="cancel_result_streaming()">
Cancel result streaming.
**Return type**
`None`
</Function>
### cancelled
<Function id="qiskit_ibm_runtime.RuntimeJobV2.cancelled" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job_v2.py#L190-L192" signature="cancelled()">
Return whether the job has been cancelled.
**Return type**
`bool`
</Function>
### done
<Function id="qiskit_ibm_runtime.RuntimeJobV2.done" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job_v2.py#L194-L196" signature="done()">
Return whether the job has successfully run.
**Return type**
`bool`
</Function>
### error\_message
<Function id="qiskit_ibm_runtime.RuntimeJobV2.error_message" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/base_runtime_job.py#L195-L202" signature="error_message()">
Returns the reason if the job failed.
**Return type**
`Optional`\[`str`]
**Returns**
Error message string or `None`.
</Function>
### errored
<Function id="qiskit_ibm_runtime.RuntimeJobV2.errored" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job_v2.py#L198-L200" signature="errored()">
Return whether the job has failed.
**Return type**
`bool`
</Function>
### in\_final\_state
<Function id="qiskit_ibm_runtime.RuntimeJobV2.in_final_state" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job_v2.py#L202-L204" signature="in_final_state()">
Return whether the job is in a final job state such as `DONE` or `ERROR`.
**Return type**
`bool`
</Function>
### interim\_results
<Function id="qiskit_ibm_runtime.RuntimeJobV2.interim_results" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/utils/deprecation.py#L306-L325" signature="interim_results(decoder=None)">
Return the interim results of the job.
**Parameters**
**decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode interim results.
**Return type**
`Any`
**Returns**
Runtime job interim results.
**Raises**
**RuntimeJobFailureError** – If the job failed.
</Function>
### job\_id
<Function id="qiskit_ibm_runtime.RuntimeJobV2.job_id" signature="job_id()">
Return a unique id identifying the job.
**Return type**
`str`
</Function>
### logs
<Function id="qiskit_ibm_runtime.RuntimeJobV2.logs" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job_v2.py#L210-L229" signature="logs()">
Return job logs.
<Admonition title="Note" type="note">
Job logs are only available after the job finishes.
</Admonition>
**Return type**
`str`
**Returns**
Job logs, including standard output and error.
**Raises**
**IBMRuntimeError** – If a network error occurred.
</Function>
### metrics
<Function id="qiskit_ibm_runtime.RuntimeJobV2.metrics" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/base_runtime_job.py#L138-L150" signature="metrics()">
Return job metrics.
**Return type**
`Dict`\[`str`, `Any`]
**Returns**
Job metrics, which includes timestamp information.
**Raises**
**IBMRuntimeError** – If a network error occurred.
</Function>
### properties
<Function id="qiskit_ibm_runtime.RuntimeJobV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/base_runtime_job.py#L181-L193" signature="properties(refresh=False)">
Return the backend properties for this job.
**Parameters**
**refresh** (`bool`) – If `True`, re-query the server for the backend properties. Otherwise, return a cached version.
**Return type**
`Optional`\[`BackendProperties`]
**Returns**
The backend properties used for this job, at the time the job was run, or `None` if properties are not available.
</Function>
### result
<Function id="qiskit_ibm_runtime.RuntimeJobV2.result" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job_v2.py#L113-L146" signature="result(timeout=None, decoder=None)">
Return the results of the job.
**Parameters**
* **timeout** (`Optional`\[`float`]) – Number of seconds to wait for job.
* **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode job results.
**Return type**
`Any`
**Returns**
Runtime job result.
**Raises**
* **RuntimeJobFailureError** – If the job failed.
* **RuntimeJobMaxTimeoutError** – If the job does not complete within given timeout.
* **RuntimeInvalidStateError** – If the job was cancelled, and attempting to retrieve result.
</Function>
### running
<Function id="qiskit_ibm_runtime.RuntimeJobV2.running" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job_v2.py#L206-L208" signature="running()">
Return whether the job is actively running.
**Return type**
`bool`
</Function>
### status
<Function id="qiskit_ibm_runtime.RuntimeJobV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job_v2.py#L164-L171" signature="status()">
Return the status of the job.
**Return type**
`Literal`\[‘INITIALIZING’, ‘QUEUED’, ‘RUNNING’, ‘CANCELLED’, ‘DONE’, ‘ERROR’]
**Returns**
Status of this job.
</Function>
### stream\_results
<Function id="qiskit_ibm_runtime.RuntimeJobV2.stream_results" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/utils/deprecation.py#L275-L304" signature="stream_results(callback, decoder=None)">
Start streaming job results.
**Parameters**
* **callback** (`Callable`) –
Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters:
> 1. Job ID
> 2. Job result.
* **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode job results.
**Raises**
**RuntimeInvalidStateError** – If a callback function is already streaming results or if the job already finished.
**Return type**
`None`
</Function>
### update\_tags
<Function id="qiskit_ibm_runtime.RuntimeJobV2.update_tags" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/base_runtime_job.py#L152-L179" signature="update_tags(new_tags)">
Update the tags associated with this job.
**Parameters**
**new\_tags** (`List`\[`str`]) – New tags to assign to the job.
**Return type**
`List`\[`str`]
**Returns**
The new tags associated with this job.
**Raises**
**IBMApiError** – If an unexpected error occurred when communicating with the server or updating the job tags.
</Function>
### wait\_for\_final\_state
<Function id="qiskit_ibm_runtime.RuntimeJobV2.wait_for_final_state" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/runtime_job_v2.py#L231-L257" signature="wait_for_final_state(timeout=None)">
Poll for the job status from the API until the status is in a final state.
**Parameters**
**timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely.
**Raises**
**RuntimeJobTimeoutError** – If the job does not complete within given timeout.
**Return type**
`None`
</Function>
</Class>

14
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.Sampler.mdx Normal file
View File

@ -0,0 +1,14 @@
---
title: Sampler
description: API reference for qiskit_ibm_runtime.Sampler
in_page_toc_min_heading_level: 1
python_api_type: attribute
python_api_name: qiskit_ibm_runtime.Sampler
---
# Sampler
<Attribute id="qiskit_ibm_runtime.Sampler" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/sampler.py#L46-L172">
alias of [`SamplerV2`](qiskit_ibm_runtime.SamplerV2 "qiskit_ibm_runtime.sampler.SamplerV2")
</Attribute>

117
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.SamplerV2.mdx Normal file
View File

@ -0,0 +1,117 @@
---
title: SamplerV2
description: API reference for qiskit_ibm_runtime.SamplerV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.SamplerV2
---
# SamplerV2
<Class id="qiskit_ibm_runtime.SamplerV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/sampler.py#L46-L172" signature="SamplerV2(mode=None, backend=None, session=None, options=None)" modifiers="class">
Class for interacting with Qiskit Runtime Sampler primitive service.
This class supports version 2 of the Sampler interface, which uses different input and output formats than version 1.
Qiskit Runtime Sampler primitive returns the sampled result according to the specified output type. For example, it returns a bitstring for each shot if measurement level 2 (bits) is requested.
The [`run()`](#qiskit_ibm_runtime.SamplerV2.run "qiskit_ibm_runtime.SamplerV2.run") method can be used to submit circuits and parameters to the Sampler primitive.
Initializes the Sampler primitive.
**Parameters**
* **mode** (`Union`\[[`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.2)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)"), [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.batch.Batch"), `str`, `None`]) –
The execution mode used to make the primitive query. It can be:
* A `Backend` if you are using job mode.
* A [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") if you are using session execution mode.
* A [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch") if you are using batch execution mode.
Refer to the [Qiskit Runtime documentation](/guides/execution-modes). for more information about the `Execution modes`.
* **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.2)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)"), `None`]) – (DEPRECATED) Backend to run the primitive. This can be a backend name or an [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") instance. If a name is specified, the default account (e.g. `QiskitRuntimeService()`) is used.
* **session** (`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")]) –
(DEPRECATED) Session in which to call the primitive.
If both `session` and `backend` are specified, `session` takes precedence. If neither is specified, and the primitive is created inside a [`qiskit_ibm_runtime.Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") context manager, then the session is used. Otherwise if IBM Cloud channel is used, a default backend is selected.
* **options** (`Union`\[`Dict`, [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.sampler_options.SamplerOptions"), `None`]) – Sampler options, see `SamplerOptions` for detailed description.
**Raises**
**NotImplementedError** – If “q-ctrl” channel strategy is used.
## Attributes
### mode
<Attribute id="qiskit_ibm_runtime.SamplerV2.mode">
Return the execution mode used by this primitive.
**Return type**
Optional\[[Session](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") | [Batch](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch")]
**Returns**
Mode used by this primitive, or `None` if an execution mode is not used.
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.SamplerV2.options" attributeTypeHint="SamplerOptions">
Return options
**Return type**
`TypeVar`(`OptionsT`, bound= `BaseOptions`)
</Attribute>
### session
<Attribute id="qiskit_ibm_runtime.SamplerV2.session">
Return session used by this primitive.
**Return type**
`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")]
**Returns**
Session used by this primitive, or `None` if session is not used.
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.SamplerV2.version" attributeValue="2" />
## Methods
### run
<Function id="qiskit_ibm_runtime.SamplerV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/sampler.py#L134-L156" signature="run(pubs, *, shots=None)">
Submit a request to the sampler primitive.
**Parameters**
* **pubs** (*Iterable\[SamplerPubLike]*) – An iterable of pub-like objects. For example, a list of circuits or tuples `(circuit, parameter_values)`.
* **shots** (*int | None*) – The total number of shots to sample for each sampler pub that does not specify its own shots. If `None`, the primitive’s default shots value will be used, which can vary by implementation.
**Return type**
[RuntimeJobV2](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.RuntimeJobV2")
**Returns**
Submitted job. The result of the job is an instance of `qiskit.primitives.containers.PrimitiveResult`.
**Raises**
**ValueError** – Invalid arguments are given.
</Function>
</Class>

221
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.Session.mdx Normal file
View File

@ -0,0 +1,221 @@
---
title: Session
description: API reference for qiskit_ibm_runtime.Session
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.Session
---
# Session
<Class id="qiskit_ibm_runtime.Session" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/session.py#L47-L399" signature="Session(service=None, backend=None, max_time=None)" modifiers="class">
Class for creating a Qiskit Runtime session.
A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler.
You can open a Qiskit Runtime session using this `Session` class and submit jobs to one or more primitives.
For example:
```python
from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister
from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
from qiskit_ibm_runtime import Session, SamplerV2 as Sampler
service = QiskitRuntimeService()
backend = service.least_busy(operational=True, simulator=False)
# Bell Circuit
qr = QuantumRegister(2, name="qr")
cr = ClassicalRegister(2, name="cr")
qc = QuantumCircuit(qr, cr, name="bell")
qc.h(qr[0])
qc.cx(qr[0], qr[1])
qc.measure(qr, cr)
pm = generate_preset_pass_manager(backend=backend, optimization_level=1)
isa_circuit = pm.run(qc)
with Session(backend=backend) as session:
sampler = Sampler(session=session)
job = sampler.run([isa_circuit])
pub_result = job.result()[0]
print(f"Sampler job ID: {job.job_id()}")
print(f"Counts: {pub_result.data.cr.get_counts()}")
```
Session constructor.
**Parameters**
* **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – (DEPRECATED) Optional instance of the `QiskitRuntimeService` class. If `None`, the service associated with the backend, if known, is used. Otherwise `QiskitRuntimeService()` is used to initialize your default saved account.
* **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.2)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)"), `None`]) – Instance of `Backend` class or string name of backend. Note that passing a backend name is deprecated.
* **max\_time** (`Union`\[`int`, `str`, `None`]) – Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/guides/max-execution-time).
**Raises**
**ValueError** – If an input value is invalid.
## Attributes
### service
<Attribute id="qiskit_ibm_runtime.Session.service">
Return service associated with this session.
**Return type**
[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")
**Returns**
[`qiskit_ibm_runtime.QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") associated with this session.
</Attribute>
### session\_id
<Attribute id="qiskit_ibm_runtime.Session.session_id">
Return the session ID.
**Return type**
`Optional`\[`str`]
**Returns**
Session ID. None if the backend is a simulator.
</Attribute>
## Methods
### backend
<Function id="qiskit_ibm_runtime.Session.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/session.py#L254-L262" signature="backend()">
Return backend for this session.
**Return type**
`Optional`\[`str`]
**Returns**
Backend for this session. None if unknown.
</Function>
### cancel
<Function id="qiskit_ibm_runtime.Session.cancel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/session.py#L240-L244" signature="cancel()">
Cancel all pending jobs in a session.
**Return type**
`None`
</Function>
### close
<Function id="qiskit_ibm_runtime.Session.close" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/session.py#L246-L252" signature="close()">
Close the session so new jobs will no longer be accepted, but existing queued or running jobs will run to completion. The session will be terminated once there are no more pending jobs.
**Return type**
`None`
</Function>
### details
<Function id="qiskit_ibm_runtime.Session.details" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/session.py#L291-L333" signature="details()">
Return session details.
**Return type**
`Optional`\[`Dict`\[`str`, `Any`]]
**Returns**
A dictionary with the sessions details.
* `id`: id of the session.
* `backend_name`: backend used for the session.
* `interactive_timeout`: The maximum idle time (in seconds) between jobs that is allowed to occur before the session is deactivated.
* `max_time`: Maximum allowed time (in seconds) for the session, subject to plan limits.
* `active_timeout`: The maximum time (in seconds) a session can stay active.
* `state`: State of the session - open, active, inactive, or closed.
* `accepting_jobs`: Whether or not the session is accepting jobs.
* `last_job_started`: Timestamp of when the last job in the session started.
* `last_job_completed`: Timestamp of when the last job in the session completed.
* `started_at`: Timestamp of when the session was started.
* `closed_at`: Timestamp of when the session was closed.
* `activated_at`: Timestamp of when the session state was changed to active.
* `mode`: Execution mode of the session.
* `usage_time`: The usage time, in seconds, of this Session or Batch. Usage is defined as the time a quantum system is committed to complete a job.
</Function>
### from\_id
<Function id="qiskit_ibm_runtime.Session.from_id" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/session.py#L353-L386" signature="from_id(session_id, service)" modifiers="classmethod">
Construct a Session object with a given session\_id
**Parameters**
* **session\_id** (`str`) – the id of the session to be created. This must be an already existing session id.
* **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) –
instance of the `QiskitRuntimeService` class.
**Raises:**
IBMInputValueError: If given session\_id does not exist.
**Return type**
[`Session`](#qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")
**Returns**
A new Session with the given `session_id`
</Function>
### run
<Function id="qiskit_ibm_runtime.Session.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/session.py#L176-L233" signature="run(program_id, inputs, options=None, callback=None, result_decoder=None)">
Run a program in the session.
**Parameters**
* **program\_id** (`str`) – Program ID.
* **inputs** (`Dict`) – Program input parameters. These input values are passed to the runtime program.
* **options** (`Optional`\[`Dict`]) – Runtime options that control the execution environment.
* **callback** (`Optional`\[`Callable`]) – Callback function to be invoked for any interim results and final result.
**Return type**
`Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), [`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.runtime_job_v2.RuntimeJobV2")]
**Returns**
Submitted job.
</Function>
### status
<Function id="qiskit_ibm_runtime.Session.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/session.py#L264-L289" signature="status()">
Return current session status.
**Return type**
`Optional`\[`str`]
**Returns**
Session status as a string.
* `Pending`: Session is created but not active. It will become active when the next job of this session is dequeued.
* `In progress, accepting new jobs`: session is active and accepting new jobs.
* `In progress, not accepting new jobs`: session is active and not accepting new jobs.
* `Closed`: max\_time expired or session was explicitly closed.
* `None`: status details are not available.
</Function>
</Class>

141
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.execution_span.ExecutionSpan.mdx Normal file
View File

@ -0,0 +1,141 @@
---
title: ExecutionSpan
description: API reference for qiskit_ibm_runtime.execution_span.ExecutionSpan
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpan
---
# ExecutionSpan
<Class id="qiskit_ibm_runtime.execution_span.ExecutionSpan" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/execution_span/execution_span.py#L31-L137" signature="ExecutionSpan(start, stop)" modifiers="class">
Abstract parent for classes that store an execution time span for a subset of job data.
A pub is said to have dependence on an execution span if the corresponding execution includes data that forms any part of the pub’s results.
Execution spans are equality checkable, and they implement a comparison operator based on the tuple `(start, stop)`, so can be sorted.
**Parameters**
* **start** (`datetime`) – The start time of the span, in UTC.
* **stop** (`datetime`) – The stop time of the span, in UTC.
## Attributes
### duration
<Attribute id="qiskit_ibm_runtime.execution_span.ExecutionSpan.duration">
The duration of this span, in seconds.
**Return type**
`float`
</Attribute>
### pub\_idxs
<Attribute id="qiskit_ibm_runtime.execution_span.ExecutionSpan.pub_idxs">
Which pubs, by index, have dependence on this execution span.
**Return type**
`list`\[`int`]
</Attribute>
### size
<Attribute id="qiskit_ibm_runtime.execution_span.ExecutionSpan.size">
The total number of results with dependence on this execution span, across all pubs.
This attribute is equivalent to the sum of the elements of all present [`mask()`](#qiskit_ibm_runtime.execution_span.ExecutionSpan.mask "qiskit_ibm_runtime.execution_span.ExecutionSpan.mask")s. For sampler results, it represents the total number of shots with dependence on this execution span.
Combine this attribute with [`filter_by_pub()`](#qiskit_ibm_runtime.execution_span.ExecutionSpan.filter_by_pub "qiskit_ibm_runtime.execution_span.ExecutionSpan.filter_by_pub") to find the size of some particular pub:
```python
span.filter_by_pub(2).size
```
**Return type**
`int`
</Attribute>
### start
<Attribute id="qiskit_ibm_runtime.execution_span.ExecutionSpan.start">
The start time of the span, in UTC.
**Return type**
`datetime`
</Attribute>
### stop
<Attribute id="qiskit_ibm_runtime.execution_span.ExecutionSpan.stop">
The stop time of the span, in UTC.
**Return type**
`datetime`
</Attribute>
## Methods
### contains\_pub
<Function id="qiskit_ibm_runtime.execution_span.ExecutionSpan.contains_pub" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/execution_span/execution_span.py#L112-L122" signature="contains_pub(pub_idx)">
Return whether the pub with the given index has data with dependence on this span.
**Parameters**
**pub\_idx** (*int | Iterable\[int]*) – One or more pub indices from the original primitive call.
**Return type**
bool
**Returns**
Whether there is dependence on this span.
</Function>
### filter\_by\_pub
<Function id="qiskit_ibm_runtime.execution_span.ExecutionSpan.filter_by_pub" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/execution_span/execution_span.py#L124-L137" signature="filter_by_pub(pub_idx)" modifiers="abstract">
Return a new span whose slices are filtered to the provided pub indices.
For example, if this span contains slice information for pubs with indices 1, 3, 4 and `[1, 4]` is provided, then the span returned by this method will contain slice information for only those two indices, but be identical otherwise.
**Parameters**
**pub\_idx** (*int | Iterable\[int]*) – One or more pub indices from the original primitive call.
**Return type**
[ExecutionSpan](#qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan")
**Returns**
A new filtered span.
</Function>
### mask
<Function id="qiskit_ibm_runtime.execution_span.ExecutionSpan.mask" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/execution_span/execution_span.py#L101-L110" signature="mask(pub_idx)" modifiers="abstract">
Return an array-valued mask specifying which parts of a pub result depend on this span.
**Parameters**
**pub\_idx** (`int`) – The index of the pub to return a mask for.
**Return type**
[`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")\[`Any`, [`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[[`bool`](https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.bool "(in NumPy v2.1)")]]
**Returns**
An array with the same shape as the pub data.
</Function>
</Class>

114
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.execution_span.ExecutionSpans.mdx Normal file
View File

@ -0,0 +1,114 @@
---
title: ExecutionSpans
description: API reference for qiskit_ibm_runtime.execution_span.ExecutionSpans
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpans
---
# ExecutionSpans
<Class id="qiskit_ibm_runtime.execution_span.ExecutionSpans" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/execution_span/execution_spans.py#L23-L115" signature="ExecutionSpans(spans)" modifiers="class">
A collection of timings for pub results.
This class is a list-like containing [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan")s, where each execution span represents a time window of data collection, and contains a reference to exactly which of the data were collected during the window.
It is possible for distinct time windows to overlap. This is not because a QPU was performing multiple executions at once, but is instead an artifact of certain classical processing that may happen concurrently with quantum execution. The guarantee being made is that the referenced data definitely occurred in the reported execution span, but not necessarily that the limits of the time window are as tight as possible.
## Attributes
### duration
<Attribute id="qiskit_ibm_runtime.execution_span.ExecutionSpans.duration">
The total duration of this collection, in seconds.
**Return type**
`float`
</Attribute>
### pub\_idxs
<Attribute id="qiskit_ibm_runtime.execution_span.ExecutionSpans.pub_idxs">
Which pubs, by index, have dependence on one or more execution spans present.
**Return type**
`list`\[`int`]
</Attribute>
### start
<Attribute id="qiskit_ibm_runtime.execution_span.ExecutionSpans.start">
The start time of the entire collection, in UTC.
**Return type**
`datetime`
</Attribute>
### stop
<Attribute id="qiskit_ibm_runtime.execution_span.ExecutionSpans.stop">
The stop time of the entire collection, in UTC.
**Return type**
`datetime`
</Attribute>
## Methods
### \_\_getitem\_\_
<Function id="qiskit_ibm_runtime.execution_span.ExecutionSpans.__getitem__" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/execution_span/execution_spans.py#L56-L61" signature="__getitem__(idxs: int) → ExecutionSpan" extraSignatures={["__getitem__(idxs: slice | list[int]) → ExecutionSpans"]}>
**Return type**
[ExecutionSpan](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") | ‘ExecutionSpans
</Function>
### \_\_len\_\_
<Function id="qiskit_ibm_runtime.execution_span.ExecutionSpans.__len__" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/execution_span/execution_spans.py#L47-L48" signature="__len__()">
**Return type**
`int`
</Function>
### filter\_by\_pub
<Function id="qiskit_ibm_runtime.execution_span.ExecutionSpans.filter_by_pub" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/execution_span/execution_spans.py#L92-L100" signature="filter_by_pub(pub_idx)">
Return a new set of spans where each one has been filtered to the specified pubs.
See also :meth:\~.ExecutionSpan.filter\_by\_pub\`.
**Parameters**
**pub\_idx** (*int | Iterable\[int]*) – One or more pub indices to filter.
**Return type**
[ExecutionSpans](#qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans")
</Function>
### sort
<Function id="qiskit_ibm_runtime.execution_span.ExecutionSpans.sort" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/execution_span/execution_spans.py#L102-L115" signature="sort(inplace=True)">
Return the same execution spans, sorted.
Sorting is done by the [`start`](qiskit_ibm_runtime.execution_span.ExecutionSpan#start "qiskit_ibm_runtime.execution_span.ExecutionSpan.start") timestamp of each execution span.
**Parameters**
**inplace** (`bool`) – Whether to sort this instance in place, or return a copy.
**Return type**
[`ExecutionSpans`](#qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.execution_spans.ExecutionSpans")
**Returns**
This instance if `inplace`, a new instance otherwise, sorted.
</Function>
</Class>

14
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.execution_span.ShapeType.mdx Normal file
View File

@ -0,0 +1,14 @@
---
title: ShapeType
description: API reference for qiskit_ibm_runtime.execution_span.ShapeType
in_page_toc_min_heading_level: 1
python_api_type: data
python_api_name: qiskit_ibm_runtime.execution_span.ShapeType
---
# ShapeType
<Attribute id="qiskit_ibm_runtime.execution_span.ShapeType" isDedicatedPage={true}>
alias of `Tuple`\[`int`, …]
</Attribute>

128
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.execution_span.SliceSpan.mdx Normal file
View File

@ -0,0 +1,128 @@
---
title: SliceSpan
description: API reference for qiskit_ibm_runtime.execution_span.SliceSpan
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.execution_span.SliceSpan
---
# SliceSpan
<Class id="qiskit_ibm_runtime.execution_span.SliceSpan" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/execution_span/slice_span.py#L27-L74" signature="SliceSpan(start, stop, data_slices)" modifiers="class">
An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format.
This type of execution span references pub result data by assuming that it is a sliceable portion of the (row major) flattened data. Therefore, for each pub dependent on this span, the constructor accepts a single `slice` object, along with the corresponding shape of the data to be sliced.
**Parameters**
* **start** (`datetime`) – The start time of the span, in UTC.
* **stop** (`datetime`) – The stop time of the span, in UTC.
* **data\_slices** (`dict`\[`int`, `tuple`\[`Tuple`\[`int`, `...`], `slice`]]) – A map from pub indices to pairs `(shape_tuple, slice)`.
## Attributes
### duration
<Attribute id="qiskit_ibm_runtime.execution_span.SliceSpan.duration">
The duration of this span, in seconds.
**Return type**
`float`
</Attribute>
### pub\_idxs
<Attribute id="qiskit_ibm_runtime.execution_span.SliceSpan.pub_idxs">
**Return type**
`list`\[`int`]
</Attribute>
### size
<Attribute id="qiskit_ibm_runtime.execution_span.SliceSpan.size">
**Return type**
`int`
</Attribute>
### start
<Attribute id="qiskit_ibm_runtime.execution_span.SliceSpan.start">
The start time of the span, in UTC.
**Return type**
`datetime`
</Attribute>
### stop
<Attribute id="qiskit_ibm_runtime.execution_span.SliceSpan.stop">
The stop time of the span, in UTC.
**Return type**
`datetime`
</Attribute>
## Methods
### contains\_pub
<Function id="qiskit_ibm_runtime.execution_span.SliceSpan.contains_pub" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/execution_span/execution_span.py#L112-L122" signature="contains_pub(pub_idx)">
Return whether the pub with the given index has data with dependence on this span.
**Parameters**
**pub\_idx** (*int | Iterable\[int]*) – One or more pub indices from the original primitive call.
**Return type**
bool
**Returns**
Whether there is dependence on this span.
</Function>
### filter\_by\_pub
<Function id="qiskit_ibm_runtime.execution_span.SliceSpan.filter_by_pub" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/execution_span/slice_span.py#L71-L74" signature="filter_by_pub(pub_idx)">
Return a new span whose slices are filtered to the provided pub indices.
For example, if this span contains slice information for pubs with indices 1, 3, 4 and `[1, 4]` is provided, then the span returned by this method will contain slice information for only those two indices, but be identical otherwise.
**Parameters**
**pub\_idx** (*int | Iterable\[int]*) – One or more pub indices from the original primitive call.
**Return type**
[SliceSpan](#qiskit_ibm_runtime.execution_span.SliceSpan "qiskit_ibm_runtime.execution_span.SliceSpan")
**Returns**
A new filtered span.
</Function>
### mask
<Function id="qiskit_ibm_runtime.execution_span.SliceSpan.mask" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/execution_span/slice_span.py#L65-L69" signature="mask(pub_idx)">
Return an array-valued mask specifying which parts of a pub result depend on this span.
**Parameters**
**pub\_idx** (`int`) – The index of the pub to return a mask for.
**Return type**
[`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")\[`Any`, [`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[[`bool`](https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.bool "(in NumPy v2.1)")]]
**Returns**
An array with the same shape as the pub data.
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeAlgiers
description: API reference for qiskit_ibm_runtime.fake_provider.FakeAlgiers
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
---
# FakeAlgiers
<Class id="qiskit_ibm_runtime.fake_provider.FakeAlgiers" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/algiers/fake_algiers.py#L21-L28" signature="FakeAlgiers" modifiers="class">
A fake 27 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.backend_name" attributeValue="'fake_algiers'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.conf_filename" attributeValue="'conf_algiers.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.defs_filename" attributeValue="'defs_algiers.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/algiers'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.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.FakeAlgiers.run "qiskit_ibm_runtime.fake_provider.FakeAlgiers.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.props_filename" attributeValue="'props_algiers.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.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.FakeAlgiers.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

151
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx Normal file
View File

@ -0,0 +1,151 @@
---
title: FakeAlmaden
description: API reference for qiskit_ibm_runtime.fake_provider.FakeAlmaden
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.29/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py#L41-L58" signature="FakeAlmaden" modifiers="class">
A fake Almaden backend.
```python
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" 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.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" 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.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>

464
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx Normal file
View File

@ -0,0 +1,464 @@
---
title: FakeAlmadenV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
---
# FakeAlmadenV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py#L21-L38" signature="FakeAlmadenV2" modifiers="class">
A fake Almaden V2 backend.
```python
00 ↔ 01 ↔ 02 ↔ 03 ↔ 04
↕ ↕
05 ↔ 06 ↔ 07 ↔ 08 ↔ 09
↕ ↕ ↕
10 ↔ 11 ↔ 12 ↔ 13 ↔ 14
↕ ↕
15 ↔ 16 ↔ 17 ↔ 18 ↔ 19
```
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.backend_name" attributeValue="'fake_almaden'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.conf_filename" attributeValue="'conf_almaden.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.defs_filename" attributeValue="None" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/almaden'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.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.FakeAlmadenV2.run "qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.props_filename" attributeValue="'props_almaden.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.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.FakeAlmadenV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

159
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx Normal file
View File

@ -0,0 +1,159 @@
---
title: FakeArmonk
description: API reference for qiskit_ibm_runtime.fake_provider.FakeArmonk
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk
---
# FakeArmonk
<Class id="qiskit_ibm_runtime.fake_provider.FakeArmonk" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py#L36-L48" signature="FakeArmonk" modifiers="class">
A fake 1 qubit backend.
```python
0
```
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.FakeArmonk.backend_name" attributeValue="'fake_armonk'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonk.conf_filename" attributeValue="'conf_armonk.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonk.defs_filename" attributeValue="'defs_armonk.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonk.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/armonk'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonk.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.FakeArmonk.run "qiskit_ibm_runtime.fake_provider.FakeArmonk.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonk.props_filename" attributeValue="'props_armonk.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonk.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeArmonk.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeArmonk.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeArmonk.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.FakeArmonk.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.FakeArmonk.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.FakeArmonk.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.FakeArmonk.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.FakeArmonk.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

458
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx Normal file
View File

@ -0,0 +1,458 @@
---
title: FakeArmonkV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeArmonkV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
---
# FakeArmonkV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py#L21-L33" signature="FakeArmonkV2" modifiers="class">
A fake 1 qubit backend.
```python
0
```
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.backend_name" attributeValue="'fake_armonk'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.conf_filename" attributeValue="'conf_armonk.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.defs_filename" attributeValue="'defs_armonk.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/armonk'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.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.FakeArmonkV2.run "qiskit_ibm_runtime.fake_provider.FakeArmonkV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.props_filename" attributeValue="'props_armonk.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.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.FakeArmonkV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeAthens
description: API reference for qiskit_ibm_runtime.fake_provider.FakeAthens
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens
---
# FakeAthens
<Class id="qiskit_ibm_runtime.fake_provider.FakeAthens" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py#L31-L38" signature="FakeAthens" modifiers="class">
A fake 5 qubit backend.
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.FakeAthens.backend_name" attributeValue="'fake_athens'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthens.conf_filename" attributeValue="'conf_athens.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthens.defs_filename" attributeValue="'defs_athens.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthens.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/athens'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthens.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.FakeAthens.run "qiskit_ibm_runtime.fake_provider.FakeAthens.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthens.props_filename" attributeValue="'props_athens.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthens.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeAthens.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeAthens.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeAthens.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.FakeAthens.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.FakeAthens.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.FakeAthens.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.FakeAthens.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.FakeAthens.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeAthensV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeAthensV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
---
# FakeAthensV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeAthensV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py#L21-L28" signature="FakeAthensV2" modifiers="class">
A fake 5 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.backend_name" attributeValue="'fake_athens'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.conf_filename" attributeValue="'conf_athens.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.defs_filename" attributeValue="'defs_athens.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/athens'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.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.FakeAthensV2.run "qiskit_ibm_runtime.fake_provider.FakeAthensV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.props_filename" attributeValue="'props_athens.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.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.FakeAthensV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeAuckland
description: API reference for qiskit_ibm_runtime.fake_provider.FakeAuckland
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
---
# FakeAuckland
<Class id="qiskit_ibm_runtime.fake_provider.FakeAuckland" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/auckland/fake_auckland.py#L22-L29" signature="FakeAuckland" modifiers="class">
A fake 27 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.backend_name" attributeValue="'fake_auckland'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.conf_filename" attributeValue="'conf_auckland.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.defs_filename" attributeValue="'defs_auckland.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/auckland'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.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.FakeAuckland.run "qiskit_ibm_runtime.fake_provider.FakeAuckland.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.props_filename" attributeValue="'props_auckland.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeAuckland.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeAuckland.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeAuckland.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeAuckland.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeAuckland.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeAuckland.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeAuckland.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeAuckland.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeAuckland.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeAuckland.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeAuckland.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeAuckland.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.FakeAuckland.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeBelem
description: API reference for qiskit_ibm_runtime.fake_provider.FakeBelem
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem
---
# FakeBelem
<Class id="qiskit_ibm_runtime.fake_provider.FakeBelem" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py#L31-L38" signature="FakeBelem" modifiers="class">
A fake 5 qubit backend.
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.FakeBelem.backend_name" attributeValue="'fake_belem'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelem.conf_filename" attributeValue="'conf_belem.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelem.defs_filename" attributeValue="'defs_belem.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelem.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/belem'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelem.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.FakeBelem.run "qiskit_ibm_runtime.fake_provider.FakeBelem.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelem.props_filename" attributeValue="'props_belem.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelem.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeBelem.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeBelem.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeBelem.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.FakeBelem.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.FakeBelem.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.FakeBelem.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.FakeBelem.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.FakeBelem.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeBelemV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeBelemV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
---
# FakeBelemV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeBelemV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py#L21-L28" signature="FakeBelemV2" modifiers="class">
A fake 5 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.backend_name" attributeValue="'fake_belem'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.conf_filename" attributeValue="'conf_belem.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.defs_filename" attributeValue="'defs_belem.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/belem'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.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.FakeBelemV2.run "qiskit_ibm_runtime.fake_provider.FakeBelemV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.props_filename" attributeValue="'props_belem.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.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.FakeBelemV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

165
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx Normal file
View File

@ -0,0 +1,165 @@
---
title: FakeBoeblingen
description: API reference for qiskit_ibm_runtime.fake_provider.FakeBoeblingen
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen
---
# FakeBoeblingen
<Class id="qiskit_ibm_runtime.fake_provider.FakeBoeblingen" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py#L42-L60" signature="FakeBoeblingen" modifiers="class">
A fake Boeblingen backend.
```python
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.FakeBoeblingen.backend_name" attributeValue="'fake_boeblingen'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingen.conf_filename" attributeValue="'conf_boeblingen.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingen.defs_filename" attributeValue="'defs_boeblingen.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingen.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/boeblingen'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingen.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.FakeBoeblingen.run "qiskit_ibm_runtime.fake_provider.FakeBoeblingen.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingen.props_filename" attributeValue="'props_boeblingen.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingen.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeBoeblingen.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeBoeblingen.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeBoeblingen.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.FakeBoeblingen.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.FakeBoeblingen.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.FakeBoeblingen.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.FakeBoeblingen.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.FakeBoeblingen.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

464
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx Normal file
View File

@ -0,0 +1,464 @@
---
title: FakeBoeblingenV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
---
# FakeBoeblingenV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py#L21-L39" signature="FakeBoeblingenV2" modifiers="class">
A fake Boeblingen V2 backend.
```python
00 ↔ 01 ↔ 02 ↔ 03 ↔ 04
↕ ↕
05 ↔ 06 ↔ 07 ↔ 08 ↔ 09
↕ ↕ ↕
10 ↔ 11 ↔ 12 ↔ 13 ↔ 14
↕ ↕
15 ↔ 16 ↔ 17 ↔ 18 ↔ 19
```
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.backend_name" attributeValue="'fake_boeblingen'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.conf_filename" attributeValue="'conf_boeblingen.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.defs_filename" attributeValue="'defs_boeblingen.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/boeblingen'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.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.FakeBoeblingenV2.run "qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.props_filename" attributeValue="'props_boeblingen.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.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.FakeBoeblingenV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeBogota
description: API reference for qiskit_ibm_runtime.fake_provider.FakeBogota
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota
---
# FakeBogota
<Class id="qiskit_ibm_runtime.fake_provider.FakeBogota" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py#L31-L38" signature="FakeBogota" modifiers="class">
A fake 5 qubit backend.
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.FakeBogota.backend_name" attributeValue="'fake_bogota'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogota.conf_filename" attributeValue="'conf_bogota.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogota.defs_filename" attributeValue="'defs_bogota.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogota.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/bogota'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogota.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.FakeBogota.run "qiskit_ibm_runtime.fake_provider.FakeBogota.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogota.props_filename" attributeValue="'props_bogota.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogota.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeBogota.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeBogota.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeBogota.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.FakeBogota.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.FakeBogota.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.FakeBogota.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.FakeBogota.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.FakeBogota.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeBogotaV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeBogotaV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
---
# FakeBogotaV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py#L21-L28" signature="FakeBogotaV2" modifiers="class">
A fake 5 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.backend_name" attributeValue="'fake_bogota'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.conf_filename" attributeValue="'conf_bogota.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.defs_filename" attributeValue="'defs_bogota.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/bogota'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.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.FakeBogotaV2.run "qiskit_ibm_runtime.fake_provider.FakeBogotaV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.props_filename" attributeValue="'props_bogota.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.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.FakeBogotaV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeBrisbane
description: API reference for qiskit_ibm_runtime.fake_provider.FakeBrisbane
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
---
# FakeBrisbane
<Class id="qiskit_ibm_runtime.fake_provider.FakeBrisbane" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/brisbane/fake_brisbane.py#L21-L28" signature="FakeBrisbane" modifiers="class">
A fake 127 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.backend_name" attributeValue="'fake_brisbane'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.conf_filename" attributeValue="'conf_brisbane.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.defs_filename" attributeValue="'defs_brisbane.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/brisbane'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.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.FakeBrisbane.run "qiskit_ibm_runtime.fake_provider.FakeBrisbane.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.props_filename" attributeValue="'props_brisbane.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.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.FakeBrisbane.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeBrooklyn
description: API reference for qiskit_ibm_runtime.fake_provider.FakeBrooklyn
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn
---
# FakeBrooklyn
<Class id="qiskit_ibm_runtime.fake_provider.FakeBrooklyn" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py#L31-L38" signature="FakeBrooklyn" modifiers="class">
A fake Brooklyn backend.
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.FakeBrooklyn.backend_name" attributeValue="'fake_brooklyn'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklyn.conf_filename" attributeValue="'conf_brooklyn.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklyn.defs_filename" attributeValue="'defs_brooklyn.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklyn.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/brooklyn'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklyn.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.FakeBrooklyn.run "qiskit_ibm_runtime.fake_provider.FakeBrooklyn.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklyn.props_filename" attributeValue="'props_brooklyn.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklyn.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrooklyn.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrooklyn.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrooklyn.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.FakeBrooklyn.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.FakeBrooklyn.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.FakeBrooklyn.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.FakeBrooklyn.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.FakeBrooklyn.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeBrooklynV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
---
# FakeBrooklynV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py#L21-L28" signature="FakeBrooklynV2" modifiers="class">
A fake Brooklyn V2 backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.backend_name" attributeValue="'fake_brooklyn'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.conf_filename" attributeValue="'conf_brooklyn.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.defs_filename" attributeValue="'defs_brooklyn.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/brooklyn'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.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.FakeBrooklynV2.run "qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.props_filename" attributeValue="'props_brooklyn.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.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.FakeBrooklynV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

147
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx Normal file
View File

@ -0,0 +1,147 @@
---
title: FakeBurlington
description: API reference for qiskit_ibm_runtime.fake_provider.FakeBurlington
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington
---
# FakeBurlington
<Class id="qiskit_ibm_runtime.fake_provider.FakeBurlington" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py#L37-L50" signature="FakeBurlington" modifiers="class">
A fake 5 qubit backend.
```python
0 ↔ 1 ↔ 3 ↔ 4
↕
2
```
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.FakeBurlington.backend_name" attributeValue="'fake_burlington'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlington.conf_filename" attributeValue="'conf_burlington.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlington.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/burlington'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlington.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.FakeBurlington.run "qiskit_ibm_runtime.fake_provider.FakeBurlington.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlington.props_filename" attributeValue="'props_burlington.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlington.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeBurlington.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.FakeBurlington.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.FakeBurlington.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.FakeBurlington.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.FakeBurlington.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.FakeBurlington.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.FakeBurlington.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

460
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx Normal file
View File

@ -0,0 +1,460 @@
---
title: FakeBurlingtonV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
---
# FakeBurlingtonV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py#L21-L34" signature="FakeBurlingtonV2" modifiers="class">
A fake 5 qubit backend.
```python
0 ↔ 1 ↔ 3 ↔ 4
↕
2
```
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.backend_name" attributeValue="'fake_burlington'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.conf_filename" attributeValue="'conf_burlington.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.defs_filename" attributeValue="None" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/burlington'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.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.FakeBurlingtonV2.run "qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.props_filename" attributeValue="'props_burlington.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.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.FakeBurlingtonV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeCairo
description: API reference for qiskit_ibm_runtime.fake_provider.FakeCairo
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo
---
# FakeCairo
<Class id="qiskit_ibm_runtime.fake_provider.FakeCairo" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py#L31-L38" signature="FakeCairo" modifiers="class">
A fake 27 qubit backend.
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.FakeCairo.backend_name" attributeValue="'fake_cairo'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairo.conf_filename" attributeValue="'conf_cairo.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairo.defs_filename" attributeValue="'defs_cairo.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairo.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/cairo'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairo.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.FakeCairo.run "qiskit_ibm_runtime.fake_provider.FakeCairo.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairo.props_filename" attributeValue="'props_cairo.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairo.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeCairo.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeCairo.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeCairo.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.FakeCairo.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.FakeCairo.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.FakeCairo.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.FakeCairo.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.FakeCairo.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeCairoV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeCairoV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
---
# FakeCairoV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeCairoV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py#L21-L28" signature="FakeCairoV2" modifiers="class">
A fake 27 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.backend_name" attributeValue="'fake_cairo'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.conf_filename" attributeValue="'conf_cairo.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.defs_filename" attributeValue="'defs_cairo.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/cairo'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.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.FakeCairoV2.run "qiskit_ibm_runtime.fake_provider.FakeCairoV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.props_filename" attributeValue="'props_cairo.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.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.FakeCairoV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

153
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx Normal file
View File

@ -0,0 +1,153 @@
---
title: FakeCambridge
description: API reference for qiskit_ibm_runtime.fake_provider.FakeCambridge
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge
---
# FakeCambridge
<Class id="qiskit_ibm_runtime.fake_provider.FakeCambridge" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py#L43-L62" signature="FakeCambridge" modifiers="class">
A fake Cambridge backend.
```python
00 ↔ 01 ↔ 02 ↔ 03 ↔ 04
↕ ↕
05 06
↕ ↕
07 ↔ 08 ↔ 09 ↔ 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 ↔ 15
↕ ↕ ↕
16 17 18
↕ ↕ ↕
19 ↔ 20 ↔ 21 ↔ 22 ↔ 23 ↔ 24 ↔ 25 ↔ 26 ↔ 27
```
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.FakeCambridge.backend_name" attributeValue="'fake_cambridge'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridge.conf_filename" attributeValue="'conf_cambridge.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridge.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/cambridge'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridge.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.FakeCambridge.run "qiskit_ibm_runtime.fake_provider.FakeCambridge.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridge.props_filename" attributeValue="'props_cambridge.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridge.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeCambridge.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.FakeCambridge.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.FakeCambridge.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.FakeCambridge.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.FakeCambridge.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.FakeCambridge.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.FakeCambridge.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

466
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx Normal file
View File

@ -0,0 +1,466 @@
---
title: FakeCambridgeV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
---
# FakeCambridgeV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py#L21-L40" signature="FakeCambridgeV2" modifiers="class">
A fake Cambridge backend.
```python
00 ↔ 01 ↔ 02 ↔ 03 ↔ 04
↕ ↕
05 06
↕ ↕
07 ↔ 08 ↔ 09 ↔ 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 ↔ 15
↕ ↕ ↕
16 17 18
↕ ↕ ↕
19 ↔ 20 ↔ 21 ↔ 22 ↔ 23 ↔ 24 ↔ 25 ↔ 26 ↔ 27
```
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.backend_name" attributeValue="'fake_cambridge'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.conf_filename" attributeValue="'conf_cambridge.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.defs_filename" attributeValue="None" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/cambridge'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.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.FakeCambridgeV2.run "qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.props_filename" attributeValue="'props_cambridge.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.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.FakeCambridgeV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeCasablanca
description: API reference for qiskit_ibm_runtime.fake_provider.FakeCasablanca
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca
---
# FakeCasablanca
<Class id="qiskit_ibm_runtime.fake_provider.FakeCasablanca" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py#L31-L38" signature="FakeCasablanca" modifiers="class">
A fake 7 qubit backend.
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.FakeCasablanca.backend_name" attributeValue="'fake_casablanca'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablanca.conf_filename" attributeValue="'conf_casablanca.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablanca.defs_filename" attributeValue="'defs_casablanca.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablanca.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/casablanca'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablanca.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.FakeCasablanca.run "qiskit_ibm_runtime.fake_provider.FakeCasablanca.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablanca.props_filename" attributeValue="'props_casablanca.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablanca.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeCasablanca.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeCasablanca.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeCasablanca.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.FakeCasablanca.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.FakeCasablanca.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.FakeCasablanca.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.FakeCasablanca.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.FakeCasablanca.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeCasablancaV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
---
# FakeCasablancaV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py#L21-L28" signature="FakeCasablancaV2" modifiers="class">
A fake 7 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.backend_name" attributeValue="'fake_casablanca'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.conf_filename" attributeValue="'conf_casablanca.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.defs_filename" attributeValue="'defs_casablanca.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/casablanca'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.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.FakeCasablancaV2.run "qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.props_filename" attributeValue="'props_casablanca.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.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.FakeCasablancaV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeCusco
description: API reference for qiskit_ibm_runtime.fake_provider.FakeCusco
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
---
# FakeCusco
<Class id="qiskit_ibm_runtime.fake_provider.FakeCusco" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/cusco/fake_cusco.py#L21-L28" signature="FakeCusco" modifiers="class">
A fake 127 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.backend_name" attributeValue="'fake_cusco'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.conf_filename" attributeValue="'conf_cusco.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.defs_filename" attributeValue="'defs_cusco.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/cusco'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.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.FakeCusco.run "qiskit_ibm_runtime.fake_provider.FakeCusco.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.props_filename" attributeValue="'props_cusco.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeCusco.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeCusco.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeCusco.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeCusco.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeCusco.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeCusco.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeCusco.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeCusco.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeCusco.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeCusco.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeCusco.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeCusco.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.FakeCusco.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

149
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx Normal file
View File

@ -0,0 +1,149 @@
---
title: FakeEssex
description: API reference for qiskit_ibm_runtime.fake_provider.FakeEssex
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.
```python
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>

462
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx Normal file
View File

@ -0,0 +1,462 @@
---
title: FakeEssexV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeEssexV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
---
# FakeEssexV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeEssexV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py#L21-L36" signature="FakeEssexV2" modifiers="class">
A fake 5 qubit backend.
```python
0 ↔ 1 ↔ 2
↕
3
↕
4
```
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.backend_name" attributeValue="'fake_essex'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.conf_filename" attributeValue="'conf_essex.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.defs_filename" attributeValue="None" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/essex'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.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.FakeEssexV2.run "qiskit_ibm_runtime.fake_provider.FakeEssexV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.props_filename" attributeValue="'props_essex.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.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.FakeEssexV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

461
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx Normal file
View File

@ -0,0 +1,461 @@
---
title: FakeFractionalBackend
description: API reference for qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
---
# FakeFractionalBackend
<Class id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/fractional/fake_fractional.py#L21-L36" signature="FakeFractionalBackend" modifiers="class">
A fake 5 qubit backend with dynamic and fractional feature modeled based on FakeLima.
This backend include following features.
* Fractional gates (rx, rzx) in addition to the standard basis gates.
* Control flow operations (if\_else, while\_loop).
* Pulse calibrations (fractional gates don’t support calibration).
* Gate properties of all instructions.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.backend_name" attributeValue="'fake_fractional'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.conf_filename" attributeValue="'conf_fractional.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.defs_filename" attributeValue="'defs_fractional.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/fractional'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.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.FakeFractionalBackend.run "qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.props_filename" attributeValue="'props_fractional.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.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.FakeFractionalBackend.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeGeneva
description: API reference for qiskit_ibm_runtime.fake_provider.FakeGeneva
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
---
# FakeGeneva
<Class id="qiskit_ibm_runtime.fake_provider.FakeGeneva" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/geneva/fake_geneva.py#L22-L29" signature="FakeGeneva" modifiers="class">
A fake 27 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.backend_name" attributeValue="'fake_geneva'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.conf_filename" attributeValue="'conf_geneva.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.defs_filename" attributeValue="'defs_geneva.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/geneva'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.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.FakeGeneva.run "qiskit_ibm_runtime.fake_provider.FakeGeneva.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.props_filename" attributeValue="'props_geneva.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeGeneva.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeGeneva.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeGeneva.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeGeneva.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeGeneva.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeGeneva.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeGeneva.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeGeneva.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeGeneva.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeGeneva.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeGeneva.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeGeneva.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.FakeGeneva.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeGuadalupe
description: API reference for qiskit_ibm_runtime.fake_provider.FakeGuadalupe
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe
---
# FakeGuadalupe
<Class id="qiskit_ibm_runtime.fake_provider.FakeGuadalupe" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py#L32-L39" signature="FakeGuadalupe" modifiers="class">
A fake 16 qubit backend.
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.FakeGuadalupe.backend_name" attributeValue="'fake_guadalupe'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupe.conf_filename" attributeValue="'conf_guadalupe.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupe.defs_filename" attributeValue="'defs_guadalupe.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupe.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/guadalupe'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupe.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.FakeGuadalupe.run "qiskit_ibm_runtime.fake_provider.FakeGuadalupe.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupe.props_filename" attributeValue="'props_guadalupe.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupe.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeGuadalupe.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeGuadalupe.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeGuadalupe.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.FakeGuadalupe.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.FakeGuadalupe.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.FakeGuadalupe.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.FakeGuadalupe.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.FakeGuadalupe.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeGuadalupeV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
---
# FakeGuadalupeV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py#L22-L29" signature="FakeGuadalupeV2" modifiers="class">
A fake 16 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.backend_name" attributeValue="'fake_guadalupe'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.conf_filename" attributeValue="'conf_guadalupe.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.defs_filename" attributeValue="'defs_guadalupe.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/guadalupe'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.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.FakeGuadalupeV2.run "qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.props_filename" attributeValue="'props_guadalupe.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.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.FakeGuadalupeV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeHanoi
description: API reference for qiskit_ibm_runtime.fake_provider.FakeHanoi
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi
---
# FakeHanoi
<Class id="qiskit_ibm_runtime.fake_provider.FakeHanoi" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py#L31-L38" signature="FakeHanoi" modifiers="class">
A fake 27 qubit backend.
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.FakeHanoi.backend_name" attributeValue="'fake_hanoi'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoi.conf_filename" attributeValue="'conf_hanoi.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoi.defs_filename" attributeValue="'defs_hanoi.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoi.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/hanoi'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoi.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.FakeHanoi.run "qiskit_ibm_runtime.fake_provider.FakeHanoi.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoi.props_filename" attributeValue="'props_hanoi.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoi.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeHanoi.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeHanoi.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeHanoi.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.FakeHanoi.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.FakeHanoi.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.FakeHanoi.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.FakeHanoi.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.FakeHanoi.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeHanoiV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeHanoiV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
---
# FakeHanoiV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py#L21-L28" signature="FakeHanoiV2" modifiers="class">
A fake 27 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.backend_name" attributeValue="'fake_hanoi'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.conf_filename" attributeValue="'conf_hanoi.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.defs_filename" attributeValue="'defs_hanoi.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/hanoi'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.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.FakeHanoiV2.run "qiskit_ibm_runtime.fake_provider.FakeHanoiV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.props_filename" attributeValue="'props_hanoi.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.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.FakeHanoiV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeJakarta
description: API reference for qiskit_ibm_runtime.fake_provider.FakeJakarta
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta
---
# FakeJakarta
<Class id="qiskit_ibm_runtime.fake_provider.FakeJakarta" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py#L31-L38" signature="FakeJakarta" modifiers="class">
A fake 7 qubit backend.
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.FakeJakarta.backend_name" attributeValue="'fake_jakarta'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakarta.conf_filename" attributeValue="'conf_jakarta.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakarta.defs_filename" attributeValue="'defs_jakarta.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakarta.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/jakarta'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakarta.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.FakeJakarta.run "qiskit_ibm_runtime.fake_provider.FakeJakarta.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakarta.props_filename" attributeValue="'props_jakarta.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakarta.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeJakarta.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeJakarta.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeJakarta.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.FakeJakarta.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.FakeJakarta.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.FakeJakarta.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.FakeJakarta.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.FakeJakarta.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeJakartaV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeJakartaV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
---
# FakeJakartaV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py#L21-L28" signature="FakeJakartaV2" modifiers="class">
A fake 7 qubit V2 backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.backend_name" attributeValue="'fake_jakarta'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.conf_filename" attributeValue="'conf_jakarta.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.defs_filename" attributeValue="'defs_jakarta.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/jakarta'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.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.FakeJakartaV2.run "qiskit_ibm_runtime.fake_provider.FakeJakartaV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.props_filename" attributeValue="'props_jakarta.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.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.FakeJakartaV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

151
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx Normal file
View File

@ -0,0 +1,151 @@
---
title: FakeJohannesburg
description: API reference for qiskit_ibm_runtime.fake_provider.FakeJohannesburg
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg
---
# FakeJohannesburg
<Class id="qiskit_ibm_runtime.fake_provider.FakeJohannesburg" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py#L41-L58" signature="FakeJohannesburg" modifiers="class">
A fake Johannesburg backend.
```python
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.FakeJohannesburg.backend_name" attributeValue="'fake_johannesburg'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburg.conf_filename" attributeValue="'conf_johannesburg.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburg.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/johannesburg'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburg.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.FakeJohannesburg.run "qiskit_ibm_runtime.fake_provider.FakeJohannesburg.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburg.props_filename" attributeValue="'props_johannesburg.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburg.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeJohannesburg.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.FakeJohannesburg.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.FakeJohannesburg.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.FakeJohannesburg.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.FakeJohannesburg.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.FakeJohannesburg.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.FakeJohannesburg.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

464
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx Normal file
View File

@ -0,0 +1,464 @@
---
title: FakeJohannesburgV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
---
# FakeJohannesburgV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py#L21-L38" signature="FakeJohannesburgV2" modifiers="class">
A fake Johannesburg V2 backend.
```python
00 ↔ 01 ↔ 02 ↔ 03 ↔ 04
↕ ↕
05 ↔ 06 ↔ 07 ↔ 08 ↔ 09
↕ ↕ ↕
10 ↔ 11 ↔ 12 ↔ 13 ↔ 14
↕ ↕
15 ↔ 16 ↔ 17 ↔ 18 ↔ 19
```
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.backend_name" attributeValue="'fake_johannesburg'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.conf_filename" attributeValue="'conf_johannesburg.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.defs_filename" attributeValue="None" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/johannesburg'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.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.FakeJohannesburgV2.run "qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.props_filename" attributeValue="'props_johannesburg.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.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.FakeJohannesburgV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeKawasaki
description: API reference for qiskit_ibm_runtime.fake_provider.FakeKawasaki
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
---
# FakeKawasaki
<Class id="qiskit_ibm_runtime.fake_provider.FakeKawasaki" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/kawasaki/fake_kawasaki.py#L21-L28" signature="FakeKawasaki" modifiers="class">
A fake 127 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.backend_name" attributeValue="'fake_kawasaki'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.conf_filename" attributeValue="'conf_kawasaki.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.defs_filename" attributeValue="'defs_kawasaki.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/kawasaki'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.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.FakeKawasaki.run "qiskit_ibm_runtime.fake_provider.FakeKawasaki.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.props_filename" attributeValue="'props_kawasaki.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.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.FakeKawasaki.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeKolkata
description: API reference for qiskit_ibm_runtime.fake_provider.FakeKolkata
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata
---
# FakeKolkata
<Class id="qiskit_ibm_runtime.fake_provider.FakeKolkata" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py#L31-L38" signature="FakeKolkata" modifiers="class">
A fake 27 qubit backend.
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.FakeKolkata.backend_name" attributeValue="'fake_kolkata'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkata.conf_filename" attributeValue="'conf_kolkata.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkata.defs_filename" attributeValue="'defs_kolkata.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkata.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/kolkata'" />
### options
<Attribute id="qiskit_ibm_runtime.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_ibm_runtime.fake_provider.FakeKolkata.run "qiskit_ibm_runtime.fake_provider.FakeKolkata.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkata.props_filename" attributeValue="'props_kolkata.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkata.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeKolkata.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeKolkata.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeKolkata.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.FakeKolkata.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.FakeKolkata.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.FakeKolkata.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.FakeKolkata.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.FakeKolkata.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeKolkataV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeKolkataV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
---
# FakeKolkataV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py#L21-L28" signature="FakeKolkataV2" modifiers="class">
A fake 27 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.backend_name" attributeValue="'fake_kolkata'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.conf_filename" attributeValue="'conf_kolkata.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.defs_filename" attributeValue="'defs_kolkata.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/kolkata'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.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.FakeKolkataV2.run "qiskit_ibm_runtime.fake_provider.FakeKolkataV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.props_filename" attributeValue="'props_kolkata.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.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.FakeKolkataV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeKyiv
description: API reference for qiskit_ibm_runtime.fake_provider.FakeKyiv
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
---
# FakeKyiv
<Class id="qiskit_ibm_runtime.fake_provider.FakeKyiv" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/kyiv/fake_kyiv.py#L21-L28" signature="FakeKyiv" modifiers="class">
A fake 127 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.backend_name" attributeValue="'fake_kyiv'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.conf_filename" attributeValue="'conf_kyiv.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.defs_filename" attributeValue="'defs_kyiv.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/kyiv'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.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.FakeKyiv.run "qiskit_ibm_runtime.fake_provider.FakeKyiv.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.props_filename" attributeValue="'props_kyiv.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyiv.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyiv.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyiv.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyiv.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyiv.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyiv.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyiv.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyiv.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyiv.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyiv.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyiv.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyiv.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.FakeKyiv.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeKyoto
description: API reference for qiskit_ibm_runtime.fake_provider.FakeKyoto
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
---
# FakeKyoto
<Class id="qiskit_ibm_runtime.fake_provider.FakeKyoto" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/kyoto/fake_kyoto.py#L21-L28" signature="FakeKyoto" modifiers="class">
A fake 127 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.backend_name" attributeValue="'fake_kyoto'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.conf_filename" attributeValue="'conf_kyoto.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.defs_filename" attributeValue="'defs_kyoto.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/kyoto'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.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.FakeKyoto.run "qiskit_ibm_runtime.fake_provider.FakeKyoto.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.props_filename" attributeValue="'props_kyoto.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyoto.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyoto.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyoto.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyoto.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyoto.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyoto.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyoto.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyoto.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyoto.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyoto.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyoto.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyoto.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.FakeKyoto.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeLagos
description: API reference for qiskit_ibm_runtime.fake_provider.FakeLagos
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos
---
# FakeLagos
<Class id="qiskit_ibm_runtime.fake_provider.FakeLagos" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py#L31-L38" signature="FakeLagos" modifiers="class">
A fake 7 qubit backend.
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.FakeLagos.backend_name" attributeValue="'fake_lagos'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagos.conf_filename" attributeValue="'conf_lagos.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagos.defs_filename" attributeValue="'defs_lagos.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagos.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/lagos'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagos.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.FakeLagos.run "qiskit_ibm_runtime.fake_provider.FakeLagos.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagos.props_filename" attributeValue="'props_lagos.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagos.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeLagos.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeLagos.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeLagos.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.FakeLagos.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.FakeLagos.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.FakeLagos.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.FakeLagos.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.FakeLagos.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeLagosV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeLagosV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
---
# FakeLagosV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeLagosV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py#L21-L28" signature="FakeLagosV2" modifiers="class">
A fake 7 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.backend_name" attributeValue="'fake_lagos'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.conf_filename" attributeValue="'conf_lagos.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.defs_filename" attributeValue="'defs_lagos.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/lagos'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.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.FakeLagosV2.run "qiskit_ibm_runtime.fake_provider.FakeLagosV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.props_filename" attributeValue="'props_lagos.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.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.FakeLagosV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeLima.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeLima
description: API reference for qiskit_ibm_runtime.fake_provider.FakeLima
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima
---
# FakeLima
<Class id="qiskit_ibm_runtime.fake_provider.FakeLima" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py#L31-L38" signature="FakeLima" modifiers="class">
A fake 5 qubit backend.
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.FakeLima.backend_name" attributeValue="'fake_lima'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLima.conf_filename" attributeValue="'conf_lima.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLima.defs_filename" attributeValue="'defs_lima.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLima.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/lima'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLima.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.FakeLima.run "qiskit_ibm_runtime.fake_provider.FakeLima.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLima.props_filename" attributeValue="'props_lima.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLima.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeLima.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeLima.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeLima.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.FakeLima.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.FakeLima.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.FakeLima.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.FakeLima.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.FakeLima.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeLimaV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeLimaV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
---
# FakeLimaV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeLimaV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py#L21-L28" signature="FakeLimaV2" modifiers="class">
A fake 5 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.backend_name" attributeValue="'fake_lima'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.conf_filename" attributeValue="'conf_lima.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.defs_filename" attributeValue="'defs_lima.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/lima'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.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.FakeLimaV2.run "qiskit_ibm_runtime.fake_provider.FakeLimaV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.props_filename" attributeValue="'props_lima.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.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.FakeLimaV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

149
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx Normal file
View File

@ -0,0 +1,149 @@
---
title: FakeLondon
description: API reference for qiskit_ibm_runtime.fake_provider.FakeLondon
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon
---
# FakeLondon
<Class id="qiskit_ibm_runtime.fake_provider.FakeLondon" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py#L39-L54" signature="FakeLondon" modifiers="class">
A fake 5 qubit backend.
```python
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.FakeLondon.backend_name" attributeValue="'fake_london'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondon.conf_filename" attributeValue="'conf_london.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondon.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/london'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondon.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.FakeLondon.run "qiskit_ibm_runtime.fake_provider.FakeLondon.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondon.props_filename" attributeValue="'props_london.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondon.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeLondon.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.FakeLondon.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.FakeLondon.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.FakeLondon.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.FakeLondon.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.FakeLondon.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.FakeLondon.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

462
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx Normal file
View File

@ -0,0 +1,462 @@
---
title: FakeLondonV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeLondonV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
---
# FakeLondonV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeLondonV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py#L21-L36" signature="FakeLondonV2" modifiers="class">
A fake 5 qubit backend.
```python
0 ↔ 1 ↔ 2
↕
3
↕
4
```
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.backend_name" attributeValue="'fake_london'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.conf_filename" attributeValue="'conf_london.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.defs_filename" attributeValue="None" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/london'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.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.FakeLondonV2.run "qiskit_ibm_runtime.fake_provider.FakeLondonV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.props_filename" attributeValue="'props_london.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.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.FakeLondonV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeManhattan
description: API reference for qiskit_ibm_runtime.fake_provider.FakeManhattan
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan
---
# FakeManhattan
<Class id="qiskit_ibm_runtime.fake_provider.FakeManhattan" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py#L31-L38" signature="FakeManhattan" modifiers="class">
A fake Manhattan backend.
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.FakeManhattan.backend_name" attributeValue="'fake_manhattan'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattan.conf_filename" attributeValue="'conf_manhattan.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattan.defs_filename" attributeValue="'defs_manhattan.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattan.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/manhattan'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattan.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.FakeManhattan.run "qiskit_ibm_runtime.fake_provider.FakeManhattan.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattan.props_filename" attributeValue="'props_manhattan.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattan.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeManhattan.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeManhattan.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeManhattan.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.FakeManhattan.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.FakeManhattan.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.FakeManhattan.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.FakeManhattan.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.FakeManhattan.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeManhattanV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeManhattanV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
---
# FakeManhattanV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py#L21-L28" signature="FakeManhattanV2" modifiers="class">
A fake Manhattan backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.backend_name" attributeValue="'fake_manhattan'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.conf_filename" attributeValue="'conf_manhattan.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.defs_filename" attributeValue="'defs_manhattan.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/manhattan'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.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.FakeManhattanV2.run "qiskit_ibm_runtime.fake_provider.FakeManhattanV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.props_filename" attributeValue="'props_manhattan.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.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.FakeManhattanV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeManila.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeManila
description: API reference for qiskit_ibm_runtime.fake_provider.FakeManila
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila
---
# FakeManila
<Class id="qiskit_ibm_runtime.fake_provider.FakeManila" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py#L31-L38" signature="FakeManila" modifiers="class">
A fake 5 qubit backend.
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.FakeManila.backend_name" attributeValue="'fake_manila'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManila.conf_filename" attributeValue="'conf_manila.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManila.defs_filename" attributeValue="'defs_manila.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManila.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/manila'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManila.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.FakeManila.run "qiskit_ibm_runtime.fake_provider.FakeManila.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManila.props_filename" attributeValue="'props_manila.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManila.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeManila.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeManila.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeManila.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.FakeManila.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.FakeManila.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.FakeManila.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.FakeManila.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.FakeManila.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeManilaV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeManilaV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
---
# FakeManilaV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeManilaV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py#L21-L28" signature="FakeManilaV2" modifiers="class">
A fake 5 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.backend_name" attributeValue="'fake_manila'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.conf_filename" attributeValue="'conf_manila.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.defs_filename" attributeValue="'defs_manila.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/manila'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.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.FakeManilaV2.run "qiskit_ibm_runtime.fake_provider.FakeManilaV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.props_filename" attributeValue="'props_manila.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.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.FakeManilaV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

124
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx Normal file
View File

@ -0,0 +1,124 @@
---
title: FakeMelbourne
description: API reference for qiskit_ibm_runtime.fake_provider.FakeMelbourne
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourne
---
# FakeMelbourne
<Class id="qiskit_ibm_runtime.fake_provider.FakeMelbourne" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py#L38-L95" signature="FakeMelbourne" modifiers="class">
A fake 14 qubit backend.
```python
0 ← 1 → 2 → 3 ← 4 ← 5 → 6
↑ ↑ ↑ ↓ ↓ ↓
13 → 12 ← 11 → 10 ← 9 → 8 ← 7
```
## Attributes
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourne.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.FakeMelbourne.run "qiskit_ibm_runtime.fake_provider.FakeMelbourne.run") method.
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourne.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeMelbourne.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.FakeMelbourne.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.FakeMelbourne.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py#L89-L95" signature="properties()">
Returns a snapshot of device properties
**Return type**
`BackendProperties`
</Function>
### provider
<Function id="qiskit_ibm_runtime.fake_provider.FakeMelbourne.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.FakeMelbourne.run" signature="run(run_input, **kwargs)">
Main job in simulator
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeMelbourne.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.FakeMelbourne.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeMelbourneV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
---
# FakeMelbourneV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py#L29-L35" signature="FakeMelbourneV2" modifiers="class">
A fake 14 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.backend_name" attributeValue="'fake_melbourne'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.conf_filename" attributeValue="'conf_melbourne.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.defs_filename" attributeValue="None" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/melbourne'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.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.FakeMelbourneV2.run "qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.props_filename" attributeValue="'props_melbourne.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.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.FakeMelbourneV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeMontreal
description: API reference for qiskit_ibm_runtime.fake_provider.FakeMontreal
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal
---
# FakeMontreal
<Class id="qiskit_ibm_runtime.fake_provider.FakeMontreal" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py#L31-L38" signature="FakeMontreal" modifiers="class">
A fake 27 qubit backend.
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.FakeMontreal.backend_name" attributeValue="'fake_montreal'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontreal.conf_filename" attributeValue="'conf_montreal.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontreal.defs_filename" attributeValue="'defs_montreal.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontreal.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/montreal'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontreal.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.FakeMontreal.run "qiskit_ibm_runtime.fake_provider.FakeMontreal.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontreal.props_filename" attributeValue="'props_montreal.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontreal.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeMontreal.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeMontreal.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeMontreal.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.FakeMontreal.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.FakeMontreal.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.FakeMontreal.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.FakeMontreal.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.FakeMontreal.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeMontrealV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeMontrealV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
---
# FakeMontrealV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py#L21-L28" signature="FakeMontrealV2" modifiers="class">
A fake 27 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.backend_name" attributeValue="'fake_montreal'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.conf_filename" attributeValue="'conf_montreal.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.defs_filename" attributeValue="'defs_montreal.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/montreal'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.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.FakeMontrealV2.run "qiskit_ibm_runtime.fake_provider.FakeMontrealV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.props_filename" attributeValue="'props_montreal.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.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.FakeMontrealV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeMumbai
description: API reference for qiskit_ibm_runtime.fake_provider.FakeMumbai
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai
---
# FakeMumbai
<Class id="qiskit_ibm_runtime.fake_provider.FakeMumbai" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py#L31-L38" signature="FakeMumbai" modifiers="class">
A fake 27 qubit backend.
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.FakeMumbai.backend_name" attributeValue="'fake_mumbai'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbai.conf_filename" attributeValue="'conf_mumbai.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbai.defs_filename" attributeValue="'defs_mumbai.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbai.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/mumbai'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbai.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.FakeMumbai.run "qiskit_ibm_runtime.fake_provider.FakeMumbai.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbai.props_filename" attributeValue="'props_mumbai.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbai.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeMumbai.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeMumbai.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeMumbai.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.FakeMumbai.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.FakeMumbai.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.FakeMumbai.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.FakeMumbai.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.FakeMumbai.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeMumbaiV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
---
# FakeMumbaiV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py#L21-L28" signature="FakeMumbaiV2" modifiers="class">
A fake 27 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.backend_name" attributeValue="'fake_mumbai'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.conf_filename" attributeValue="'conf_mumbai.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.defs_filename" attributeValue="'defs_mumbai.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/mumbai'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.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.FakeMumbaiV2.run "qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.props_filename" attributeValue="'props_mumbai.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.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.FakeMumbaiV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeNairobi
description: API reference for qiskit_ibm_runtime.fake_provider.FakeNairobi
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi
---
# FakeNairobi
<Class id="qiskit_ibm_runtime.fake_provider.FakeNairobi" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py#L31-L38" signature="FakeNairobi" modifiers="class">
A fake 7 qubit backend.
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.FakeNairobi.backend_name" attributeValue="'fake_nairobi'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobi.conf_filename" attributeValue="'conf_nairobi.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobi.defs_filename" attributeValue="'defs_nairobi.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobi.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/nairobi'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobi.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.FakeNairobi.run "qiskit_ibm_runtime.fake_provider.FakeNairobi.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobi.props_filename" attributeValue="'props_nairobi.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobi.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeNairobi.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeNairobi.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeNairobi.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.FakeNairobi.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.FakeNairobi.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.FakeNairobi.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.FakeNairobi.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.FakeNairobi.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeNairobiV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeNairobiV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
---
# FakeNairobiV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py#L21-L28" signature="FakeNairobiV2" modifiers="class">
A fake 7 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.backend_name" attributeValue="'fake_nairobi'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.conf_filename" attributeValue="'conf_nairobi.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.defs_filename" attributeValue="'defs_nairobi.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/nairobi'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.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.FakeNairobiV2.run "qiskit_ibm_runtime.fake_provider.FakeNairobiV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.props_filename" attributeValue="'props_nairobi.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.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.FakeNairobiV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeOsaka
description: API reference for qiskit_ibm_runtime.fake_provider.FakeOsaka
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
---
# FakeOsaka
<Class id="qiskit_ibm_runtime.fake_provider.FakeOsaka" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/osaka/fake_osaka.py#L21-L28" signature="FakeOsaka" modifiers="class">
A fake 127 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.backend_name" attributeValue="'fake_osaka'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.conf_filename" attributeValue="'conf_osaka.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.defs_filename" attributeValue="'defs_osaka.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/osaka'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.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.FakeOsaka.run "qiskit_ibm_runtime.fake_provider.FakeOsaka.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.props_filename" attributeValue="'props_osaka.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeOsaka.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeOsaka.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeOsaka.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeOsaka.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeOsaka.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeOsaka.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeOsaka.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeOsaka.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeOsaka.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeOsaka.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeOsaka.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeOsaka.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.FakeOsaka.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeOslo
description: API reference for qiskit_ibm_runtime.fake_provider.FakeOslo
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
---
# FakeOslo
<Class id="qiskit_ibm_runtime.fake_provider.FakeOslo" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/oslo/fake_oslo.py#L22-L29" signature="FakeOslo" modifiers="class">
A fake 7 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.backend_name" attributeValue="'fake_oslo'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.conf_filename" attributeValue="'conf_oslo.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.defs_filename" attributeValue="'defs_oslo.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/oslo'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.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.FakeOslo.run "qiskit_ibm_runtime.fake_provider.FakeOslo.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.props_filename" attributeValue="'props_oslo.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeOslo.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeOslo.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeOslo.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeOslo.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeOslo.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeOslo.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeOslo.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeOslo.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeOslo.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeOslo.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeOslo.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeOslo.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.FakeOslo.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

147
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx Normal file
View File

@ -0,0 +1,147 @@
---
title: FakeOurense
description: API reference for qiskit_ibm_runtime.fake_provider.FakeOurense
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense
---
# FakeOurense
<Class id="qiskit_ibm_runtime.fake_provider.FakeOurense" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py#L37-L50" signature="FakeOurense" modifiers="class">
A fake 5 qubit backend.
```python
0 ↔ 1 ↔ 3 ↔ 4
↕
2
```
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.FakeOurense.backend_name" attributeValue="'fake_ourense'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurense.conf_filename" attributeValue="'conf_ourense.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurense.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/ourense'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurense.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.FakeOurense.run "qiskit_ibm_runtime.fake_provider.FakeOurense.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurense.props_filename" attributeValue="'props_ourense.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurense.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeOurense.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.FakeOurense.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.FakeOurense.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.FakeOurense.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.FakeOurense.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.FakeOurense.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.FakeOurense.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

460
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx Normal file
View File

@ -0,0 +1,460 @@
---
title: FakeOurenseV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeOurenseV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
---
# FakeOurenseV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py#L21-L34" signature="FakeOurenseV2" modifiers="class">
A fake 5 qubit backend.
```python
0 ↔ 1 ↔ 3 ↔ 4
↕
2
```
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.backend_name" attributeValue="'fake_ourense'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.conf_filename" attributeValue="'conf_ourense.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.defs_filename" attributeValue="None" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/ourense'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.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.FakeOurenseV2.run "qiskit_ibm_runtime.fake_provider.FakeOurenseV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.props_filename" attributeValue="'props_ourense.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.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.FakeOurenseV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

167
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeParis.mdx Normal file
View File

@ -0,0 +1,167 @@
---
title: FakeParis
description: API reference for qiskit_ibm_runtime.fake_provider.FakeParis
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis
---
# FakeParis
<Class id="qiskit_ibm_runtime.fake_provider.FakeParis" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py#L44-L64" signature="FakeParis" modifiers="class">
A fake Paris backend.
```python
06 17
↕ ↕
00 ↔ 01 ↔ 04 ↔ 07 ↔ 10 ↔ 12 ↔ 15 ↔ 18 ↔ 20 ↔ 23
↕ ↕ ↕
02 13 24
↕ ↕ ↕
03 ↔ 05 ↔ 08 ↔ 11 ↔ 14 ↔ 16 ↔ 19 ↔ 22 ↔ 25 ↔ 26
↕ ↕
09 20
```
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.FakeParis.backend_name" attributeValue="'fake_paris'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParis.conf_filename" attributeValue="'conf_paris.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParis.defs_filename" attributeValue="'defs_paris.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParis.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/paris'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParis.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.FakeParis.run "qiskit_ibm_runtime.fake_provider.FakeParis.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParis.props_filename" attributeValue="'props_paris.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParis.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeParis.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeParis.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeParis.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.FakeParis.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.FakeParis.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.FakeParis.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.FakeParis.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.FakeParis.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

466
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx Normal file
View File

@ -0,0 +1,466 @@
---
title: FakeParisV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeParisV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
---
# FakeParisV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeParisV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py#L21-L41" signature="FakeParisV2" modifiers="class">
A fake Paris backend.
```python
06 17
↕ ↕
00 ↔ 01 ↔ 04 ↔ 07 ↔ 10 ↔ 12 ↔ 15 ↔ 18 ↔ 20 ↔ 23
↕ ↕ ↕
02 13 24
↕ ↕ ↕
03 ↔ 05 ↔ 08 ↔ 11 ↔ 14 ↔ 16 ↔ 19 ↔ 22 ↔ 25 ↔ 26
↕ ↕
09 20
```
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.backend_name" attributeValue="'fake_paris'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.conf_filename" attributeValue="'conf_paris.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.defs_filename" attributeValue="'defs_paris.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/paris'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.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.FakeParisV2.run "qiskit_ibm_runtime.fake_provider.FakeParisV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.props_filename" attributeValue="'props_paris.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeParisV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeParisV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeParisV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeParisV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeParisV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeParisV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeParisV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeParisV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeParisV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeParisV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeParisV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeParisV2.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.FakeParisV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakePeekskill
description: API reference for qiskit_ibm_runtime.fake_provider.FakePeekskill
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
---
# FakePeekskill
<Class id="qiskit_ibm_runtime.fake_provider.FakePeekskill" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/peekskill/fake_peekskill.py#L21-L28" signature="FakePeekskill" modifiers="class">
A fake 27 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.backend_name" attributeValue="'fake_peekskill'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.conf_filename" attributeValue="'conf_peekskill.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.defs_filename" attributeValue="'defs_peekskill.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/peekskill'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.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.FakePeekskill.run "qiskit_ibm_runtime.fake_provider.FakePeekskill.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.props_filename" attributeValue="'props_peekskill.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakePeekskill.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakePeekskill.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakePeekskill.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakePeekskill.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakePeekskill.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakePeekskill.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakePeekskill.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakePeekskill.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakePeekskill.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakePeekskill.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakePeekskill.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakePeekskill.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.FakePeekskill.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakePerth.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakePerth
description: API reference for qiskit_ibm_runtime.fake_provider.FakePerth
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
---
# FakePerth
<Class id="qiskit_ibm_runtime.fake_provider.FakePerth" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/perth/fake_perth.py#L22-L29" signature="FakePerth" modifiers="class">
A fake 7 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.backend_name" attributeValue="'fake_perth'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.conf_filename" attributeValue="'conf_perth.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.defs_filename" attributeValue="'defs_perth.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/perth'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.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.FakePerth.run "qiskit_ibm_runtime.fake_provider.FakePerth.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.props_filename" attributeValue="'props_perth.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakePerth.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakePerth.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakePerth.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakePerth.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakePerth.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakePerth.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakePerth.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakePerth.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakePerth.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakePerth.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakePerth.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakePerth.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.FakePerth.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

128
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx Normal file
View File

@ -0,0 +1,128 @@
---
title: FakePoughkeepsie
description: API reference for qiskit_ibm_runtime.fake_provider.FakePoughkeepsie
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsie
---
# FakePoughkeepsie
<Class id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsie" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py#L39-L128" signature="FakePoughkeepsie" modifiers="class">
A fake Poughkeepsie backend.
```python
00 ↔ 01 ↔ 02 ↔ 03 ↔ 04
↕ ↕
05 ↔ 06 ↔ 07 ↔ 08 ↔ 09
↕ ↕ ↕
10 ↔ 11 ↔ 12 ↔ 13 ↔ 14
↕ ↕
15 ↔ 16 ↔ 17 ↔ 18 ↔ 19
```
## Attributes
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.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.FakePoughkeepsie.run "qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.run") method.
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.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.FakePoughkeepsie.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.FakePoughkeepsie.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py#L122-L128" signature="properties()">
Returns a snapshot of device properties
**Return type**
`BackendProperties`
</Function>
### provider
<Function id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.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.FakePoughkeepsie.run" signature="run(run_input, **kwargs)">
Main job in simulator
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.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.FakePoughkeepsie.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakePoughkeepsieV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
---
# FakePoughkeepsieV2
<Class id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py#L29-L36" signature="FakePoughkeepsieV2" modifiers="class">
A fake Poughkeepsie backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.backend_name" attributeValue="'fake_poughkeepsie'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.conf_filename" attributeValue="'conf_poughkeepsie.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.defs_filename" attributeValue="'defs_poughkeepsie.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.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.FakePoughkeepsieV2.run "qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.props_filename" attributeValue="'props_poughkeepsie.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.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.FakePoughkeepsieV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakePrague.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakePrague
description: API reference for qiskit_ibm_runtime.fake_provider.FakePrague
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
---
# FakePrague
<Class id="qiskit_ibm_runtime.fake_provider.FakePrague" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/prague/fake_prague.py#L22-L28" signature="FakePrague" modifiers="class">
A fake 33 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.backend_name" attributeValue="'fake_prague'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.conf_filename" attributeValue="'conf_prague.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.defs_filename" attributeValue="None" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/prague'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.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.FakePrague.run "qiskit_ibm_runtime.fake_provider.FakePrague.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.props_filename" attributeValue="'props_prague.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakePrague.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakePrague.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakePrague.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakePrague.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakePrague.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakePrague.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakePrague.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakePrague.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakePrague.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakePrague.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakePrague.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakePrague.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.FakePrague.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

76
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx Normal file
View File

@ -0,0 +1,76 @@
---
title: FakeProvider
description: API reference for qiskit_ibm_runtime.fake_provider.FakeProvider
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider
---
# FakeProvider
<Class id="qiskit_ibm_runtime.fake_provider.FakeProvider" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_provider.py#L162-L236" signature="FakeProvider" modifiers="class">
Fake provider containing fake V1 backends.
Only filtering backends by name is implemented. This class contains all fake V1 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider").
<Admonition title="Deprecated since version 1.1" type="danger">
The class `qiskit.providers.provider.Provider` is deprecated as of qiskit 1.1. It will be removed no earlier than 3 months after the release date. The abstract Provider and ProviderV1 classes are deprecated and will be removed in 2.0. You can just remove it as the parent class and a get\_backend method that returns the backends from self.backend.
</Admonition>
## Attributes
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeProvider.version" attributeValue="1" />
## Methods
### backends
<Function id="qiskit_ibm_runtime.fake_provider.FakeProvider.backends" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_provider.py#L180-L181" signature="backends(name=None, **kwargs)">
Return a list of backends matching the specified filtering.
**Parameters**
* **name** (*str*) – name of the backend.
* **\*\*kwargs** – dict used for filtering.
**Returns**
**a list of Backends that match the filtering**
criteria.
**Return type**
list\[Backend]
</Function>
### get\_backend
<Function id="qiskit_ibm_runtime.fake_provider.FakeProvider.get_backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_provider.py#L169-L178" signature="get_backend(name=None, **kwargs)">
Return a single backend matching the specified filtering.
<Admonition title="Deprecated since version 1.1" type="danger">
The method `qiskit.providers.provider.ProviderV1.get_backend()` is deprecated as of qiskit 1.1. It will be removed no earlier than 3 months after the release date. The abstract Provider and ProviderV1 classes are deprecated and will be removed in 2.0. You can just remove it as the parent class and a get\_backend method that returns the backends from self.backend.
</Admonition>
**Parameters**
* **name** (*str*) – name of the backend.
* **\*\*kwargs** – dict used for filtering.
**Returns**
a backend matching the filtering.
**Return type**
Backend
**Raises**
**QiskitBackendNotFoundError** – if no backend could be found or more than one backend matches the filtering criteria.
</Function>
</Class>

48
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx Normal file
View File

@ -0,0 +1,48 @@
---
title: FakeProviderForBackendV2
description: API reference for qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2
---
# FakeProviderForBackendV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_provider.py#L68-L159" signature="FakeProviderForBackendV2" modifiers="class">
Fake provider containing fake V2 backends.
Only filtering backends by name is implemented. This class contains all fake V2 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider").
## Methods
### backend
<Function id="qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_provider.py#L75-L87" signature="backend(name=None, **kwargs)">
Filter backends in provider by name.
**Return type**
`FakeBackendV2`
</Function>
### backends
<Function id="qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.backends" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_provider.py#L94-L96" signature="backends(name=None, **kwargs)">
Return all backends accessible via this account.
**Return type**
`List`\[`FakeBackendV2`]
</Function>
### get\_backend
<Function id="qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.get_backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/utils/deprecation.py#L89-L92" signature="get_backend(name=None, **kwargs)">
Return a single backend matching the specified filtering.
**Return type**
`FakeBackendV2`
</Function>
</Class>

454
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx Normal file
View File

@ -0,0 +1,454 @@
---
title: FakeQuebec
description: API reference for qiskit_ibm_runtime.fake_provider.FakeQuebec
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
---
# FakeQuebec
<Class id="qiskit_ibm_runtime.fake_provider.FakeQuebec" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/quebec/fake_quebec.py#L21-L28" signature="FakeQuebec" modifiers="class">
A fake 127 qubit backend.
FakeBackendV2 initializer.
## Attributes
### backend\_name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.backend_name" attributeValue="'fake_quebec'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.conf_filename" attributeValue="'conf_quebec.json'" />
### coupling\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.coupling_map">
Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object
</Attribute>
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.defs_filename" attributeValue="'defs_quebec.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/quebec'" />
### dt
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.dt">
Return the system time resolution of input signals
This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`Optional`\[`float`]
**Returns**
The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
</Attribute>
### dtm
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
</Attribute>
### instruction\_durations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.instruction_durations">
Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object.
</Attribute>
### instruction\_schedule\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.instruction_schedule_map">
Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target.
</Attribute>
### instructions
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.instructions">
A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
**Return type**
`List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.max_circuits">
**Return type**
`None`
</Attribute>
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
</Attribute>
### num\_qubits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.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.FakeQuebec.run "qiskit_ibm_runtime.fake_provider.FakeQuebec.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.props_filename" attributeValue="'props_quebec.json'" />
### provider
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.provider">
Return the backend Provider.
**Returns**
the Provider responsible for the backend.
**Return type**
Provider
</Attribute>
### target
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
Target
</Attribute>
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.version" attributeValue="2" />
### name
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.name">
Name of the backend.
</Attribute>
### description
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.description">
Optional human-readable description.
</Attribute>
### online\_date
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.online_date">
Date that the backend came online.
</Attribute>
### backend\_version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.backend_version">
Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
</Attribute>
## Methods
### acquire\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeQuebec.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L377-L390" signature="acquire_channel(qubit)">
Return the acquisition channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement acquisition line.
**Return type**
AcquireChannel
</Function>
### check\_faulty
<Function id="qiskit_ibm_runtime.fake_provider.FakeQuebec.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L232-L264" signature="check_faulty(circuit)">
Check if the input circuit uses faulty qubits or edges.
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
**ValueError** – If an instruction operating on a faulty qubit or edge is found.
**Return type**
`None`
</Function>
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeQuebec.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L228-L230" signature="configuration()">
Return the backend configuration.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
</Function>
### control\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeQuebec.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L392-L412" signature="control_channel(qubits)">
Return the secondary drive channel for the given qubit
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
This is required to be implemented if the backend supports Pulse scheduling.
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
The multi qubit control line.
**Return type**
List\[ControlChannel]
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeQuebec.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L212-L226" signature="defaults(refresh=False)">
Return the pulse defaults for the backend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
</Function>
### drive\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeQuebec.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L347-L360" signature="drive_channel(qubit)">
Return the drive channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit drive channel
**Return type**
DriveChannel
</Function>
### measure\_channel
<Function id="qiskit_ibm_runtime.fake_provider.FakeQuebec.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L362-L375" signature="measure_channel(qubit)">
Return the measure stimulus channel for the given qubit.
This is required to be implemented if the backend supports Pulse scheduling.
**Returns**
The Qubit measurement stimulus line
**Return type**
MeasureChannel
</Function>
### properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeQuebec.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L198-L210" signature="properties(refresh=False)">
Return the backend properties
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
</Function>
### qubit\_properties
<Function id="qiskit_ibm_runtime.fake_provider.FakeQuebec.qubit_properties" signature="qubit_properties(qubit)">
Return QubitProperties for a given qubit.
If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
**Parameters**
**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
**Return type**
`Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**Returns**
The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
</Function>
### refresh
<Function id="qiskit_ibm_runtime.fake_provider.FakeQuebec.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L563-L644" signature="refresh(service)">
Update the data files from its real counterpart
This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json
**The new data files will persist through sessions so the files will stay updated unless they**
are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled.
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
* **ValueError** – if the provided service is a non-QiskitRuntimeService instance.
* **Exception** – If the real target doesn’t exist or can’t be accessed
**Return type**
`None`
</Function>
### run
<Function id="qiskit_ibm_runtime.fake_provider.FakeQuebec.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L414-L475" signature="run(run_input, **options)">
Run on the fake backend using a simulator.
This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object.
If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise.
Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2.
**Parameters**
* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend.
* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object.
**Returns**
The job object for the run
**Return type**
Job
**Raises**
**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed.
</Function>
### set\_options
<Function id="qiskit_ibm_runtime.fake_provider.FakeQuebec.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.FakeQuebec.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_backend.py#L180-L196" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
</Function>
</Class>

155
docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx Normal file
View File

@ -0,0 +1,155 @@
---
title: FakeQuito
description: API reference for qiskit_ibm_runtime.fake_provider.FakeQuito
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito
---
# FakeQuito
<Class id="qiskit_ibm_runtime.fake_provider.FakeQuito" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py#L31-L38" signature="FakeQuito" modifiers="class">
A fake 5 qubit backend.
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.FakeQuito.backend_name" attributeValue="'fake_quito'" />
### conf\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuito.conf_filename" attributeValue="'conf_quito.json'" />
### defs\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuito.defs_filename" attributeValue="'defs_quito.json'" />
### dirname
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuito.dirname" attributeValue="'/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/quito'" />
### options
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuito.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.FakeQuito.run "qiskit_ibm_runtime.fake_provider.FakeQuito.run") method.
</Attribute>
### props\_filename
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuito.props_filename" attributeValue="'props_quito.json'" />
### version
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuito.version" attributeValue="1" />
## Methods
### configuration
<Function id="qiskit_ibm_runtime.fake_provider.FakeQuito.configuration" signature="configuration()">
Return the backend configuration.
**Returns**
the configuration for the backend.
**Return type**
BackendConfiguration
</Function>
### defaults
<Function id="qiskit_ibm_runtime.fake_provider.FakeQuito.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.29/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33" signature="defaults()">
Returns a snapshot of device defaults
**Return type**
`PulseDefaults`
</Function>
### name
<Function id="qiskit_ibm_runtime.fake_provider.FakeQuito.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.FakeQuito.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.FakeQuito.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.FakeQuito.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.FakeQuito.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.FakeQuito.status" signature="status()">
Return the backend status.
**Returns**
the status of the backend.
**Return type**
BackendStatus
</Function>
</Class>

Some files were not shown because too many files have changed in this diff Show More