qat.fermion.chemistry.wrapper.MoleculeInfo

class qat.fermion.chemistry.wrapper.MoleculeInfo(hamiltonian: MolecularHamiltonian, n_electrons: int, noons: ndarray | List[float], orbital_energies: ndarray)

MoleculeInfo helper class. This class is a even higher level version of the MolecularHamiltonian.

Parameters:

• hamiltonian (MolecularHamiltonian) – The MolecularHamiltonian of the studied molecule.

• n_electrons (int) – Number of electrons.

• noons (Union[np.ndarray, List[float]]) – Natural orbital occupation number.

• orbital_energies (np.ndarray) – Orbital energies.

nqbits

The total number of qubits.

Type:

int

one_body_integrals

One-body integrals \(I_{uv}\).

Type:

np.ndarray

two_body_integrals

Two-body integrals \(I_{uvwx}\).

Type:

np.ndarray

constant_coeff

Constant coefficient \(r\) (core repulsion).

Type:

np.ndarray

hamiltonian

The MolecularHamiltonian of the studied molecule.

Type:

MolecularHamiltonian

n_electrons

Number of electrons.

Type:

int

noons

Natural orbital occupation number.

Type:

Union[np.ndarray, List[float]]

orbital_energies

Orbital energies.

Type:

np.ndarray

Example

import numpy as np
from qat.fermion.chemistry import MolecularHamiltonian, MoleculeInfo

# For illustration purpose, initialize random one- and two-body integrals, and a constant
one_body_integral = np.random.randn(2, 2)
two_body_integral = np.random.randn(2, 2, 2, 2)
constant = np.random.rand()
noons = list(np.random.randn(10))
orbital_energies = list(np.random.randn(10))

# Define the MolecularHamiltonian
mol_h = MolecularHamiltonian(one_body_integral, two_body_integral, constant)

# Define MoleculeInfo
molecule = MoleculeInfo(
    mol_h,
    n_electrons=4,
    noons=noons,
    orbital_energies=orbital_energies
)

print(molecule)

MoleculeInfo(
 - MolecularHamiltonian(
    * constant_coeff : 0.4743124253415739
    * integrals shape
       ** one_body_integrals : (2, 2)
       ** two_body_integrals : (2, 2, 2, 2)
   )
 - n_electrons = 4
 - noons = [np.float64(-1.6801814066015426), np.float64(0.812385989026995), np.float64(0.1455634685849333), np.float64(1.4254519717485739), np.float64(-0.0015814590945099336), np.float64(-1.035364856914019), np.float64(-1.267754909931074), np.float64(0.5945151100580169), np.float64(-0.26960364344312143), np.float64(0.7723205714735976)]
 - orbital energies = [np.float64(-1.2135328423023768), np.float64(0.5010919202616687), np.float64(-0.573042854493544), np.float64(0.9255060876212956), np.float64(-0.30517645598685555), np.float64(-0.170159438612237), np.float64(1.3261767178438153), np.float64(0.7550016518291945), np.float64(-0.9486480446067321), np.float64(0.10406240995957615)]
)

restrict_active_space(threshold_1: float | None = 0.02, threshold_2: float | None = 0.001)

Same method as the MolecularHamiltonian method select_active_space(), except it also modifies all the molecule parameters accordingly (NOONs, orbital energies, and number of electrons).

For more information, see select_active_space() documentation.

Parameters:

• threshold_1 (Optional[float]) – The upper threshold \(\varepsilon_1\) on the NOON of an active orbital.

• threshold_2 (Optional[float]) – The lower threshold \(\varepsilon_2\) on the NOON of an active orbital.