qat.fermion.chemistry.wrapper.MoleculeInfo

class qat.fermion.chemistry.wrapper.MoleculeInfo(hamiltonian: MolecularHamiltonian, n_electrons: int, noons: Union[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.6432470329967231
    * integrals shape
       ** one_body_integrals : (2, 2)
       ** two_body_integrals : (2, 2, 2, 2)
   )
 - n_electrons = 4
 - noons = [-0.3823959297294299, -0.6733349478150767, -2.1416675663761255, -0.28518306842695923, -2.1631581800034496, -0.13541973882222907, -0.7118437617013409, 0.44590158271403235, -0.6600514856530421, 2.5131715044139558]
 - orbital energies = [-0.9133775066898359, -0.49849290648840977, 0.29063416125846786, -2.080952422070466, -0.16525604397935711, -1.124833378065621, -0.7190156483370688, 1.8052947763334357, 0.07725785170411344, 2.013958631261319]
)
restrict_active_space(threshold_1: Optional[float] = 0.02, threshold_2: Optional[float] = 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.