README.md

ebcc: Coupled cluster calculations on electron-boson systems

The ebcc package implements various coupled cluster (CC) models for both purely electronic and coupled electron-boson models, with a focus on generality and model extensibility.

For a summary of the implemented models, see the FEATURES.md file.

Installation

From PyPI:

pip install ebcc

From source:

git clone https://github.com/BoothGroup/ebcc
pip install .

Usage

The implemented models are built upon the mean-field objects of pyscf:

from pyscf import gto, scf
from ebcc import EBCC
mol = gto.M(atom="H 0 0 0; H 0 0 1", basis="cc-pvdz")
mf = scf.RHF(mol)
mf.kernel()
ccsd = EBCC(mf, ansatz="CCSD")
ccsd.kernel()

Many ansatzes for both fermionic and electron-boson coupled cluster calculations are available. For more details see the tutorials and examples directories.

Code generation

The models implemented are generated algorithmically from expressions over second quantized operators. The scripts for generating these models are found in the codegen directory on the bootstrap branch. User-inputted models should operate seamlessly with the solvers by adding files under ebcc/codegen, so long as they satisfy the interface.