qp2/src
Kevin Gasperich ed8b20ba0c provider for off-diagonal selection weights 2020-09-14 13:02:57 -05:00
..
ao_basis Merge remote-tracking branch 'origin/dev' into features_kpts 2020-08-07 16:53:22 -05:00
ao_one_e_ints testing for real kpts; not clean 2020-07-13 18:24:37 -05:00
ao_two_e_erf_ints Fixed compile error in previous commit 2020-05-12 19:10:12 +02:00
ao_two_e_ints placeholder to prevent warning about out values not assigned 2020-07-01 13:06:24 -05:00
aux_quantities added the definition of the input density in the AO basis 2019-04-09 00:10:01 +02:00
basis_correction minor modifs on basis correction 2020-05-19 11:46:29 +02:00
becke_numerical_grid added all the angular integration grid 2020-06-27 13:31:29 +02:00
bitmask CIS kpts 2020-07-02 10:48:20 -05:00
cas_based_on_top removed spurious dependency 2020-04-29 15:11:48 +02:00
casscf added the possibility to use no_vvvv integrals from EZFIO 2020-05-11 16:04:16 +02:00
cipsi provider for off-diagonal selection weights 2020-09-14 13:02:57 -05:00
cis cis kpts fix 2020-07-02 12:12:29 -05:00
cisd fix kpt range and remove printing in cisd 2020-07-06 16:10:44 -05:00
davidson resolved merge conflicts 2020-09-01 11:43:27 -05:00
davidson_dressed Initial commit 2019-01-25 11:39:31 +01:00
davidson_undressed Initial commit 2019-01-25 11:39:31 +01:00
density_for_dft beginning the cleaning of two_body_rdm 2020-03-18 15:13:49 +01:00
determinants clean dev merge 2020-09-11 10:39:58 -05:00
dft_keywords removed small bug 2020-03-30 19:30:29 +02:00
dft_one_e fixed the ao effective potential in DFT 2020-06-08 14:47:19 +02:00
dft_utils_func fixed bug in g0_UEG_mu_inf, src/dft_utils_func/on_top_from_ueg.irp.f 2020-06-08 15:17:53 +02:00
dft_utils_in_r parallel sections for dft_utils_in_r 2020-04-05 13:58:17 +02:00
dressing Initial commit 2019-01-25 11:39:31 +01:00
dummy beginning to reorganise stuffs 2020-04-07 12:19:17 +02:00
electrons Initial commit 2019-01-25 11:39:31 +01:00
ezfio_files Increased size of strings 2020-05-15 14:53:55 +02:00
fci clean dev merge 2020-09-11 10:39:58 -05:00
functionals beginning to reorganise stuffs 2020-04-07 12:19:17 +02:00
generators_cas Fixed compilation problems 2020-03-05 15:53:45 +01:00
generators_full started complex h_apply 2020-02-25 09:11:16 -06:00
hartree_fock clean dev merge 2020-09-11 10:39:58 -05:00
iterations clean dev merge 2020-09-11 10:39:58 -05:00
kohn_sham Introduced screening.irp.f 2020-05-12 18:48:51 +02:00
kohn_sham_rs Introduced screening.irp.f 2020-05-12 18:48:51 +02:00
mo_basis testing for real kpts; not clean 2020-07-13 18:24:37 -05:00
mo_guess fixed (unused?) complex lowdin coef 2020-07-29 14:10:05 -05:00
mo_one_e_ints testing for real kpts; not clean 2020-07-13 18:24:37 -05:00
mo_two_e_erf_ints Initial commit 2019-01-25 11:39:31 +01:00
mo_two_e_ints resolved dev kpts merge 2020-06-16 10:38:27 -05:00
mpi complex zmq determinants 2020-02-24 16:36:56 -06:00
mu_of_r added function to compute mu(r) for a cas wave function in a given point in space 2020-04-23 11:13:05 +02:00
nuclei resolved dev kpts merge 2020-06-16 10:38:27 -05:00
perturbation First python3 3 working installation 2020-03-17 18:02:29 +01:00
pseudo Initial commit 2019-01-25 11:39:31 +01:00
psiref_cas Initial commit 2019-01-25 11:39:31 +01:00
psiref_utils Initial commit 2019-01-25 11:39:31 +01:00
scf_utils clean dev merge 2020-09-11 10:39:58 -05:00
selectors_cassd Warnings in documentation 2019-01-29 17:09:08 +01:00
selectors_full working on complex cipsi 2020-02-26 17:01:41 -06:00
selectors_utils working on complex cipsi 2020-02-26 17:01:41 -06:00
single_ref_method Fixed compilation problems 2020-03-05 15:53:45 +01:00
tools clean dev merge 2020-09-11 10:39:58 -05:00
two_body_rdm added two_body_dens_rout.irp.f 2020-04-27 11:31:24 +02:00
two_rdm_routines minor modifs 2020-04-21 15:08:10 +02:00
utils testing for real kpts; not clean 2020-07-13 18:24:37 -05:00
utils_complex pyscf converter for molecules 2020-07-29 11:38:55 -05:00
zmq clean dev merge 2020-09-11 10:39:58 -05:00
README.rst renaming in functionals/sr_pbe.irp.f 2020-04-02 16:24:33 +02:00

README.rst

==========================
The core modules of the QP
==========================

*** How are handled the DFT functionals in QP2 ?
================================================
    The Exchange and Correlation energies/potentials can be accessed by the following providers 
    energy_x
    energy_c
    potential_x_alpha_ao
    potential_c_alpha_ao
    potential_x_beta_ao
    potential_c_beta_ao

    These providers are automatically linked to the providers of the actual exchange/correlation energies of a given functional 
    through the character keywords 
    "exchange_functional"
    "correlation_functional"

    All the providers for the available functionals are in the folder "functionals", with one file "my_functional.irp.f" per functional.  

    Ex : if "exchange_functional" == "sr_pbe", then energy_x will contain the exchange correlation functional defined in "functiona/sr_pbe.irp.f", which corresponds to the short-range PBE functional (at the value mu_erf for the range separation parameter) 


*** How to add a new functional in QP2 
======================================

    Creating a new functional and propagating it through the whole QP2 programs is easy as all dependencies are handled by a script. 

    To do so, let us assume that the name of your functional is "my_func". 
    Then you just have to create the file "my_func.irp.f" in the folder "functional" which shoud contain 

    +) if you're adding an exchange functional, then create the provider "energy_x_my_func" 

    +) if you're adding a correlation functional, create the provider "energy_c_my_func" 
    
    +) if you want to add the echange potentials, create the providers "potential_x_alpha_ao_my_func", "potential_x_beta_ao_my_func"  which are the exchange potentials on the AO basis for the alpha/beta electrons 

    +) if you want to add the correlation potentials, create the providers "potential_c_alpha_ao_my_func", "potential_c_beta_ao_my_func"  which are the correlation potentials on the AO basis for the alpha/beta electrons 
    
    That's all :) 
   
    Then, when running whatever DFT calculation or accessing/using the providers: 
    energy_x
    energy_c
    potential_x_alpha_ao
    potential_c_alpha_ao
    potential_x_beta_ao
    potential_c_beta_ao
 
    if exchange_functional = mu_func, then you will automatically have access to what you need, such as kohn sham orbital optimization and so on ...