z i.5JSrSSKrSSKJrJr \R"\ 5r \"SSSS9r \"S S S S9r \"S S SS9r \"SSSS9r\"SSSS9r\"SSSS9r\"SSS9r\"SSS.SSS9r\"S S!S9r\"S"S#S9r\"S$S%S9r\"S&SS'.S(S)S9r\"/S*QS+S9r\"S,S-S.S9r\"S/S0S9r\"S1S2S3S9r\"S4S5S6S9r\"S7S8S9r\"S9S:S9r\"S;SS?S9r\"S@SAS9r\"SBSCS9r \"SDSE0SFSGS9r!\"SHSISJS9r"\"SKSLS9r#\"SMSNS9r$\"SOSPS9r%\"SQSRS9r&\"SSSTS9r'\"SUSVS9r(\"SWSXSYSZ9r)\"S[S\S]9r*\"S^S_S]9r+g)`aW# .. currentmodule:: qiskit.utils.optionals Qiskit has several features that are enabled only if certain *optional* dependencies are satisfied. This module, :mod:`qiskit.utils.optionals`, has a collection of objects that can be used to test if certain functionality is available, and optionally raise :class:`.MissingOptionalLibraryError` if the functionality is not available. Available Testers ================= Qiskit Components ----------------- .. py:data:: HAS_AER `Qiskit Aer ` provides high-performance simulators for the quantum circuits constructed within Qiskit. .. py:data:: HAS_IBMQ The :mod:`Qiskit IBMQ Provider ` is used for accessing IBM Quantum hardware in the IBM cloud. .. py:data:: HAS_IGNIS :mod:`Qiskit Ignis ` provides tools for quantum hardware verification, noise characterization, and error correction. .. py:data:: HAS_TOQM `Qiskit TOQM `__ provides transpiler passes for the `Time-optimal Qubit mapping algorithm `__. External Python Libraries ------------------------- .. py:data:: HAS_CONSTRAINT `python-constraint `__ is a constraint satisfaction problem solver, used in the :class:`~.CSPLayout` transpiler pass. .. py:data:: HAS_CPLEX The `IBM CPLEX Optimizer `__ is a high-performance mathematical programming solver for linear, mixed-integer and quadratic programming. This is no longer by Qiskit, but it weas historically and the optional remains for backwards compatibility. .. py:data:: HAS_CVXPY `CVXPY `__ is a Python package for solving convex optimization problems. It is required for calculating diamond norms with :func:`.quantum_info.diamond_norm`. .. py:data:: HAS_DOCPLEX `IBM Decision Optimization CPLEX Modelling `__ is a library for prescriptive analysis. Like CPLEX, this is no longer by Qiskit, but it weas historically and the optional remains for backwards compatibility. .. py:data:: HAS_FIXTURES The test suite has additional features that are available if the optional `fixtures `__ module is installed. This generally also needs :data:`HAS_TESTTOOLS` as well. This is generally only needed for Qiskit developers. .. py:data:: HAS_IPYTHON If `the IPython kernel `__ is available, certain additional visualizations and line magics are made available. .. py:data:: HAS_IPYWIDGETS Monitoring widgets for jobs running on external backends can be provided if `ipywidgets `__ is available. .. py:data:: HAS_JAX Some methods of gradient calculation within :mod:`.opflow.gradients` require `JAX `__ for autodifferentiation. .. py:data:: HAS_JUPYTER Some of the tests require a complete `Jupyter `__ installation to test interactivity features. .. py:data:: HAS_MATPLOTLIB Qiskit provides several visualization tools in the :mod:`.visualization` module. Almost all of these are built using `Matplotlib `__, which must be installed in order to use them. .. py:data:: HAS_NETWORKX No longer used by Qiskit. Internally, Qiskit now uses the high-performance `rustworkx `__ library as a core dependency, and during the change-over period, it was sometimes convenient to convert things into the Python-only `NetworkX `__ format. Some tests of application modules, such as `Qiskit Nature `__ still use NetworkX. .. py:data:: HAS_NLOPT `NLopt `__ is a nonlinear optimization library, used by the global optimizers in the :mod:`.algorithms.optimizers` module. .. py:data:: HAS_PIL PIL is a Python image-manipulation library. Qiskit actually uses the `pillow `__ fork of PIL if it is available when generating certain visualizations, for example of both :class:`.QuantumCircuit` and :class:`.DAGCircuit` in certain modes. .. py:data:: HAS_PYDOT For some graph visualizations, Qiskit uses `pydot `__ as an interface to GraphViz (see :data:`HAS_GRAPHVIZ`). .. py:data:: HAS_PYGMENTS Pygments is a code highlighter and formatter used by many environments that involve rich display of code blocks, including Sphinx and Jupyter. Qiskit uses this when producing rich output for these environments. .. py:data:: HAS_PYLATEX Various LaTeX-based visualizations, especially the circuit drawers, need access to the `pylatexenc `__ project to work correctly. .. py:data:: HAS_QASM3_IMPORT The functions :func:`.qasm3.load` and :func:`.qasm3.loads` for importing OpenQASM 3 programs into :class:`.QuantumCircuit` instances use `an external importer package `__. .. py:data:: HAS_SEABORN Qiskit provides several visualization tools in the :mod:`.visualization` module. Some of these are built using `Seaborn `__, which must be installed in order to use them. .. py:data:: HAS_SKLEARN Some of the gradient functions in :mod:`.opflow.gradients` use regularisation methods from `Scikit Learn `__. .. py:data:: HAS_SKQUANT Some of the optimisers in :mod:`.algorithms.optimizers` are based on those found in `Scikit Quant `__, which must be installed to use them. .. py:data:: HAS_SQSNOBFIT `SQSnobFit `__ is a library for the "stable noisy optimization by branch and fit" algorithm. It is used by the :class:`.SNOBFIT` optimizer. .. py:data:: HAS_SYMENGINE `Symengine `__ is a fast C++ backend for the symbolic-manipulation library `Sympy `__. This dependency is used to load legacy QPY formats, where this package was used to handle :class:`~.circuit.Parameter`\ s. .. py:data:: HAS_SYMPY `SymPy `__ is Python library for symbolic mathematics. ``SymPy`` was historically used for the implementation of the :class:`.ParameterExpression` class but isn't any longer. However it is needed for some legacy functionality that uses :meth:`.ParameterExpression.sympify`. It is also used in some visualization functions and template matching. .. py:data:: HAS_TESTTOOLS Qiskit's test suite has more advanced functionality available if the optional `testtools `__ library is installed. This is generally only needed for Qiskit developers. .. py:data:: HAS_TWEEDLEDUM `Tweedledum `__ is an extension library for synthesis and optimization of circuits that may involve classical oracles. In the past Qiskit's :class:`.PhaseOracle` used this but it is no longer used by Qiskit. .. py:data:: HAS_Z3 `Z3 `__ is a theorem prover, used in the :class:`.CrosstalkAdaptiveSchedule` and :class:`.HoareOptimizer` transpiler passes. External Command-Line Tools --------------------------- .. py:data:: HAS_GRAPHVIZ For some graph visualizations, Qiskit uses the `GraphViz `__ visualization tool via its ``pydot`` interface (see :data:`HAS_PYDOT`). .. py:data:: HAS_PDFLATEX Visualization tools that use LaTeX in their output, such as the circuit drawers, require ``pdflatex`` to be available. You will generally need to ensure that you have a working LaTeX installation available, and the ``qcircuit.tex`` package. .. py:data:: HAS_PDFTOCAIRO Visualization tools that convert LaTeX-generated files into rasterized images use the ``pdftocairo`` tool. This is part of the `Poppler suite of PDF tools `__. Lazy Checker Classes ==================== .. currentmodule:: qiskit.utils Each of the lazy checkers is an instance of :class:`.LazyDependencyManager` in one of its two subclasses: :class:`.LazyImportTester` and :class:`.LazySubprocessTester`. These should be imported from :mod:`.utils` directly if required, such as:: from qiskit.utils import LazyImportTester .. autoclass:: qiskit.utils.LazyDependencyManager :members: .. autoclass:: qiskit.utils.LazyImportTester .. autoclass:: qiskit.utils.LazySubprocessTester N)LazyImportTesterLazySubprocessTester qiskit_aerz Qiskit Aerzpip install qiskit-aer)nameinstallzqiskit.providers.ibmqz IBMQ Providerz pip install qiskit-ibmq-providerz qiskit.ignisz Qiskit Igniszpip install qiskit-ignis qiskit_toqmz Qiskit TOQMzpip install qiskit-toqm constraintzpython-constraintzpip install python-constraintcplexzpip install cplexz9This may not be possible for all Python versions and OSes)rmsgcvxpyzpip install cvxpy)r)Model)docplexzdocplex.mp.modelzpip install docplexfixtureszpip install fixturesIPythonzpip install ipython ipywidgetszpip install ipywidgets)gradjit)jaxz jax.numpyrzpip install jax)jupyternbformat nbconvertzpip install jupyter)zmatplotlib.patcheszmatplotlib.pyplot matplotlibzpip install matplotlibnetworkxzpip install networkxnloptzNLopt Optimizerzpip install nloptz PIL.Imagepillowzpip install pillowpydotzpip install pydotpygmentszpip install pygments)LatexNodes2Text) utf8tolatex)zpylatexenc.latex2textzpylatexenc.latexencode pylatexenczpip install pylatexencqiskit_qasm3_importzpip install qiskit_qasm3_importseabornzpip install seabornzsklearn.linear_model)RidgeLassoz scikit-learnzpip install scikit-learnz skquant.optz scikit-quantzpip install scikit-quant SQSnobFitzpip install SQSnobFit symenginezpip install symengine<0.14sympyzpip install sympy testtoolszpip install testtools tweedledumzpip install tweedledumz3zpip install z3-solver)dotz-VGraphvizzTo install, follow the instructions at https://graphviz.org/download/. Qiskit needs the Graphviz binaries, which the 'graphviz' package on pip does not install. You must install the actual Graphviz software)rr )pdflatexz-versionzIYou will likely need to install a full LaTeX distribution for your system)r ) pdftocairoz-vz2This is part of the 'poppler' set of PDF utilities),__doc__logging_logging lazy_testerr_LazyImportTesterr_LazySubprocessTester getLogger__name___loggerHAS_AERHAS_IBMQ HAS_IGNISHAS_TOQMHAS_CONSTRAINT HAS_CPLEX HAS_CVXPY HAS_DOCPLEX HAS_FIXTURES HAS_IPYTHONHAS_IPYWIDGETSHAS_JAX HAS_JUPYTERHAS_MATPLOTLIB HAS_NETWORKX HAS_NLOPTHAS_PIL HAS_PYDOT HAS_PYGMENTS HAS_PYLATEXHAS_QASM3_IMPORT HAS_SEABORN HAS_SKLEARN HAS_SKQUANT HAS_SQSNOBFIT HAS_SYMENGINE HAS_SYMPY HAS_TESTTOOLSHAS_TWEEDLEDUMHAS_Z3 HAS_GRAPHVIZ HAS_PDFLATEXHAS_PDFTOCAIROrP/home/james-whalen/.local/lib/python3.13/site-packages/qiskit/utils/optionals.pyr]sgeT   X &   $    .    &  ]Ha b"  +  C  g/B C  3 !C !5KL  3HI "<9QR  "-     DNcd "/  $ !5KL g,=GZ [ Kh@T U g/B C  5KL !5"2  $  %#D 3HI /0  &    & "+7NO !+7ST g/B C !+7NO "<9QR 4)@ A$  9  %S '<r[