Complete methods API catalog
Every class exported by ccpy.methods.__all__ is included below. Constructors
are read from __init__ (including inherited constructors), rather than the
generic allocation signature. Defaults are class-level values; instance settings
can override them. Base classes are extension protocols, not runnable methods.
For usage and compatible scientific chains, see Ground states and energy corrections, Excitation, attachment, ionization, ADC and STEOM, Initial guesses, symmetry and choosing roots, FNOs, active spaces and selected determinants and Left states, densities, response and gradients. A listed flag or inherited attribute is not a guarantee that every model/reference combination is implemented.
Moller-Plesset perturbation theory
MBPTBase
MBPTBase(upstream, nfrozen=None, ndelete=None, **options)
Source description:
Base class of MPn energies (scheme: MBPT); no amplitudes are iterated.
Defined in
ccpy.methods.mbpt.Extension base; choose a concrete subclass for calculations.
Class-level
requires_df_port = False.Public members defined here:
hamiltonian(property),solve(),energy(),raw_energy().
MP2
MP2(upstream, nfrozen=None, ndelete=None, **options)
Source description:
MP2 with DF/Cholesky integrals.
Defined in
ccpy.methods.mbpt.Class-level
requires_df_port = False.function = 'calc_mp2'.Public members defined here:
solve().
MP3
MP3(upstream, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.mbpt.Class-level
requires_df_port = True.function = 'calc_mp3'.
MP4
MP4(upstream, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.mbpt.Class-level
requires_df_port = True.function = 'calc_mp4'.
Ground-state coupled cluster
ACCBase
ACCBase(upstream, acparray, nfrozen=None, ndelete=None, **options)
Source description:
Approximate coupled-pair methods: acparray (5 floats) scales the five T2**2 diagrams.
Defined in
ccpy.methods.cc.Extension base; choose a concrete subclass for calculations.
Class-level
requires_df_port = False.hbar_class = HBarCCSD.order = 2.denominators = ('mp',).
ACCD
ACCD(upstream, acparray, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.cc.Class-level
requires_df_port = True.order = 2.denominators = ('mp',).module = 'ccpy.cc.accd'.
ACCSD
ACCSD(upstream, acparray, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.cc.Class-level
requires_df_port = True.order = 2.denominators = ('mp',).module = 'ccpy.cc.accsd'.
ACCSDT_P
ACCSDT_P(upstream, t3_excitations, acparray, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.cc.Class-level
requires_df_port = True.hbar_class = HBarCCSDT_P.left_class = 'LeftCCSDT_P'.order = 3.denominators = ('mp',).module = 'ccpy.cc.accsdt_p'.
CC2
CC2(upstream, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.cc.Class-level
requires_df_port = True.hbar_class = HBarCC2.order = 2.denominators = ('mp',).module = 'ccpy.cc.cc2'.
CC3
CC3(upstream, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.cc.Class-level
requires_df_port = True.hbar_class = HBarCC3.left_class = 'LeftCC3'.order = 2.denominators = ('mp',).module = 'ccpy.cc.cc3'.
CC4
CC4(upstream, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.cc.Class-level
requires_df_port = True.order = 3.denominators = ('mp',).module = 'ccpy.cc.cc4'.Public members defined here:
solve().
CCBase
CCBase(upstream, nfrozen=None, ndelete=None, **options)
Source description:
Base class of ground-state CC methods (scheme: ground-state CC).
Defined in
ccpy.methods.cc.Extension base; choose a concrete subclass for calculations.
Class-level
requires_df_port = False.hbar_class = HBarCCSD.order = 2.denominators = ('mp',).Public members defined here:
cc(property),hamiltonian(property),total_energy(property),get_hbar(hbar_class=None),hbar(property),left(property),solve(),energy(),raw_energy(),rdm1(),rdm2().
CCD
CCD(upstream, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.cc.Class-level
requires_df_port = True.order = 2.denominators = ('mp',).module = 'ccpy.cc.ccd'.
CCPBase
CCPBase(upstream, t3_excitations, nfrozen=None, ndelete=None, **options)
Source description:
CC(P) methods: the highest excitation rank is restricted to a list of excitations
(the P space), e.g., ``t3_excitations = {"aaa": ..., "aab": ..., "abb": ..., "bbb": ...}``
with rows [a, b, c, i, j, k].
Defined in
ccpy.methods.cc.Extension base; choose a concrete subclass for calculations.
Class-level
requires_df_port = False.hbar_class = HBarCCSD.order = 2.denominators = ('mp',).Public members defined here:
set_pspace(t3_excitations).
CCSD
CCSD(upstream, nfrozen=None, ndelete=None, **options)
Source description:
CCSD with DF/Cholesky integrals.
Defined in
ccpy.methods.cc.Class-level
requires_df_port = False.hbar_class = HBarCCSD.left_class = 'LeftCCSD'.order = 2.denominators = ('mp', 'epstein-nesbet', 'quasilinear', 'newton').gradient_module = 'ccpy.gradients.ccsd_gradient'.gradient_function = 'calc_ccsd_gradient'.module = 'ccpy.cc.ccsd_chol'.
CCSDT
CCSDT(upstream, nfrozen=None, ndelete=None, **options)
Source description:
CCSDT. ccpy.cc.ccsdt_chol is an unfinished DF version (outdated Fortran
interfaces, not installed), so the four-index equations are used for now.
Defined in
ccpy.methods.cc.Class-level
requires_df_port = True.hbar_class = HBarCCSDT.left_class = 'LeftCCSDT'.order = 3.denominators = ('mp', 'epstein-nesbet', 'quasilinear', 'newton').module = 'ccpy.cc.ccsdt'.
CCSDTQ
CCSDTQ(upstream, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.cc.Class-level
requires_df_port = True.order = 4.denominators = ('mp',).module = 'ccpy.cc.ccsdtq'.
CCSDT_P
CCSDT_P(upstream, t3_excitations, nfrozen=None, ndelete=None, **options)
Source description:
CCSDT(P) (CCSD plus the triples of the P space) with DF/Cholesky integrals. Its analytic
gradient needs the CC(P) densities of ccpy.density.ccsdt_p_rdm.
Defined in
ccpy.methods.cc.Class-level
requires_df_port = False.hbar_class = HBarCCSDT_P.left_class = 'LeftCCSDT_P'.order = 3.denominators = ('mp', 'epstein-nesbet', 'quasilinear', 'newton').gradient_module = 'ccpy.gradients.ccsdt_p_gradient'.gradient_function = 'calc_ccsdt_p_gradient'.module = 'ccpy.cc.ccsdt_p_chol'.Public members defined here:
has_analytic_gradient(**kwargs).
ECCC2
ECCC2(upstream, ci_vectors_file, nfrozen=None, ndelete=None, **options)
Source description:
Externally corrected CCSD: T3 and T4 from the cluster analysis of a CI wave
function (``ci_vectors_file``) are held fixed.
Defined in
ccpy.methods.cc.Class-level
requires_df_port = True.hbar_class = HBarCCSD.order = 2.denominators = ('mp',).module = 'ccpy.cc.eccc2'.
Equation-of-motion methods
DEAEOM2
DEAEOM2(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDLegacy.num_particles = 2.num_holes = 0.fno_sector = 'DEA'.default_guess = 'deacis'.guess_multiplicity = -1.module = 'ccpy.eomcc.deaeom2'.
DEAEOM3
DEAEOM3(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDLegacy.num_particles = 3.num_holes = 1.fno_sector = 'DEA'.default_guess = 'deacis'.guess_multiplicity = -1.module = 'ccpy.eomcc.deaeom3'.
DEAEOM4
DEAEOM4(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDLegacy.num_particles = 4.num_holes = 2.fno_sector = 'DEA'.default_guess = 'deacis'.guess_multiplicity = -1.module = 'ccpy.eomcc.deaeom4'.
DEAEOM4_P
DEAEOM4_P(upstream, r3_excitations, t3_excitations=None, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDLegacy.num_particles = 4.num_holes = 2.fno_sector = 'DEA'.default_guess = 'deacis'.guess_multiplicity = -1.module = 'ccpy.eomcc.deaeom4_p'.
DIPEOM3
DIPEOM3(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDLegacy.num_particles = 1.num_holes = 3.fno_sector = 'DIP'.default_guess = 'dipcis'.guess_multiplicity = -1.module = 'ccpy.eomcc.dipeom3'.
DIPEOM4
DIPEOM4(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDLegacy.num_particles = 2.num_holes = 4.fno_sector = 'DIP'.default_guess = 'dipcis'.guess_multiplicity = -1.module = 'ccpy.eomcc.dipeom4'.
DIPEOMCCSDT
DIPEOMCCSDT(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSDT.hbar_class = HBarCCSDT.num_particles = 2.num_holes = 4.fno_sector = 'DIP'.default_guess = 'dipcis'.guess_multiplicity = -1.module = 'ccpy.eomcc.dipeomccsdt'.
DIPEOMCCSDTA
DIPEOMCCSDTA(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDTA.num_particles = 2.num_holes = 4.fno_sector = 'DIP'.default_guess = 'dipcis'.guess_multiplicity = -1.module = 'ccpy.eomcc.dipeomccsdta'.
EAEOM2
EAEOM2(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDLegacy.left_class = 'LeftEAEOM2'.num_particles = 2.num_holes = 1.fno_sector = 'EA'.default_guess = 'eacisd'.guess_multiplicity = -1.module = 'ccpy.eomcc.eaeom2'.
EAEOM3
EAEOM3(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDLegacy.left_class = 'LeftEAEOM3'.num_particles = 3.num_holes = 2.fno_sector = 'EA'.default_guess = 'eacisd'.guess_multiplicity = -1.module = 'ccpy.eomcc.eaeom3'.
EAEOM3_P
EAEOM3_P(upstream, r3_excitations, t3_excitations=None, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDLegacy.left_class = 'LeftEAEOM3_P'.num_particles = 3.num_holes = 2.fno_sector = 'EA'.default_guess = 'eacisd'.guess_multiplicity = -1.module = 'ccpy.eomcc.eaeom3_p'.
EAEOMCCSDT
EAEOMCCSDT(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSDT.hbar_class = HBarCCSDT.num_particles = 3.num_holes = 2.fno_sector = 'EA'.default_guess = 'eacisd'.guess_multiplicity = -1.module = 'ccpy.eomcc.eaeomccsdt'.
EOMCC2
EOMCC2(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CC2.hbar_class = HBarCC2.order = 2.fno_sector = 'EE'.default_guess = 'cisd'.module = 'ccpy.eomcc.eomcc2'.
EOMCC3
EOMCC3(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Source description:
EOM-CC3, solved with the nonlinear (omega-dependent) DIIS solver.
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CC3.hbar_class = HBarCC3.order = 2.fno_sector = 'EE'.default_guess = 'cisd'.module = 'ccpy.eomcc.eomcc3'.
EOMCCBase
EOMCCBase(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Source description:
Base class of EOMCC methods (scheme: EOMCC); levels set the equation module, the
operator type, the ground-state CC/HBar they need, and the default guess.
Defined in
ccpy.methods.eomcc.Extension base; choose a concrete subclass for calculations.
Class-level
requires_df_port = False.cc_class = CCSD.hbar_class = HBarCCSD.default_guess = 'cisd'.Public members defined here:
hbar(property),left(property),nroots(property),run_guess(),solve(),energy(root=None),raw_energy(root=None),completed_omega(property).
EOMCCSD
EOMCCSD(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Source description:
EOMCCSD with DF/Cholesky integrals.
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = False.cc_class = CCSD.hbar_class = HBarCCSD.left_class = 'LeftEOMCCSD'.order = 2.fno_sector = 'EE'.default_guess = 'cisd'.gradient_module = 'ccpy.gradients.eomccsd_gradient'.gradient_function = 'calc_eomccsd_gradient'.module = 'ccpy.eomcc.eomccsd_chol'.
EOMCCSDT
EOMCCSDT(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSDT.hbar_class = HBarCCSDT.left_class = 'LeftEOMCCSDT'.order = 3.fno_sector = 'EE'.default_guess = 'cisd'.module = 'ccpy.eomcc.eomccsdt'.
EOMCCSDTA
EOMCCSDTA(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Source description:
EOMCCSD equations on the CCSD(T)(a) HBar (right states of EOMCCSD(T)(a)*).
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDTA.left_class = 'LeftEOMCCSDTA'.order = 2.fno_sector = 'EE'.default_guess = 'cisd'.module = 'ccpy.eomcc.eomccsd'.
EOMCCSDT_P
EOMCCSDT_P(upstream, r3_excitations, t3_excitations=None, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Source description:
EOMCCSDT(P) on top of CCSDT(P); triples of R restricted to ``r3_excitations``.
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSDT_P.hbar_class = HBarCCSDT_P.left_class = 'LeftEOMCCSDT_P'.order = 3.fno_sector = 'EE'.default_guess = 'cisd'.module = 'ccpy.eomcc.eomccsdt_p'.
IPEOM2
IPEOM2(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDLegacy.left_class = 'LeftIPEOM2'.num_particles = 1.num_holes = 2.fno_sector = 'IP'.default_guess = 'ipcisd'.guess_multiplicity = -1.module = 'ccpy.eomcc.ipeom2'.
IPEOM3
IPEOM3(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDLegacy.left_class = 'LeftIPEOM3'.num_particles = 2.num_holes = 3.fno_sector = 'IP'.default_guess = 'ipcisd'.guess_multiplicity = -1.module = 'ccpy.eomcc.ipeom3'.
IPEOM3_P
IPEOM3_P(upstream, r3_excitations, t3_excitations=None, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDLegacy.left_class = 'LeftIPEOM3_P'.num_particles = 2.num_holes = 3.fno_sector = 'IP'.default_guess = 'ipcisd'.guess_multiplicity = -1.module = 'ccpy.eomcc.ipeom3_p'.
IPEOMCCSDT
IPEOMCCSDT(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSDT.hbar_class = HBarCCSDT.num_particles = 2.num_holes = 3.fno_sector = 'IP'.default_guess = 'ipcisd'.guess_multiplicity = -1.module = 'ccpy.eomcc.ipeomccsdt'.
IPEOMCCSDTA
IPEOMCCSDTA(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDTA.num_particles = 2.num_holes = 3.fno_sector = 'IP'.default_guess = 'ipcisd'.guess_multiplicity = -1.module = 'ccpy.eomcc.ipeomccsdta'.
IPEOMCCSDT_P
IPEOMCCSDT_P(upstream, r3_excitations, t3_excitations=None, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSDT_P.hbar_class = HBarCCSDT_P.num_particles = 2.num_holes = 3.fno_sector = 'IP'.default_guess = 'ipcisd'.guess_multiplicity = -1.module = 'ccpy.eomcc.ipeomccsdt_p'.
SFEOMCC23
SFEOMCC23(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDLegacy.order = 3.fno_sector = 'SF'.default_guess = 'sfcis'.guess_multiplicity = -1.module = 'ccpy.eomcc.sfeomcc23'.
SFEOMCCSD
SFEOMCCSD(upstream, roots=None, hbar_class=None, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.eomcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDLegacy.order = 2.fno_sector = 'SF'.default_guess = 'sfcis'.guess_multiplicity = -1.module = 'ccpy.eomcc.sfeomccsd'.
Algebraic-diagrammatic construction
ADC2
ADC2(upstream, roots=None, nfrozen=None, ndelete=None, formulation='folded', **options)
Source description:
Strict EE-ADC(2) for real RHF/ROHF/UHF and noncanonical references.
Defined in
ccpy.methods.adc.Class-level
requires_df_port = False.fno_sector = 'EE'.default_guess = 'cisd'.guess_methods = ('cis', 'cisd_chol').Public members defined here:
kernel(property),correlation_energy(property),nroots(property),solve(),raw_energy(root=None),energy(root=None),completed_omega(property),virtual_density(root=0).
EAADC2
EAADC2(upstream, roots=None, nfrozen=None, ndelete=None, formulation='folded', **options)
Source description:
DF EA-ADC(2), alpha-attachment branch, with bare EA-CISd root targeting.
Defined in
ccpy.methods.adc.Class-level
requires_df_port = False.fno_sector = 'EA'.default_guess = 'eacisd'.guess_methods = ('eacis', 'eacisd').guess_multiplicity = -1.
IPADC2
IPADC2(upstream, roots=None, nfrozen=None, ndelete=None, formulation='folded', **options)
Source description:
DF IP-ADC(2), alpha-removal branch, with bare IP-CISd root targeting.
Defined in
ccpy.methods.adc.Class-level
requires_df_port = False.fno_sector = 'IP'.default_guess = 'ipcisd'.guess_methods = ('ipcis', 'ipcisd').guess_multiplicity = -1.
STEOM-CCSD
STEOMCC
STEOMCC(upstream, nroots=1, multiplicity=1, nacto=None, nactu=None, active_occupied=None, active_virtual=None, occupied_threshold=None, virtual_threshold=None, ip_threshold=None, ea_threshold=None, condition_limit=10000000000.0, nfrozen=None, ndelete=None, level='sd', **options)
Source description:
Closed-shell STEOM-CCSD, with excitation energies in ``omega`` (hartree).
Defined in
ccpy.methods.steomcc.Class-level
requires_df_port = True.default_guess = 'cisd'.guess_methods = ('cis', 'cisd').Public members defined here:
hbar(property),solve(),energy(root=None),raw_energy(root=None),completed_omega(property).
Extended STEOM
STEOMCCSDT
STEOMCCSDT(upstream, nroots=1, multiplicity=1, level='sdt', auxiliary_order=3, auxiliary_solver='pspace', minimum_active=1, ip_pspace=None, ea_pspace=None, dense_limit=80, ip_threshold=None, ea_threshold=None, **kwargs)
Source description:
STEOMCC(..., level='sdt'): enlarged auxiliary models and an SD G problem.
Defined in
ccpy.methods.steomccsdt.Class-level
requires_df_port = True.default_guess = 'cisd'.guess_methods = ('cis', 'cisd').Public members defined here:
solve().
Noniterative and adaptive corrections
AdaptiveCCPQ
AdaptiveCCPQ(upstream, percentage=None, pspaces=None, energy_tolerance=0.0001, maximum_macroiterations=10, n_det_max=100000000, selection_factor=1.0, base_growth='ccsd', buffer_factor=2, minimum_threshold=0.0, reset_amplitudes=False, nfrozen=None, ndelete=None, stochastic=None, convergence_z=1.96, **options)
Source description:
Adaptive CC(P;Q) (DF/Cholesky): CCSDT(P) on a P space of triples grown, macroiteration
by macroiteration, with the triples of largest CC(P;3) moment contributions.
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = False.Public members defined here:
solve(),energy(),raw_energy().
CCP3
CCP3(upstream, t3_excitations=None, two_body_approx=True, target_irrep=None, high_memory=False, variant=None, nfrozen=None, ndelete=None, stochastic=None, **options)
Source description:
CC(P;3) correction. With two_body_approx=True (default, DF/Cholesky) it uses the
CCSD-like HBar and left-CCSD; otherwise the full correction with the CCSDT(P) HBar and
left-CCSDT(P) (legacy four-index). The two-body approximation can be evaluated
semi-stochastically with ``stochastic`` (see GroundStateCorrectionBase).
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = False.cc_class = CCSD.hbar_class = HBarCCSD.left_class = LeftCCSD.variants = ('A', 'B', 'C', 'D').default_variant = 'D'.supports_stochastic = True.gradient_variants = ().module = 'ccpy.moments.ccp3_chol'.function = 'calc_ccp3_2ba'.
CCP4
CCP4(upstream, t4_excitations, variant=None, nfrozen=None, ndelete=None, **options)
Source description:
CC(P;4) quadruples correction for the P space ``t4_excitations``.
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDLegacy.left_class = LeftCCSD.variants = ('A', 'B', 'C', 'D').default_variant = 'D'.supports_stochastic = False.gradient_variants = ().module = 'ccpy.moments.ccp4'.function = 'calc_ccp4'.
CCSDpT
CCSDpT(upstream, variant=None, nfrozen=None, ndelete=None, stochastic=None, **options)
Source description:
CCSD(T), from the bare Hamiltonian (no HBar or left-CC needed).
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = True.cc_class = CCSD.variants = ('A',).default_variant = 'A'.supports_stochastic = False.gradient_variants = ().module = 'ccpy.moments.crcc23'.function = 'calc_ccsdpt'.
CCT3
CCT3(upstream, t3_excitations=None, num_active=1, nacto=None, nactu=None, variant=None, nfrozen=None, ndelete=None, stochastic=None, **options)
Source description:
CC(t;3): CR-CC(2,3)-like correction to CCSDt (active-space CCSDT(P)) (DF/Cholesky).
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = False.cc_class = CCSD.hbar_class = HBarCCSD.left_class = LeftCCSD.variants = ('A', 'B', 'C', 'D').default_variant = 'D'.supports_stochastic = True.gradient_variants = ().module = 'ccpy.moments.cct3_chol'.function = 'calc_cct3'.
CRCC23
CRCC23(upstream, variant=None, nfrozen=None, ndelete=None, stochastic=None, **options)
Source description:
CR-CC(2,3) triples correction to CCSD (DF/Cholesky); semi-stochastic with ``stochastic``.
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = False.cc_class = CCSD.hbar_class = HBarCCSD.left_class = LeftCCSD.variants = ('A', 'B', 'C', 'D').default_variant = 'D'.supports_stochastic = True.gradient_variants = ('A',).gradient_module = 'ccpy.gradients.crcc23_gradient'.gradient_function = 'calc_crcc23_gradient'.module = 'ccpy.moments.crcc23_chol'.function = 'calc_crcc23'.
CRCC24
CRCC24(upstream, variant=None, nfrozen=None, ndelete=None, stochastic=None, **options)
Source description:
CR-CC(2,4) quadruples correction to CCSD.
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDLegacy.left_class = LeftCCSD.variants = ('A', 'B', 'C', 'D').default_variant = 'D'.supports_stochastic = False.gradient_variants = ().module = 'ccpy.moments.crcc24'.function = 'calc_crcc24'.
CRCC34
CRCC34(upstream, variant=None, nfrozen=None, ndelete=None, stochastic=None, **options)
Source description:
CR-CC(3,4) quadruples correction to CCSDT (RHF only; variant A).
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = True.cc_class = CCSDT.hbar_class = HBarCCSDT.left_class = LeftCCSDT.variants = ('A', 'B', 'C', 'D').default_variant = 'A'.supports_stochastic = False.gradient_variants = ().module = 'ccpy.moments.crcc34'.function = 'calc_crcc34'.
CREACC23
CREACC23(upstream, variant=None, **options)
Source description:
CR-EA-EOMCC(2,3) corrections to EA-EOMCCSD(2p-1h).
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = True.variants = ('A', 'B', 'C', 'D').default_variant = 'D'.gradient_variants = ().module = 'ccpy.moments.creacc23'.function = 'calc_creacc23'.
CREOMCC23
CREOMCC23(upstream, variant=None, **options)
Source description:
delta-CR-EOMCC(2,3) triples corrections to EOMCCSD (DF/Cholesky).
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = False.variants = ('A', 'B', 'C', 'D').default_variant = 'D'.gradient_variants = ('A',).gradient_module = 'ccpy.gradients.creomcc23_gradient'.gradient_function = 'calc_creomcc23_gradient'.module = 'ccpy.moments.creomcc23_chol'.function = 'calc_creomcc23'.Public members defined here:
energy(root=None),raw_energy(root=None),full_energy(root=None),full_raw_energy(root=None).
CRIPCC23
CRIPCC23(upstream, variant=None, **options)
Source description:
CR-IP-EOMCC(2,3) corrections to IP-EOMCCSD(2h-1p).
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = True.variants = ('A', 'B', 'C', 'D').default_variant = 'D'.gradient_variants = ().module = 'ccpy.moments.cripcc23'.function = 'calc_cripcc23'.
CorrectionBase
CorrectionBase(upstream, variant=None, nfrozen=None, ndelete=None, **options)
Source description:
Base class of noniterative corrections (scheme: noniterative correction).
Defined in
ccpy.methods.corrections.Extension base; choose a concrete subclass for calculations.
Class-level
requires_df_port = False.variants = ('A', 'B', 'C', 'D').default_variant = 'D'.gradient_variants = ().Public members defined here:
solve(),has_analytic_gradient(**kwargs).
DIPEOMCCSDTA_star
DIPEOMCCSDTA_star(upstream, variant=None, **options)
Source description:
DIP-EOMCCSD(T)(a)* (4h-2p) corrections to DIP-EOMCC(3h-1p); no left vectors needed.
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = True.variants = ('A', 'B', 'C', 'D').default_variant = 'A'.gradient_variants = ().module = 'ccpy.moments.dipeomccsdta_star'.function = 'calc_dipeomccsdta_star'.
EACCP3
EACCP3(upstream, variant=None, **options)
Source description:
EA-CC(P;3) corrections to EA-EOMCC(P).
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = True.variants = ('A', 'B', 'C', 'D').default_variant = 'D'.gradient_variants = ().module = 'ccpy.moments.eaccp3'.function = 'calc_eaccp3'.
EAEOMCCSDTA_star
EAEOMCCSDTA_star(upstream, variant=None, **options)
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = True.variants = ('A', 'B', 'C', 'D').default_variant = 'A'.gradient_variants = ().module = 'ccpy.moments.eaeomccsdta_star'.function = 'calc_eaeomccsdta_star'.
EOMCCP3
EOMCCP3(upstream, target_irrep=None, variant=None, **options)
Source description:
Full CC(P;3) corrections to EOMCCSDT(P) energies.
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = True.variants = ('A', 'B', 'C', 'D').default_variant = 'D'.gradient_variants = ().module = 'ccpy.moments.ccp3'.function = 'calc_eomccp3'.
EOMCCSDTA_star
EOMCCSDTA_star(upstream, variant=None, **options)
Source description:
EOMCCSD(T)(a)* corrections (upstream: EOMCCSDTA or its left method).
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = True.variants = ('A', 'B', 'C', 'D').default_variant = 'A'.gradient_variants = ().module = 'ccpy.moments.eomccsdta_star'.function = 'calc_eomccsdta_star'.
EOMCCT3
EOMCCT3(upstream, num_active=1, two_body_approx=True, nacto=None, nactu=None, variant=None, **options)
Source description:
CC(t;3) corrections to EOMCCSDt excitation energies.
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = True.variants = ('A', 'B', 'C', 'D').default_variant = 'D'.gradient_variants = ().module = 'ccpy.moments.cct3'.function = 'calc_eomcct3'.
ExcitedStateCorrectionBase
ExcitedStateCorrectionBase(upstream, variant=None, **options)
Source description:
Corrections to EOMCC energies, from an upstream EOMCC or left-EOMCC method.
Defined in
ccpy.methods.corrections.Extension base; choose a concrete subclass for calculations.
Class-level
requires_df_port = False.variants = ('A', 'B', 'C', 'D').default_variant = 'D'.gradient_variants = ().Public members defined here:
build(),energy(root=None),raw_energy(root=None).
GroundStateCorrectionBase
GroundStateCorrectionBase(upstream, variant=None, nfrozen=None, ndelete=None, stochastic=None, **options)
Source description:
Correction to a ground-state CC energy built from T, HBar, and L.
Defined in
ccpy.methods.corrections.Extension base; choose a concrete subclass for calculations.
Class-level
requires_df_port = False.cc_class = CCSD.hbar_class = HBarCCSD.left_class = LeftCCSD.variants = ('A', 'B', 'C', 'D').default_variant = 'D'.supports_stochastic = False.gradient_variants = ().Public members defined here:
hbar(property),build(),energy(),raw_energy(),has_analytic_gradient(**kwargs).
IPCCP3
IPCCP3(upstream, variant=None, **options)
Source description:
IP-CC(P;3) corrections to IP-EOMCC(P).
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = True.variants = ('A', 'B', 'C', 'D').default_variant = 'D'.gradient_variants = ().module = 'ccpy.moments.ipccp3'.function = 'calc_ipccp3_full'.
IPEOMCCSDTA_star
IPEOMCCSDTA_star(upstream, variant=None, **options)
Defined in
ccpy.methods.corrections.Class-level
requires_df_port = True.variants = ('A', 'B', 'C', 'D').default_variant = 'A'.gradient_variants = ().module = 'ccpy.moments.ipeomccsdta_star'.function = 'calc_ipeomccsdta_star'.
Left ground and excited states
LeftCC3
LeftCC3(upstream, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.left.Class-level
requires_df_port = True.cc_class = CC3.hbar_class = HBarCC3.order = 2.module = 'ccpy.left.left_cc3'.
LeftCCBase
LeftCCBase(upstream, nfrozen=None, ndelete=None, **options)
Source description:
Base class of ground-state left-CC methods (scheme: left-CC).
Defined in
ccpy.methods.left.Extension base; choose a concrete subclass for calculations.
Class-level
requires_df_port = False.cc_class = CCSD.hbar_class = HBarCCSD.order = 2.Public members defined here:
hbar(property),solve(),energy(),raw_energy(),has_analytic_gradient(**kwargs).
LeftCCSD
LeftCCSD(upstream, nfrozen=None, ndelete=None, **options)
Source description:
Left-CCSD with DF/Cholesky integrals.
Defined in
ccpy.methods.left.Class-level
requires_df_port = False.cc_class = CCSD.hbar_class = HBarCCSD.order = 2.module = 'ccpy.left.left_ccsd_chol'.Public members defined here:
rdm1(),rdm2(),rdm2_vvvv_slice(a, spin).
LeftCCSDT
LeftCCSDT(upstream, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.left.Class-level
requires_df_port = True.cc_class = CCSDT.hbar_class = HBarCCSDT.order = 3.module = 'ccpy.left.left_ccsdt'.
LeftCCSDT_P
LeftCCSDT_P(upstream, nfrozen=None, ndelete=None, **options)
Source description:
Left-CCSDT(P) on top of CCSDT(P) (L3 has the excitations of T3).
Defined in
ccpy.methods.left.Class-level
requires_df_port = True.cc_class = CCSDT_P.hbar_class = HBarCCSDT_P.order = 3.module = 'ccpy.left.left_ccsdt_p'.
LeftEAEOM2
LeftEAEOM2(upstream, solver='davidson', **options)
Defined in
ccpy.methods.left.Class-level
requires_df_port = True.module = 'ccpy.left.left_eaeom2'.
LeftEAEOM3
LeftEAEOM3(upstream, solver='davidson', **options)
Defined in
ccpy.methods.left.Class-level
requires_df_port = True.module = 'ccpy.left.left_eaeom3'.
LeftEAEOM3_P
LeftEAEOM3_P(upstream, solver='davidson', **options)
Defined in
ccpy.methods.left.Class-level
requires_df_port = True.module = 'ccpy.left.left_eaeom3_p'.
LeftEOMCCBase
LeftEOMCCBase(upstream, solver='davidson', **options)
Source description:
Base class of left-EOMCC methods (scheme: left-EOMCC), built on a right EOMCC
method; each left vector is normalized so that <L|R> = 1.
Defined in
ccpy.methods.left.Extension base; choose a concrete subclass for calculations.
Class-level
requires_df_port = False.Public members defined here:
hbar(property),solve(),energy(root=None),raw_energy(root=None).
LeftEOMCCSD
LeftEOMCCSD(upstream, solver='davidson', **options)
Source description:
Left-EOMCCSD with DF/Cholesky integrals.
Defined in
ccpy.methods.left.Class-level
requires_df_port = False.module = 'ccpy.left.left_ccsd_chol'.
LeftEOMCCSDT
LeftEOMCCSDT(upstream, solver='davidson', **options)
Defined in
ccpy.methods.left.Class-level
requires_df_port = True.module = 'ccpy.left.left_ccsdt'.
LeftEOMCCSDTA
LeftEOMCCSDTA(upstream, solver='davidson', **options)
Defined in
ccpy.methods.left.Class-level
requires_df_port = True.module = 'ccpy.left.left_ccsd'.
LeftEOMCCSDT_P
LeftEOMCCSDT_P(upstream, solver='davidson', **options)
Defined in
ccpy.methods.left.Class-level
requires_df_port = True.module = 'ccpy.left.left_ccsdt_p'.
LeftIPEOM2
LeftIPEOM2(upstream, solver='davidson', **options)
Defined in
ccpy.methods.left.Class-level
requires_df_port = True.module = 'ccpy.left.left_ipeom2'.
LeftIPEOM3
LeftIPEOM3(upstream, solver='davidson', **options)
Defined in
ccpy.methods.left.Class-level
requires_df_port = True.module = 'ccpy.left.left_ipeom3'.
LeftIPEOM3_P
LeftIPEOM3_P(upstream, solver='davidson', **options)
Defined in
ccpy.methods.left.Class-level
requires_df_port = True.module = 'ccpy.left.left_ipeom3_p'.
Linear response
LRCCBase
LRCCBase(upstream, prop, nfrozen=None, ndelete=None, **options)
Source description:
Base class of LR-CC methods (scheme: linear response).
Defined in
ccpy.methods.lrcc.Extension base; choose a concrete subclass for calculations.
Class-level
requires_df_port = False.cc_class = CCSD.hbar_class = HBarCCSDLegacy.order = 2.Public members defined here:
hbar(property),solve(),property(),energy(),raw_energy().
LRCCSD
LRCCSD(upstream, prop, nfrozen=None, ndelete=None, **options)
Defined in
ccpy.methods.lrcc.Class-level
requires_df_port = True.cc_class = CCSD.hbar_class = HBarCCSDLegacy.order = 2.module = 'ccpy.lrcc.lrccsd'.
State-universal multireference coupled cluster
SUMRCCSD
SUMRCCSD(upstream, nact_electrons=None, nact_orbitals=None, nfrozen=None, ndelete=None, *, determinants=None, solver='auto', prune_intruders=None, **options)
Source description:
SU-MRCCSD (Jeziorski-Monkhorst) of RHF/ROHF orbitals in the complete model space
CAS(nact_electrons, nact_orbitals), with the active orbitals right above the core, or in a
general model space of given determinants (Li-Paldus C conditions on the internal amplitudes).
Defined in
ccpy.methods.mrcc.Class-level
requires_df_port = False.Public members defined here:
solve(),mmsucc23(root=None),raw_energy(root=None),energy(root=None).
SUMRCCSD1
SUMRCCSD1(upstream, nact_electrons=None, nact_orbitals=None, nfrozen=None, ndelete=None, *, determinants=None, solver='auto', prune_intruders=None, **options)
Source description:
SUMRCCSD(1): SU-MRCCSD with core->virtual t1 = 0 and core-core->virtual-virtual t2
fixed at their first-order MRMBPT values (Piecuch & Kowalski, IJMS 3, 676 (2002)).
Defined in
ccpy.methods.mrcc.Class-level
requires_df_port = False.
Similarity-transformed Hamiltonians
HBarBase
HBarBase(cc)
Source description:
HBar of the ground-state CC method ``cc`` (built from cc.T on ``build()``).
Defined in
ccpy.methods.hbar.Extension base; choose a concrete subclass for calculations.
Class-level
requires_df_port = False.Public members defined here:
reference(property),chol(property),correlation_energy(property),is_current(),build(),ensure_built().
HBarCC2
HBarCC2(cc)
Defined in
ccpy.methods.hbar.Class-level
requires_df_port = True.module = 'ccpy.hbar.hbar_cc2'.function = 'build_hbar_cc2'.
HBarCC3
HBarCC3(cc)
Source description:
CC3 HBar; also keeps the CCS-transformed intermediates used by EOM-CC3.
Defined in
ccpy.methods.hbar.Class-level
requires_df_port = True.module = 'ccpy.hbar.hbar_cc3'.function = 'build_hbar_cc3'.
HBarCCSD
HBarCCSD(cc)
Source description:
CCSD HBar from DF vectors (also used with T1 and T2 of higher-order methods).
Defined in
ccpy.methods.hbar.Class-level
requires_df_port = False.module = 'ccpy.hbar.hbar_ccsd_chol'.function = 'build_hbar_ccsd_chol'.
HBarCCSDLegacy
HBarCCSDLegacy(cc)
Defined in
ccpy.methods.hbar.Class-level
requires_df_port = True.module = 'ccpy.hbar.hbar_ccsd'.function = 'build_hbar_ccsd'.
HBarCCSDT
HBarCCSDT(cc)
Defined in
ccpy.methods.hbar.Class-level
requires_df_port = True.module = 'ccpy.hbar.hbar_ccsdt'.function = 'build_hbar_ccsdt'.
HBarCCSDT1
HBarCCSDT1(cc)
Defined in
ccpy.methods.hbar.Class-level
requires_df_port = True.module = 'ccpy.hbar.hbar_ccsdt1'.function = 'build_hbar_ccsdt1'.
HBarCCSDTA
HBarCCSDTA(cc)
Source description:
CCSD HBar augmented with the CCSD(T)(a) triples; this also produces new T (with T3)
and the CCSD(T)(a) correlation energy, kept on this object.
Defined in
ccpy.methods.hbar.Class-level
requires_df_port = True.module = 'ccpy.hbar.hbar_ccsdta'.function = 'build_hbar_ccsdta'.Public members defined here:
correlation_energy(property).
HBarCCSDT_P
HBarCCSDT_P(cc)
Source description:
HBar of CCSDT(P), including the V*T3 parts of the vooo and vvov blocks.
Defined in
ccpy.methods.hbar.Class-level
requires_df_port = True.module = 'ccpy.hbar.hbar_ccsdt_p'.function = 'build_hbar_ccsdt_p'.
References and materialization warnings
DFPortWarning
DFPortWarning(*args, **kwargs)
Source description:
Issued by methods whose equations still need four-index integrals (including vvvv),
which are then materialized from the DF vectors. These methods must be ported to DF.
Defined in
ccpy.methods.reference.
Reference
Reference(scf, nfrozen=0, ndelete=0)
Source description:
Converged SCF reference with its DF Hamiltonian.
Defined in
ccpy.methods.reference.Public members defined here:
from_orbital_transform(transforms, orbital_symmetries),one_body_from_ao(operator),one_body_operator_from_ao(operator),molecule(property),energy(property),with_molecule(molecule),legacy_hamiltonian(copy_=True).
Factorized Hamiltonian
DFHamiltonian
DFHamiltonian(system, fock_a, fock_b, B_a, B_b, lazy=True)
Source description:
Normal-ordered Hamiltonian H = F + V with V in factorized form.
Defined in
ccpy.methods.hamiltonian.order = 2.Public members defined here:
naux(property),copy().
FNO policies, evaluations and preparation
FNOEvaluation
FNOEvaluation(ground_energy: float, virtual_densities: dict = <factory>, state_energies: dict = <factory>, converged: bool = True, metadata: dict = <factory>, protected_subspaces: dict = <factory>) -> None
Source description:
Provider output in the input basis.
Defined in
ccpy.methods.fno.
FNOOptions
FNOOptions(source: str = 'mp2', occupation_cutoff: float | None = None, retained_population: float | None = None, nvirtuals: int | None = None, targets: tuple = (), weights: tuple = (), space_policy: str = 'average', energy_completion: str = 'ground', degeneracy_tolerance: float = 1e-08, density_tolerance: float = 1e-10, protected_virtuals: tuple = ()) -> None
Source description:
Immutable FNO policy. Specify at most one virtual selection criterion.
Defined in
ccpy.methods.fno.
FNOResult
FNOResult(options: ccpy.methods.fno.FNOOptions, full: ccpy.methods.fno.FNOEvaluation, truncated: ccpy.methods.fno.FNOEvaluation, transforms: dict, occupations: dict, retained_population: dict, discarded: dict) -> None
Source description:
FNOResult(options: ccpy.methods.fno.FNOOptions, full: ccpy.methods.fno.FNOEvaluation, truncated: ccpy.methods.fno.FNOEvaluation, transforms: dict, occupations: dict, retained_population: dict, discarded: dict)
Defined in
ccpy.methods.fno.Public members defined here:
delta_ground(property),delta_state(target).
FNOTarget
FNOTarget(sector: str, root: int = 0, irrep: str | None = None, multiplicity: int | None = None, formulation: str = 'folded') -> None
Source description:
Stable provider state identity; root labels are zero based within an irrep.
Defined in
ccpy.methods.fno.
Experimental cluster-in-molecule local correlation
CIM
CIM(method, upstream, nfrozen=None, ndelete=None, *, cim, fno=None, **kwargs)
Source description:
CIM energy of a ground-state method; created by passing ``cim=CIMOptions(...)`` to a
method, e.g. ``CCSD(mf, nfrozen=1, cim=CIMOptions())``.
Defined in
ccpy.methods.cim.Class-level
requires_df_port = False.Public members defined here:
at_geometry(molecule),has_analytic_gradient(**kwargs),energy(),raw_energy(),solve().
CIMDevelopmentWarning
CIMDevelopmentWarning(*args, **kwargs)
Source description:
Issued by every CIM calculation: CIM is under development, and its limited tests do not
establish general local-correlation accuracy or performance.
Defined in
ccpy.methods.cim.
CIMDomains
CIMDomains(subsystems: tuple, populations: numpy.ndarray) -> None
Source description:
Subsystems of one geometry, with the atomic Mulliken populations (nlmo, natoms) of its
LMOs used to identify the LMOs at other geometries.
Defined in
ccpy.methods.cim.
CIMOptions
CIMOptions(zeta: float = 0.003, central_charge: float = 0.3, domain_charge: float = 1.98, bond_tolerance: float = 0.168, eta: float = 0.5, buffer_radius: float = 4.0, levels: dict = <factory>, domains: 'CIMDomains' = None, localization_tol: float = 1e-12, localization_maxiter: int = 1000, verbose: bool = False) -> None
Source description:
CIM settings.
Defined in
ccpy.methods.cim.
Preparation and registry functions
prepare_fno
prepare_fno(reference, options)
Source description:
Build a fresh, ordinary reduced Reference. Never mutate the parent or SCF.
register_fno_provider
register_fno_provider(source, provider)
Source description:
Register e.g. ``register_fno_provider('adc2', evaluate_adc2)``.
Registration does not certify sector or density support. The provider must
raise NotImplementedError for unsupported sectors/reference/density types.
Register before constructing methods; prepared references retain their data.
methods_requiring_df_port
methods_requiring_df_port()
Source description:
Names of the methods (and HBars) whose equations still use four-index integrals.