Optional Dependencies

This module defines lazy availability testers for optional third-party dependencies. The checkers are instances of LazyImportTester and can be used as booleans (evaluated lazily), or to raise a MissingOptionalLibraryError when a dependency is required.

Available Testers

HAS_FFSIM = <qiskit.utils.lazy_tester.LazyImportTester object>

ffsim is a high-performance simulator for fermionic quantum circuits that exploits particle-number and spin-Z conservation.

FermionicCircuit instances can be simulated using ffsim.apply_unitary().

Note

ffsim does not support Windows, which is why it is an optional dependency.

See also

LazyDependencyManager for usage examples and the available methods of this object.

HAS_PYOMO = <qiskit.utils.lazy_tester.LazyImportTester object>

Pyomo is a Python-based optimization modeling language used to build linear and mixed-integer programs (LP/MILP) for classical solvers.

See also

LazyDependencyManager for usage examples and the available methods of this object.

HAS_QISKIT_ADDON_SQD = <qiskit.utils.lazy_tester.LazyImportTester object>

qiskit-addon-sqd implements sample-based quantum diagonalization (SQD): it projects a Hamiltonian onto the subspace spanned by measured computational- basis configurations and iteratively refines that subspace via configuration recovery.

Note

qiskit-addon-sqd pulls in PySCF, which does not support Windows, which is why it is an optional dependency.

See also

LazyDependencyManager for usage examples and the available methods of this object.