Complete methods API catalog ============================ .. This file is generated by generate_catalog.py; edit that script or the source API. 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 :doc:`ground`, :doc:`excited`, :doc:`guesses`, :doc:`spaces` and :doc:`properties`. A listed flag or inherited attribute is not a guarantee that every model/reference combination is implemented. Moller-Plesset perturbation theory ---------------------------------- .. _methods-class-mbptbase: MBPTBase ~~~~~~~~ .. code-block:: text 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()``. .. _methods-class-mp2: MP2 ~~~ .. code-block:: text 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()``. .. _methods-class-mp3: MP3 ~~~ .. code-block:: text MP3(upstream, nfrozen=None, ndelete=None, **options) * Defined in ``ccpy.methods.mbpt``. * Class-level ``requires_df_port = True``. * ``function = 'calc_mp3'``. .. _methods-class-mp4: MP4 ~~~ .. code-block:: text 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 ---------------------------- .. _methods-class-accbase: ACCBase ~~~~~~~ .. code-block:: text 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',)``. .. _methods-class-accd: ACCD ~~~~ .. code-block:: text 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'``. .. _methods-class-accsd: ACCSD ~~~~~ .. code-block:: text 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'``. .. _methods-class-accsdt_p: ACCSDT_P ~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-cc2: CC2 ~~~ .. code-block:: text 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'``. .. _methods-class-cc3: CC3 ~~~ .. code-block:: text 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'``. .. _methods-class-cc4: CC4 ~~~ .. code-block:: text 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()``. .. _methods-class-ccbase: CCBase ~~~~~~ .. code-block:: text 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()``. .. _methods-class-ccd: CCD ~~~ .. code-block:: text 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'``. .. _methods-class-ccpbase: CCPBase ~~~~~~~ .. code-block:: text 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)``. .. _methods-class-ccsd: CCSD ~~~~ .. code-block:: text 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'``. .. _methods-class-ccsdt: CCSDT ~~~~~ .. code-block:: text 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'``. .. _methods-class-ccsdtq: CCSDTQ ~~~~~~ .. code-block:: text 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'``. .. _methods-class-ccsdt_p: CCSDT_P ~~~~~~~ .. code-block:: text 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)``. .. _methods-class-eccc2: ECCC2 ~~~~~ .. code-block:: text 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 -------------------------- .. _methods-class-deaeom2: DEAEOM2 ~~~~~~~ .. code-block:: text 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'``. .. _methods-class-deaeom3: DEAEOM3 ~~~~~~~ .. code-block:: text 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'``. .. _methods-class-deaeom4: DEAEOM4 ~~~~~~~ .. code-block:: text 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'``. .. _methods-class-deaeom4_p: DEAEOM4_P ~~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-dipeom3: DIPEOM3 ~~~~~~~ .. code-block:: text 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'``. .. _methods-class-dipeom4: DIPEOM4 ~~~~~~~ .. code-block:: text 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'``. .. _methods-class-dipeomccsdt: DIPEOMCCSDT ~~~~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-dipeomccsdta: DIPEOMCCSDTA ~~~~~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-eaeom2: EAEOM2 ~~~~~~ .. code-block:: text 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'``. .. _methods-class-eaeom3: EAEOM3 ~~~~~~ .. code-block:: text 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'``. .. _methods-class-eaeom3_p: EAEOM3_P ~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-eaeomccsdt: EAEOMCCSDT ~~~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-eomcc2: EOMCC2 ~~~~~~ .. code-block:: text 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'``. .. _methods-class-eomcc3: EOMCC3 ~~~~~~ .. code-block:: text 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'``. .. _methods-class-eomccbase: EOMCCBase ~~~~~~~~~ .. code-block:: text 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). .. _methods-class-eomccsd: EOMCCSD ~~~~~~~ .. code-block:: text 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'``. .. _methods-class-eomccsdt: EOMCCSDT ~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-eomccsdta: EOMCCSDTA ~~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-eomccsdt_p: EOMCCSDT_P ~~~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-ipeom2: IPEOM2 ~~~~~~ .. code-block:: text 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'``. .. _methods-class-ipeom3: IPEOM3 ~~~~~~ .. code-block:: text 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'``. .. _methods-class-ipeom3_p: IPEOM3_P ~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-ipeomccsdt: IPEOMCCSDT ~~~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-ipeomccsdta: IPEOMCCSDTA ~~~~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-ipeomccsdt_p: IPEOMCCSDT_P ~~~~~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-sfeomcc23: SFEOMCC23 ~~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-sfeomccsd: SFEOMCCSD ~~~~~~~~~ .. code-block:: text 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 ----------------------------------- .. _methods-class-adc2: ADC2 ~~~~ .. code-block:: text 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)``. .. _methods-class-eaadc2: EAADC2 ~~~~~~ .. code-block:: text 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``. .. _methods-class-ipadc2: IPADC2 ~~~~~~ .. code-block:: text 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 ---------- .. _methods-class-steomcc: STEOMCC ~~~~~~~ .. code-block:: text 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 -------------- .. _methods-class-steomccsdt: STEOMCCSDT ~~~~~~~~~~ .. code-block:: text 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 ------------------------------------- .. _methods-class-adaptiveccpq: AdaptiveCCPQ ~~~~~~~~~~~~ .. code-block:: text 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()``. .. _methods-class-ccp3: CCP3 ~~~~ .. code-block:: text 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'``. .. _methods-class-ccp4: CCP4 ~~~~ .. code-block:: text 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'``. .. _methods-class-ccsdpt: CCSDpT ~~~~~~ .. code-block:: text 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'``. .. _methods-class-cct3: CCT3 ~~~~ .. code-block:: text 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'``. .. _methods-class-crcc23: CRCC23 ~~~~~~ .. code-block:: text 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'``. .. _methods-class-crcc24: CRCC24 ~~~~~~ .. code-block:: text 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'``. .. _methods-class-crcc34: CRCC34 ~~~~~~ .. code-block:: text 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'``. .. _methods-class-creacc23: CREACC23 ~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-creomcc23: CREOMCC23 ~~~~~~~~~ .. code-block:: text 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)``. .. _methods-class-cripcc23: CRIPCC23 ~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-correctionbase: CorrectionBase ~~~~~~~~~~~~~~ .. code-block:: text 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)``. .. _methods-class-dipeomccsdta_star: DIPEOMCCSDTA_star ~~~~~~~~~~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-eaccp3: EACCP3 ~~~~~~ .. code-block:: text 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'``. .. _methods-class-eaeomccsdta_star: EAEOMCCSDTA_star ~~~~~~~~~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-eomccp3: EOMCCP3 ~~~~~~~ .. code-block:: text 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'``. .. _methods-class-eomccsdta_star: EOMCCSDTA_star ~~~~~~~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-eomcct3: EOMCCT3 ~~~~~~~ .. code-block:: text 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'``. .. _methods-class-excitedstatecorrectionbase: ExcitedStateCorrectionBase ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: text 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)``. .. _methods-class-groundstatecorrectionbase: GroundStateCorrectionBase ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: text 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)``. .. _methods-class-ipccp3: IPCCP3 ~~~~~~ .. code-block:: text 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'``. .. _methods-class-ipeomccsdta_star: IPEOMCCSDTA_star ~~~~~~~~~~~~~~~~ .. code-block:: text 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 ------------------------------ .. _methods-class-leftcc3: LeftCC3 ~~~~~~~ .. code-block:: text 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'``. .. _methods-class-leftccbase: LeftCCBase ~~~~~~~~~~ .. code-block:: text 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)``. .. _methods-class-leftccsd: LeftCCSD ~~~~~~~~ .. code-block:: text 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)``. .. _methods-class-leftccsdt: LeftCCSDT ~~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-leftccsdt_p: LeftCCSDT_P ~~~~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-lefteaeom2: LeftEAEOM2 ~~~~~~~~~~ .. code-block:: text LeftEAEOM2(upstream, solver='davidson', **options) * Defined in ``ccpy.methods.left``. * Class-level ``requires_df_port = True``. * ``module = 'ccpy.left.left_eaeom2'``. .. _methods-class-lefteaeom3: LeftEAEOM3 ~~~~~~~~~~ .. code-block:: text LeftEAEOM3(upstream, solver='davidson', **options) * Defined in ``ccpy.methods.left``. * Class-level ``requires_df_port = True``. * ``module = 'ccpy.left.left_eaeom3'``. .. _methods-class-lefteaeom3_p: LeftEAEOM3_P ~~~~~~~~~~~~ .. code-block:: text LeftEAEOM3_P(upstream, solver='davidson', **options) * Defined in ``ccpy.methods.left``. * Class-level ``requires_df_port = True``. * ``module = 'ccpy.left.left_eaeom3_p'``. .. _methods-class-lefteomccbase: LeftEOMCCBase ~~~~~~~~~~~~~ .. code-block:: text 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 = 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)``. .. _methods-class-lefteomccsd: LeftEOMCCSD ~~~~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-lefteomccsdt: LeftEOMCCSDT ~~~~~~~~~~~~ .. code-block:: text LeftEOMCCSDT(upstream, solver='davidson', **options) * Defined in ``ccpy.methods.left``. * Class-level ``requires_df_port = True``. * ``module = 'ccpy.left.left_ccsdt'``. .. _methods-class-lefteomccsdta: LeftEOMCCSDTA ~~~~~~~~~~~~~ .. code-block:: text LeftEOMCCSDTA(upstream, solver='davidson', **options) * Defined in ``ccpy.methods.left``. * Class-level ``requires_df_port = True``. * ``module = 'ccpy.left.left_ccsd'``. .. _methods-class-lefteomccsdt_p: LeftEOMCCSDT_P ~~~~~~~~~~~~~~ .. code-block:: text LeftEOMCCSDT_P(upstream, solver='davidson', **options) * Defined in ``ccpy.methods.left``. * Class-level ``requires_df_port = True``. * ``module = 'ccpy.left.left_ccsdt_p'``. .. _methods-class-leftipeom2: LeftIPEOM2 ~~~~~~~~~~ .. code-block:: text LeftIPEOM2(upstream, solver='davidson', **options) * Defined in ``ccpy.methods.left``. * Class-level ``requires_df_port = True``. * ``module = 'ccpy.left.left_ipeom2'``. .. _methods-class-leftipeom3: LeftIPEOM3 ~~~~~~~~~~ .. code-block:: text LeftIPEOM3(upstream, solver='davidson', **options) * Defined in ``ccpy.methods.left``. * Class-level ``requires_df_port = True``. * ``module = 'ccpy.left.left_ipeom3'``. .. _methods-class-leftipeom3_p: LeftIPEOM3_P ~~~~~~~~~~~~ .. code-block:: text 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 --------------- .. _methods-class-lrccbase: LRCCBase ~~~~~~~~ .. code-block:: text 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()``. .. _methods-class-lrccsd: LRCCSD ~~~~~~ .. code-block:: text 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 ---------------------------------------------- .. _methods-class-sumrccsd: SUMRCCSD ~~~~~~~~ .. code-block:: text 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)``. .. _methods-class-sumrccsd1: SUMRCCSD1 ~~~~~~~~~ .. code-block:: text 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 ----------------------------------- .. _methods-class-hbarbase: HBarBase ~~~~~~~~ .. code-block:: text 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()``. .. _methods-class-hbarcc2: HBarCC2 ~~~~~~~ .. code-block:: text HBarCC2(cc) * Defined in ``ccpy.methods.hbar``. * Class-level ``requires_df_port = True``. * ``module = 'ccpy.hbar.hbar_cc2'``. * ``function = 'build_hbar_cc2'``. .. _methods-class-hbarcc3: HBarCC3 ~~~~~~~ .. code-block:: text 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'``. .. _methods-class-hbarccsd: HBarCCSD ~~~~~~~~ .. code-block:: text 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'``. .. _methods-class-hbarccsdlegacy: HBarCCSDLegacy ~~~~~~~~~~~~~~ .. code-block:: text HBarCCSDLegacy(cc) * Defined in ``ccpy.methods.hbar``. * Class-level ``requires_df_port = True``. * ``module = 'ccpy.hbar.hbar_ccsd'``. * ``function = 'build_hbar_ccsd'``. .. _methods-class-hbarccsdt: HBarCCSDT ~~~~~~~~~ .. code-block:: text HBarCCSDT(cc) * Defined in ``ccpy.methods.hbar``. * Class-level ``requires_df_port = True``. * ``module = 'ccpy.hbar.hbar_ccsdt'``. * ``function = 'build_hbar_ccsdt'``. .. _methods-class-hbarccsdt1: HBarCCSDT1 ~~~~~~~~~~ .. code-block:: text HBarCCSDT1(cc) * Defined in ``ccpy.methods.hbar``. * Class-level ``requires_df_port = True``. * ``module = 'ccpy.hbar.hbar_ccsdt1'``. * ``function = 'build_hbar_ccsdt1'``. .. _methods-class-hbarccsdta: HBarCCSDTA ~~~~~~~~~~ .. code-block:: text 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). .. _methods-class-hbarccsdt_p: HBarCCSDT_P ~~~~~~~~~~~ .. code-block:: text 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 --------------------------------------- .. _methods-class-dfportwarning: DFPortWarning ~~~~~~~~~~~~~ .. code-block:: text 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``. .. _methods-class-reference: Reference ~~~~~~~~~ .. code-block:: text 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 ---------------------- .. _methods-class-dfhamiltonian: DFHamiltonian ~~~~~~~~~~~~~ .. code-block:: text 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 ----------------------------------------- .. _methods-class-fnoevaluation: FNOEvaluation ~~~~~~~~~~~~~ .. code-block:: text FNOEvaluation(ground_energy: float, virtual_densities: dict = , state_energies: dict = , converged: bool = True, metadata: dict = , protected_subspaces: dict = ) -> None Source description:: Provider output in the input basis. * Defined in ``ccpy.methods.fno``. .. _methods-class-fnooptions: FNOOptions ~~~~~~~~~~ .. code-block:: text 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``. .. _methods-class-fnoresult: FNOResult ~~~~~~~~~ .. code-block:: text 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)``. .. _methods-class-fnotarget: FNOTarget ~~~~~~~~~ .. code-block:: text 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 -------------------------------------------------- .. _methods-class-cim: CIM ~~~ .. code-block:: text 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()``. .. _methods-class-cimdevelopmentwarning: CIMDevelopmentWarning ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: text 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``. .. _methods-class-cimdomains: CIMDomains ~~~~~~~~~~ .. code-block:: text 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``. .. _methods-class-cimoptions: CIMOptions ~~~~~~~~~~ .. code-block:: text 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 = , 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``. Shared method protocol ---------------------- .. _methods-class-methodbase: MethodBase ~~~~~~~~~~ .. code-block:: text MethodBase(upstream, nfrozen=None, ndelete=None, *, fno=None, fno_targets=None, cim=None, **options) Source description:: Base class of all methods. * Defined in ``ccpy.methods.base``. * Extension base; choose a concrete subclass for calculations. * Class-level ``requires_df_port = False``. * Public members defined here: ``system`` (property), ``molecule`` (property), ``reference_energy`` (property), ``fno_result`` (property), ``fno_options`` (property), ``solve()``, ``energy()``, ``raw_energy()``, ``ensure_solved()``, ``is_current()``, ``gradient(perturbation=None, properties=None, **kwargs)``, ``multipole_moments(order=1, origin=None, **kwargs)``, ``gradient_and_dipole(**kwargs)``, ``energy_and_gradient(**kwargs)``, ``has_analytic_gradient(**kwargs)``, ``fd_gradient(**kwargs)``, ``at_geometry(molecule)``. Preparation and registry functions ---------------------------------- prepare_fno ~~~~~~~~~~~ .. code-block:: text prepare_fno(reference, options) Source description:: Build a fresh, ordinary reduced Reference. Never mutate the parent or SCF. register_fno_provider ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: text 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 ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: text methods_requiring_df_port() Source description:: Names of the methods (and HBars) whose equations still use four-index integrals.