qiskit-neko/searchindex.js

Search.setIndex({"docnames": ["api", "apiref/qiskit_neko.aer_plugin.AerBackendPlugin", "apiref/qiskit_neko.aer_plugin.AerBackendPlugin.get_backend", "apiref/qiskit_neko.backend_plugin.BackendPlugin", "apiref/qiskit_neko.backend_plugin.BackendPlugin.get_backend", "apiref/qiskit_neko.backend_plugin.BackendPluginManager", "apiref/qiskit_neko.backend_plugin.BackendPluginManager.failure_hook", "apiref/qiskit_neko.backend_plugin.BackendPluginManager.get_plugin_backends", "config", "index"], "filenames": ["api.rst", "apiref/qiskit_neko.aer_plugin.AerBackendPlugin.rst", "apiref/qiskit_neko.aer_plugin.AerBackendPlugin.get_backend.rst", "apiref/qiskit_neko.backend_plugin.BackendPlugin.rst", "apiref/qiskit_neko.backend_plugin.BackendPlugin.get_backend.rst", "apiref/qiskit_neko.backend_plugin.BackendPluginManager.rst", "apiref/qiskit_neko.backend_plugin.BackendPluginManager.failure_hook.rst", "apiref/qiskit_neko.backend_plugin.BackendPluginManager.get_plugin_backends.rst", "config.rst", "index.rst"], "titles": ["Qiskit Neko API Reference", "AerBackendPlugin", "qiskit_neko.aer_plugin.AerBackendPlugin.get_backend", "BackendPlugin", "qiskit_neko.backend_plugin.BackendPlugin.get_backend", "BackendPluginManager", "qiskit_neko.backend_plugin.BackendPluginManager.failure_hook", "qiskit_neko.backend_plugin.BackendPluginManager.get_plugin_backends", "Qiskit-Neko Configuration Files", "Welcome to the documentation of qiskit-neko"], "terms": {"class": [1, 3, 5, 8], "sourc": [1, 2, 3, 4, 5, 6, 7], "base": [1, 3, 5, 8], "backendplugin": [1, 8, 9], "A": [1, 8], "backend": [1, 2, 3, 4, 5, 7, 8, 9], "plugin": [1, 3, 4, 5, 7, 8, 9], "us": [1, 2, 4, 8], "qiskit": [1, 2, 3], "aer": 1, "method": [1, 2, 3, 5, 6], "backend_select": [2, 4, 7, 8], "none": [2, 4, 7, 8], "return": [2, 3, 4, 7, 8], "object": [2, 3, 4, 5, 7, 8], "run": [2, 4, 8], "test": [2, 3, 4, 8], "paramet": [2, 4], "str": [2, 4], "an": [2, 4, 8], "option": [2, 4, 8], "select": [2, 4, 8], "string": [2, 4, 8], "specifi": [2, 9], "from": [2, 3, 8], "thi": [2, 3, 4, 8], "can": [2, 8], "two": 2, "differ": [2, 3, 8], "wai": 2, "either": 2, "fake": 2, "name": [2, 7, 8], "mock": 2, "terra": 2, "fake_quito": 2, "which": [2, 8], "altern": 2, "start": 2, "ideal": 2, "aersimul": 2, "set": [2, 8], "If": [2, 4, 8], "i": [2, 3, 4, 8], "defailt": 2, "rais": [2, 4], "valueerror": 2, "invalid": [2, 4], "pass": [2, 8], "abc": 3, "abstract": [3, 4], "provid": [3, 4], "design": 3, "implement": 3, "packag": 3, "ani": [3, 8], "other": 3, "user": [3, 4], "need": 3, "custom": 3, "suit": [3, 8], "In": 3, "gener": 3, "authent": 3, "initi": 3, "work": 3, "vendor": 3, "simul": 3, "ar": [3, 8], "all": [3, 4, 8], "uniqu": 3, "neko": 3, "interfac": [3, 9], "enabl": 3, "standard": [3, 8], "leav": 3, "specif": [3, 4], "suppli": 4, "valu": [4, 8], "The": [4, 8], "exact": [4, 8], "behavior": [4, 8], "up": 4, "each": 4, "individu": 4, "should": 4, "clearli": 4, "document": [4, 8], "how": [4, 8], "doesn": 4, "t": 4, "support": [4, 8], "still": 4, "accept": 4, "warn": [4, 8], "just": [4, 8], "log": [4, 8], "thei": 4, "re": 4, "except": 4, "expect": 4, "manag": 5, "instal": 5, "static": 6, "_": 6, "ep": 6, "err": 6, "hook": 6, "execut": [6, 8], "import": [6, 8], "failur": 6, "dictionari": [7, 8], "To": 8, "against": 8, "also": 8, "tune": 8, "tweak": 8, "make": 8, "reproduc": 8, "simpler": 8, "format": 8, "": 8, "yaml": 8, "fulli": 8, "popul": 8, "exampl": 8, "below": 8, "test_timeout": 8, "60": 8, "0": 8, "backend_plugin": [8, 9], "ibmq": 8, "santiago": 8, "backend_script": 8, "tmp": 8, "default_log_level": 8, "debug": 8, "module_log_level": 8, "info": 8, "numpi": 8, "log_format": 8, "asctim": 8, "process": 8, "d": 8, "messag": 8, "log_fil": 8, "qiskit_neko": [8, 9], "defin": 8, "float": 8, "second": 8, "maximum": 8, "per": 8, "timeout": 8, "take": 8, "longer": 8, "than": 8, "mark": 8, "error": 8, "fail": 8, "rest": 8, "default": 8, "includ": 8, "aerplugin": 8, "influenc": 8, "refer": [8, 9], "absolut": 8, "path": 8, "script": 8, "lieu": 8, "It": 8, "must": 8, "contain": 8, "function": 8, "main": 8, "when": 8, "call": 8, "subclass": 8, "preced": 8, "over": 8, "level": 8, "modul": [8, 9], "emit": 8, "dure": 8, "valid": 8, "predefin": 8, "see": 8, "http": 8, "doc": 8, "python": 8, "org": 8, "3": 8, "librari": 8, "html": 8, "complet": 8, "list": 8, "nest": 8, "where": 8, "kei": 8, "leve": 8, "control": 8, "output": 8, "same": 8, "formatt": 8, "printf": 8, "style": 8, "built": 8, "logrecord": 8, "attribut": 8, "write": 8, "addit": 8, "store": 8, "result": 8, "stream": 8, "written": 8, "By": 8, "look": 8, "4": 8, "place": 8, "follow": 8, "order": 8, "found": 8, "locat": 8, "subsequ": 8, "check": 8, "cwd": 8, "neko_config": 8, "yml": 8, "config": 8, "etc": 8, "sinc": 8, "actual": 8, "handl": 8, "extern": 8, "unittest": 8, "framework": 8, "onli": 8, "mechan": 8, "explicitli": 8, "environ": 8, "variabl": 8, "you": 8, "nekoconfigpath": 8, "regardless": 8, "being": 8, "present": 8, "configur": 9, "file": 9, "api": 9, "get_backend": 9, "backendpluginmanag": 9, "failure_hook": 9, "get_plugin_backend": 9, "aerbackendplugin": 9, "aer_plugin": 9, "index": 9, "search": 9, "page": 9}, "objects": {"qiskit_neko.aer_plugin": [[1, 0, 1, "", "AerBackendPlugin"]], "qiskit_neko.aer_plugin.AerBackendPlugin": [[2, 1, 1, "", "get_backend"]], "qiskit_neko.backend_plugin": [[3, 0, 1, "", "BackendPlugin"], [5, 0, 1, "", "BackendPluginManager"]], "qiskit_neko.backend_plugin.BackendPlugin": [[4, 1, 1, "", "get_backend"]], "qiskit_neko.backend_plugin.BackendPluginManager": [[6, 1, 1, "", "failure_hook"], [7, 1, 1, "", "get_plugin_backends"]]}, "objtypes": {"0": "py:class", "1": "py:method"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"]}, "titleterms": {"qiskit": [0, 8, 9], "neko": [0, 8, 9], "api": 0, "refer": 0, "backend": 0, "plugin": 0, "interfac": 0, "aerbackendplugin": [1, 2], "qiskit_neko": [2, 4, 6, 7], "aer_plugin": 2, "get_backend": [2, 4], "backendplugin": [3, 4], "backend_plugin": [4, 6, 7], "backendpluginmanag": [5, 6, 7], "failure_hook": 6, "get_plugin_backend": 7, "configur": 8, "file": 8, "specifi": 8, "welcom": 9, "document": 9, "indic": 9, "tabl": 9}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.todo": 2, "sphinx.ext.intersphinx": 1, "sphinx": 58}, "alltitles": {"Qiskit Neko API Reference": [[0, "qiskit-neko-api-reference"]], "Backend Plugin Interface": [[0, "backend-plugin-interface"]], "AerBackendPlugin": [[1, "aerbackendplugin"]], "qiskit_neko.aer_plugin.AerBackendPlugin.get_backend": [[2, "qiskit-neko-aer-plugin-aerbackendplugin-get-backend"]], "BackendPlugin": [[3, "backendplugin"]], "qiskit_neko.backend_plugin.BackendPlugin.get_backend": [[4, "qiskit-neko-backend-plugin-backendplugin-get-backend"]], "BackendPluginManager": [[5, "backendpluginmanager"]], "qiskit_neko.backend_plugin.BackendPluginManager.failure_hook": [[6, "qiskit-neko-backend-plugin-backendpluginmanager-failure-hook"]], "qiskit_neko.backend_plugin.BackendPluginManager.get_plugin_backends": [[7, "qiskit-neko-backend-plugin-backendpluginmanager-get-plugin-backends"]], "Qiskit-Neko Configuration Files": [[8, "qiskit-neko-configuration-files"]], "Specifying Configuration Files": [[8, "specifying-configuration-files"]], "Welcome to the documentation of qiskit-neko": [[9, "welcome-to-the-documentation-of-qiskit-neko"]], "Indices and tables": [[9, "indices-and-tables"]]}, "indexentries": {"aerbackendplugin (class in qiskit_neko.aer_plugin)": [[1, "qiskit_neko.aer_plugin.AerBackendPlugin"]], "get_backend() (aerbackendplugin method)": [[2, "qiskit_neko.aer_plugin.AerBackendPlugin.get_backend"]], "backendplugin (class in qiskit_neko.backend_plugin)": [[3, "qiskit_neko.backend_plugin.BackendPlugin"]], "get_backend() (backendplugin method)": [[4, "qiskit_neko.backend_plugin.BackendPlugin.get_backend"]], "backendpluginmanager (class in qiskit_neko.backend_plugin)": [[5, "qiskit_neko.backend_plugin.BackendPluginManager"]], "failure_hook() (backendpluginmanager static method)": [[6, "qiskit_neko.backend_plugin.BackendPluginManager.failure_hook"]], "get_plugin_backends() (backendpluginmanager method)": [[7, "qiskit_neko.backend_plugin.BackendPluginManager.get_plugin_backends"]]}})