Psi4Driver#

class Psi4Driver(config='molecule h2 {\n 0 1\n H 0.0 0.0 0.0\n H 0.0 0.0 0.735\n no_com\n no_reorient\n}\n\nset {\n basis sto-3g\n scf_type pk\n reference rhf\n')[source]#

Bases: ElectronicStructureDriver

Qiskit Nature driver using the Psi4 program. See http://www.psicode.org/

Parameters:: config (str | list[str]) – A molecular configuration conforming to Psi4 format.
Raises:: QiskitNatureError – Psi4 Driver configuration should be a string or list of strings.

Methods

static check_method_supported(method)[source]#

Checks that Psi4 supports this method.

Parameters:: method (MethodType) – the SCF method type.
Raises:: UnsupportMethodError – If the method is not supported.

static from_molecule(molecule, basis='sto3g', method=MethodType.RHF, driver_kwargs=None)[source]#

Creates a driver from a molecule.

Parameters:

molecule (MoleculeInfo) – the molecular information.
basis (str) – the basis set.
method (MethodType) – the SCF method type.
driver_kwargs (dict[str, Any] | None) – keyword arguments to be passed to driver.

Returns:

The constructed driver instance.

Raises:

QiskitNatureError – when an unknown unit is encountered.

Return type:

Psi4Driver

run()[source]#

Returns an ElectronicStructureProblem output as produced by the driver.

Return type:: ElectronicStructureProblem

static to_driver_basis(basis)[source]#

Converts basis to a driver acceptable basis.

Parameters:: basis (str) – The basis set to be used.
Returns:: A driver acceptable basis.
Return type:: str

to_problem(*, basis=ElectronicBasis.MO, include_dipole=True)[source]#

Extends the to_qcschema() method and translates the QCSchema object to an ElectronicStructureProblem.

Parameters:

basis (ElectronicBasis) – the ElectronicBasis in which to construct the problem.
include_dipole (bool) – whether or not to include an ElectronicDipoleMoment property in the generated problem (if the data is available).

Returns:

An ElectronicStructureProblem.

Return type:

ElectronicStructureProblem

to_qcschema(*, include_dipole=True)[source]#

Extracts all available information after the driver was run into a QCSchema object.

Parameters:: include_dipole (bool) – whether to include the custom dipole integrals in the QCSchema.
Returns:: A QCSchema storing all extracted system data computed by the driver.
Return type:: QCSchema