quemb.molbe.misc.be2puffin

quemb.molbe.misc.be2puffin(xyzfile, basis, hcore=None, libint_inp=False, pts_and_charges=None, jk=None, use_df=False, charge=0, spin=0, nproc=1, ompnum=1, be_type='be1', df_aux_basis=None, frozen_core=True, localization_method='lowdin', unrestricted=False, from_chk=False, checkfile=None, ecp=None)

Front-facing API bridge tailored for SCINE Puffin

Returns the CCSD oneshot energies - QM/MM notes: Using QM/MM alongside big basis sets, especially with a frozen core, can cause localization and numerical stability problems. Use with caution. Additional work to this end on localization, frozen core, ECPs, and QM/MM in this capacity is ongoing. - If running unrestricted QM/MM calculations, with ECPs, in a large basis set, do not freeze the core. Using an ECP for heavy atoms improves the localization numerics, but this is not yet compatible with frozen core on the rest of the atoms.

Parameters:

  • xyzfile (str) – Path to the xyz file

  • basis (str) – Name of the basis set

  • hcore (ndarray) – Two-dimensional array of the core Hamiltonian

  • libint_inp (bool) – True for hcore provided in Libint format. Else, hcore input is in PySCF format Default is False, i.e., hcore input is in PySCF format

  • pts_and_charges (tuple of ndarray) – QM/MM (points, charges). Use pyscf’s QM/MM instead of starting Hamiltonian

  • jk (ndarray) – Coulomb and Exchange matrices (pyscf will calculate this if not given)

  • use_df (bool, optional) – If true, use density-fitting to evaluate the two-electron integrals

  • charge (int, optional) – Total charge of the system

  • spin (int, optional) – Total spin of the system, pyscf definition

  • nproc (int, optional)

  • ompnum (int, optional) – Set number of processors and ompnum for the jobs

  • frozen_core (bool, optional) – Whether frozen core approximation is used or not, by default True

  • localization_method (str, optional) – For now, lowdin is best supported for all cases. IAOs to be expanded By default ‘lowdin’

  • unrestricted (bool, optional) – Unrestricted vs restricted HF and CCSD, by default False

  • from_chk (bool, optional) – Run calculation from converged RHF/UHF checkpoint. By default False

  • checkfile (str, optional) – if not None: - if from_chk: specify the checkfile to run the embedding calculation - if not from_chk: specify where to save the checkfile By default None

  • ecp (str, optional) – specify the ECP for any atoms, accompanying the basis set syntax; for example {'Na': 'bfd-pp', 'Ru': 'bfd-pp'} By default None