§ ¹³Ùgf3ãóº—dZddlZddlmZmZeje ¦«Z eddd¬¦«Z ed d d ¬¦«Z ed d d¬¦«Z eddd¬¦«Zeddd¬¦«Zeddd¬¦«Zedd¬¦«Zedddœdd¬¦«Zed d!¬¦«Zed"d#¬¦«Zed$d%¬¦«Zed&dd'œd(d)¬¦«Zegd*¢d+¬¦«Zed,d-d.¬¦«Zed/d0¬¦«Zed1d2d3¬¦«Zed4d5d6¬¦«Zed7d8¬¦«Zed9d:¬¦«Zed;dd?¬¦«Zed@dA¬¦«ZedBdC¬¦«Z edDdEidFdG¬¦«Z!edHdIdJ¬¦«Z"edKdL¬¦«Z#edMdN¬¦«Z$edOdP¬¦«Z%edQdR¬¦«Z&edSdT¬¦«Z'edUdVdW¬X¦«Z(edYdZ¬[¦«Z)ed\d]¬[¦«Z*dS)^aØ! .. 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 `__. Qiskit uses special methods from Symengine to accelerate its handling of :class:`~.circuit.Parameter`\ s if available. .. 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. Qiskit's :class:`.PhaseOracle` uses this, which is used in turn by amplification algorithms via the :class:`.AmplificationProblem`. .. 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é)ÚLazyImportTesterÚLazySubprocessTesterÚ qiskit_aerz Qiskit Aerzpip install qiskit-aer)ÚnameÚinstallzqiskit.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-constraintÚcplexzpip install cplexz9This may not be possible for all Python versions and OSes)rÚmsgÚcvxpyzpip install cvxpy)r©)ÚModel)Údocplexzdocplex.mp.modelzpip install docplexÚfixtureszpip install fixturesÚIPythonzpip install ipythonÚ ipywidgetszpip install ipywidgets)ÚgradÚjit)Újaxz jax.numpyrzpip install jax)ÚjupyterÚnbformatÚ nbconvertzpip install jupyter)zmatplotlib.patcheszmatplotlib.pyplotÚ matplotlibzpip install matplotlibÚnetworkxzpip install networkxÚnloptzNLopt Optimizerzpip install nloptz PIL.ImageÚpillowzpip install pillowÚpydotzpip install pydotÚpygmentszpip install pygments)ÚLatexNodes2Text)Ú utf8tolatex)zpylatexenc.latex2textzpylatexenc.latexencodeÚ pylatexenczpip install pylatexencÚqiskit_qasm3_importzpip install qiskit_qasm3_importÚseabornzpip install seabornzsklearn.linear_model)ÚRidgeÚLassoz scikit-learnzpip install scikit-learnz skquant.optz scikit-quantzpip install scikit-quantÚ SQSnobFitzpip install SQSnobFitÚ symenginezpip install symengineÚ testtoolszpip install testtoolsÚ tweedledumzpip install tweedledumÚz3zpip install z3-solver)Údotz-VÚGraphvizzÎTo 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__Ú_loggerÚHAS_AERÚHAS_IBMQÚ HAS_IGNISÚHAS_TOQMÚHAS_CONSTRAINTÚ HAS_CPLEXÚ HAS_CVXPYÚ HAS_DOCPLEXÚ HAS_FIXTURESÚ HAS_IPYTHONÚHAS_IPYWIDGETSÚHAS_JAXÚ HAS_JUPYTERÚHAS_MATPLOTLIBÚ HAS_NETWORKXÚ HAS_NLOPTÚHAS_PILÚ HAS_PYDOTÚ HAS_PYGMENTSÚ HAS_PYLATEXÚHAS_QASM3_IMPORTÚ HAS_SEABORNÚ HAS_SKLEARNÚ HAS_SKQUANTÚ HAS_SQSNOBFITÚ HAS_SYMENGINEÚ HAS_TESTTOOLSÚHAS_TWEEDLEDUMÚHAS_Z3Ú HAS_GRAPHVIZÚ HAS_PDFLATEXÚHAS_PDFTOCAIROróúL/granary/edev/quantum/lib/python3.11/site-packages/qiskit/utils/optionals.pyúr[sÿðð^ð^ðFÐÐÐððððððððð ˆ(Ô ˜XÑ &Ô &€à Ð ØØ Ø $ð ñ ô €ð Ð ØØ Ø .ð ñ ô €ð Ð ØØ Ø &ð ñ ô € ð Ð ˜]°ÐHaÐ bÑ bÔ b€à"Ð"ØØ Ø +ðñô€ð Ð Ø Ø ØCð ñ ô € ð Ð ˜gÐ/BÐ CÑ CÔ C€ ØÐب Ð3Ð3Ø !ØCðñô€ ð !Ð  Ð5KÐLÑLÔL€ ØР Ð3HÐIÑIÔI€ Ø"Ð" <Ð9QÐRÑRÔR€Ø Ð Ø ¨"Ð-Ð-Ø Ø ð ñ ô €ð  ÐÐ DÐ DÐ DÐNcÐdÑdÔd€ Ø"Ð"Ø/Ø Ø $ðñô€ð !Ð  Ð5KÐLÑLÔL€ à Ð ˜gÐ,=ÐGZÐ [Ñ [Ô [€ Ø Ð ˜K¨hÐ@TÐ UÑ UÔ U€Ø Ð ˜gÐ/BÐ CÑ CÔ C€ Ø Ð  Ð5KÐLÑLÔL€ ØÐà!5Ø"2ððð Ø $ð ñô€ ð%Ð$ØÐ#DðñôÐð Р Ð3HÐIÑIÔI€ ØÐØÐ/Ð0Ø Ø &ðñô€ ð  ÐØØ Ø &ðñô€ ð "Ð! +Ð7NÐOÑOÔO€ Ø!Ð! +Ð7NÐOÑOÔO€ Ø!Ð! +Ð7NÐOÑOÔO€ Ø"Ð" <Ð9QÐRÑRÔR€Ø Ð ˜4Ð)@Ð AÑ AÔ A€à$Ð$ØØ ð 9ð ñô€ ð%Ð$ØØSðñô€ ð'Ð&ØØ<ðñô€€€rY