qiskit-nature-pyscf 0.2.0

Qiskit Nature PySCF: Third-party integration plugin of Qiskit Nature + PySCF.

Qiskit Nature PySCF

Qiskit Nature PySCF is a third-party integration plugin of Qiskit Nature + PySCF.

Installation

We encourage installing Qiskit Nature PySCF via the pip tool (a python package manager).

pip install qiskit-nature-pyscf

pip will handle all dependencies automatically and you will always install the latest (and well-tested) version. It will also install Qiskit Nature if needed.

If you want to work on the very latest work-in-progress versions, either to try features ahead of their official release or if you want to contribute to Qiskit Nature PySCF, then you can install from source.

Usage

This plugin couples the APIs of PySCF and Qiskit Nature, enabling a user of PySCF to leverage Quantum-based algorithms implemented in Qiskit to be used in-place of their classical counterparts.

Active Space Calculations

One very common approach is to use a Quantum algorithm to find the ground state in an active space calculation. To this extent, this plugin provides the QiskitSolver class, which you can inject directly into your CASCI or CASSCF simulation objects of PySCF.

Below we show a simple example of how to do this.

from pyscf import gto, scf, mcscf

import numpy as np

from qiskit.algorithms.minimum_eigensolvers import VQE
from qiskit.algorithms.optimizers import SLSQP
from qiskit.primitives import Estimator
from qiskit_nature.second_q.algorithms import GroundStateEigensolver
from qiskit_nature.second_q.circuit.library import HartreeFock, UCCSD
from qiskit_nature.second_q.mappers import ParityMapper

from qiskit_nature_pyscf import QiskitSolver

mol = gto.M(atom="Li 0 0 0; H 0 0 1.6", basis="sto-3g")

h_f = scf.RHF(mol).run()

norb = 2
nalpha, nbeta = 1, 1
nelec = nalpha + nbeta

cas = mcscf.CASCI(h_f, norb, nelec)

mapper = ParityMapper(num_particles=(nalpha, nbeta))

ansatz = UCCSD(
    norb,
    (nalpha, nbeta),
    mapper,
    initial_state=HartreeFock(
        norb,
        (nalpha, nbeta),
        mapper,
    ),
)

vqe = VQE(Estimator(), ansatz, SLSQP())
vqe.initial_point = np.zeros(ansatz.num_parameters)

algorithm = GroundStateEigensolver(mapper, vqe)

cas.fcisolver = QiskitSolver(algorithm)

cas.run()

More detailed documentation can be found at Documentation. For more detailed explanations we recommend to check out the documentation of PySCF and Qiskit Nature.

Citation

If you use this plugin, please cite the following references:

• PySCF, as per these instructions.
• Qiskit, as per the provided BibTeX file.
• Qiskit Nature, as per https://doi.org/10.5281/zenodo.7828767