GWR flow with convergence studies

This script shows how to compute the G0W0 corrections in silicon. More specifically, we build a flow to analyze the convergence of the QP corrections wrt to the number of bands in the self-energy. More complicated convergence studies can be implemented on the basis of this example.

Downloading repository from: https://github.com/PseudoDojo/ONCVPSP-PBE-PDv0.4/archive/refs/heads/master.zip ...
Installing ONCVPSP-PBE-SR-PDv0.4 in: /home/runner/.abinit/pseudos/ONCVPSP-PBE-SR-PDv0.4

0.00iB [00:00, ?iB/s]
716kiB [00:00, 6.44MiB/s]
1.47MiB [00:00, 3.71MiB/s]
2.83MiB [00:00, 6.62MiB/s]
3.70MiB [00:00, 5.46MiB/s]
5.21MiB [00:00, 6.91MiB/s]
6.18MiB [00:00, 7.23MiB/s]
7.03MiB [00:01, 7.43MiB/s]
7.86MiB [00:01, 6.07MiB/s]
8.56MiB [00:01, 6.19MiB/s]
9.74MiB [00:01, 7.53MiB/s]
10.6MiB [00:01, 7.09MiB/s]
11.5MiB [00:01, 7.16MiB/s]
12.3MiB [00:01, 6.73MiB/s]
13.0MiB [00:02, 6.25MiB/s]
13.7MiB [00:02, 5.98MiB/s]
14.5MiB [00:02, 5.72MiB/s]
15.8MiB [00:02, 7.19MiB/s]
16.6MiB [00:02, 7.31MiB/s]
17.4MiB [00:02, 6.89MiB/s]
18.2MiB [00:02, 6.69MiB/s]
19.0MiB [00:02, 6.95MiB/s]
19.8MiB [00:02, 7.08MiB/s]
20.6MiB [00:03, 7.05MiB/s]
21.3MiB [00:03, 6.99MiB/s]
22.1MiB [00:03, 7.16MiB/s]
22.8MiB [00:03, 6.63MiB/s]
23.7MiB [00:03, 7.01MiB/s]
24.4MiB [00:03, 6.32MiB/s]
25.5MiB [00:03, 6.76MiB/s]
26.2MiB [00:03, 6.51MiB/s]
27.1MiB [00:04, 6.89MiB/s]
28.0MiB [00:04, 6.85MiB/s]
28.7MiB [00:04, 6.97MiB/s]
29.4MiB [00:04, 6.76MiB/s]
30.2MiB [00:04, 6.54MiB/s]
30.9MiB [00:04, 6.15MiB/s]
31.5MiB [00:04, 5.99MiB/s]
32.3MiB [00:04, 6.19MiB/s]
33.0MiB [00:05, 6.18MiB/s]
34.1MiB [00:05, 7.20MiB/s]
34.9MiB [00:05, 7.16MiB/s]
35.6MiB [00:05, 6.78MiB/s]
36.5MiB [00:05, 7.08MiB/s]
37.2MiB [00:05, 6.95MiB/s]
38.1MiB [00:05, 7.09MiB/s]
38.9MiB [00:05, 7.23MiB/s]
39.6MiB [00:05, 6.92MiB/s]
40.4MiB [00:06, 7.02MiB/s]
41.3MiB [00:06, 6.51MiB/s]
41.9MiB [00:06, 5.30MiB/s]
42.9MiB [00:06, 5.32MiB/s]
44.2MiB [00:06, 6.17MiB/s]
45.0MiB [00:06, 6.35MiB/s]
46.4MiB [00:06, 7.58MiB/s]
47.2MiB [00:07, 7.47MiB/s]
48.0MiB [00:07, 7.34MiB/s]
48.7MiB [00:07, 7.20MiB/s]
49.5MiB [00:07, 7.03MiB/s]
50.3MiB [00:07, 6.91MiB/s]
51.1MiB [00:07, 6.33MiB/s]
51.8MiB [00:07, 5.46MiB/s]
52.8MiB [00:07, 6.18MiB/s]
54.0MiB [00:08, 7.54MiB/s]
54.8MiB [00:08, 7.37MiB/s]
55.6MiB [00:08, 7.17MiB/s]
56.4MiB [00:08, 6.76MiB/s]
57.3MiB [00:08, 6.61MiB/s]
58.2MiB [00:08, 6.74MiB/s]
59.0MiB [00:08, 7.01MiB/s]
59.7MiB [00:08, 6.92MiB/s]
60.5MiB [00:09, 7.13MiB/s]
61.3MiB [00:09, 5.88MiB/s]
62.2MiB [00:09, 5.82MiB/s]
63.1MiB [00:09, 5.90MiB/s]
64.1MiB [00:09, 6.73MiB/s]
64.9MiB [00:09, 6.60MiB/s]
65.7MiB [00:09, 6.93MiB/s]
66.5MiB [00:10, 6.23MiB/s]
67.4MiB [00:10, 6.24MiB/s]
68.3MiB [00:10, 6.26MiB/s]
69.3MiB [00:10, 5.04MiB/s]
71.0MiB [00:10, 7.33MiB/s]
72.1MiB [00:10, 7.93MiB/s]
73.0MiB [00:10, 7.73MiB/s]
73.9MiB [00:11, 7.21MiB/s]
74.8MiB [00:11, 6.95MiB/s]
75.6MiB [00:11, 6.27MiB/s]
76.6MiB [00:11, 6.82MiB/s]
77.5MiB [00:11, 6.80MiB/s]
78.4MiB [00:11, 6.10MiB/s]
79.2MiB [00:12, 4.29MiB/s]
81.4MiB [00:12, 6.60MiB/s]
82.5MiB [00:12, 5.16MiB/s]
84.7MiB [00:12, 7.28MiB/s]
85.6MiB [00:12, 6.50MiB/s]
86.8MiB [00:13, 6.22MiB/s]
88.4MiB [00:13, 7.73MiB/s]
89.4MiB [00:13, 7.83MiB/s]
90.4MiB [00:13, 7.59MiB/s]
91.3MiB [00:13, 6.82MiB/s]
92.2MiB [00:13, 6.86MiB/s]
92.9MiB [00:13, 6.82MiB/s]
93.6MiB [00:14, 6.56MiB/s]
94.4MiB [00:14, 5.97MiB/s]
95.5MiB [00:14, 6.66MiB/s]

Validating md5 checksums of ONCVPSP-PBE-SR-PDv0.4...
Checksum test: OK
Installation completed successfully in 16.15 [s]

import os
import sys
import abipy.data as data
import abipy.abilab as abilab

from abipy import flowtk
from abipy.flowtk.gwr_works import DirectDiagoWork, GWRSigmaConvWork


def build_flow(options):
    # Working directory (default is the name of the script with '.py' removed and "run_" replaced by "flow_")
    if not options.workdir:
        options.workdir = os.path.basename(sys.argv[0]).replace(".py", "").replace("run_","flow_")

    # IMPORTANT: Note stringent table to have semi-core states.
    from abipy.flowtk.psrepos import get_oncvpsp_pseudos
    pseudos = get_oncvpsp_pseudos(xc_name="PBE", version="0.4",
                                  relativity_type="SR", accuracy="stringent")

    scf_input = abilab.AbinitInput(structure=data.cif_file("si.cif"), pseudos=pseudos)

    num_ele = scf_input.num_valence_electrons

    # Global variables.
    scf_input.set_vars(
        ecut=6,
        nband=num_ele // 2,
        tolvrs=1e-8,
        paral_kgb=1,
    )

    # IMPORTANT: k-grid for GWR must be Gamma-centered.
    scf_input.set_kmesh(ngkpt=[2, 2, 2], shiftk=[0.0, 0.0, 0.0])

    flow = flowtk.Flow(workdir=options.workdir)

    # GS-SCF run to get the DEN, followed by direct diago to obtain green_nband bands.
    green_nband = -1  # -1 this means full diago
    diago_work = DirectDiagoWork.from_scf_input(scf_input, green_nband)
    flow.register_work(diago_work)

    # Build template for GWR.
    gwr_template = scf_input.make_gwr_qprange_input(gwr_ntau=6, nband=8, ecuteps=4, ecutwfn=2)

    # Two possibilities:
    # 1) To change the value of one variable, use:

    varname_values = ("nband", [8, 12, 14])

    # 2) To take the Cartesian product of two or more variables use e.g.:
    #
    #varname_values = [
    #   ("nband", [50, 100]),
    #   ("ecuteps", [2, 4]),
    #]

    # Can also use strings with path to files for den_node and wfk_node
    # so that one does not need to recompute these files.

    gwr_work = GWRSigmaConvWork.from_varname_values(
            varname_values,
            gwr_template,
            den_node=diago_work.scf_task,
            wfk_node=diago_work.diago_task,
    )
    flow.register_work(gwr_work)

    return flow


# This block generates the thumbnails in the AbiPy gallery.
# You can safely REMOVE this part if you are using this script for production runs.
if os.getenv("READTHEDOCS", False):
    __name__ = None
    import tempfile
    options = flowtk.build_flow_main_parser().parse_args(["-w", tempfile.mkdtemp()])
    build_flow(options).graphviz_imshow()


@flowtk.flow_main
def main(options):
    return build_flow(options)


if __name__ == "__main__":
    sys.exit(main())