Add capability for Vasprun to read KPOINTS_OPT data

tests/apps/borg/test_queen.py

@@ -22,7 +22,7 @@ def test_get_data(self):
         drone = VaspToComputedEntryDrone()
         self.queen = BorgQueen(drone, TEST_FILES_DIR, 1)
         data = self.queen.get_data()
-        assert len(data) == 15
+        assert len(data) == 16
 
     def test_load_data(self):
         drone = VaspToComputedEntryDrone()

tests/files/kpoints_opt/KPOINTS

@@ -0,0 +1,4 @@
+Fully automatic kpoint scheme
+0
+Automatic
+25

tests/files/kpoints_opt/KPOINTS_OPT

@@ -0,0 +1,34 @@
+Line_mode KPOINTS file
+10
+Line_mode
+Reciprocal
+0.0 0.0 0.0 ! \Gamma
+0.5 0.0 0.5 ! X
+
+0.5 0.0 0.5 ! X
+0.5 0.25 0.75 ! W
+
+0.5 0.25 0.75 ! W
+0.375 0.375 0.75 ! K
+
+0.375 0.375 0.75 ! K
+0.0 0.0 0.0 ! \Gamma
+
+0.0 0.0 0.0 ! \Gamma
+0.5 0.5 0.5 ! L
+
+0.5 0.5 0.5 ! L
+0.625 0.25 0.625 ! U
+
+0.625 0.25 0.625 ! U
+0.5 0.25 0.75 ! W
+
+0.5 0.25 0.75 ! W
+0.5 0.5 0.5 ! L
+
+0.5 0.5 0.5 ! L
+0.375 0.375 0.75 ! K
+
+0.625 0.25 0.625 ! U
+0.5 0.0 0.5 ! X
+

tests/io/vasp/test_outputs.py

@@ -18,6 +18,7 @@
 from pymatgen.core import Element
 from pymatgen.core.lattice import Lattice
 from pymatgen.core.structure import Structure
+from pymatgen.electronic_structure.bandstructure import BandStructureSymmLine
 from pymatgen.electronic_structure.core import Magmom, Orbital, OrbitalType, Spin
 from pymatgen.entries.compatibility import MaterialsProjectCompatibility
 from pymatgen.io.vasp.inputs import Kpoints, Poscar, Potcar
@@ -705,6 +706,54 @@ def test_eigenvalue_band_properties_separate_spins(self):
         assert props[3][0]
         assert props[3][1]
 
+    def test_kpoints_opt(self):
+        vasp_run = Vasprun(f"{TEST_FILES_DIR}/kpoints_opt/vasprun.xml.gz", parse_projected_eigen=True)
+        # This calculation was run using KPOINTS_OPT
+        # Check the k-points were read correctly.
+        assert len(vasp_run.actual_kpoints) == 10
+        assert len(vasp_run.actual_kpoints_weights) == 10
+        assert len(vasp_run.actual_kpoints_opt) == 100
+        assert len(vasp_run.actual_kpoints_weights_opt) == 100
+        # Check the eigenvalues were read correctly.
+        assert vasp_run.eigenvalues[Spin.up].shape == (10, 128, 2)
+        assert vasp_run.eigenvalues_kpoints_opt[Spin.up].shape == (100, 128, 2)
+        assert vasp_run.eigenvalues[Spin.up][0, 0, 0] == approx(-6.1134)
+        assert vasp_run.eigenvalues_kpoints_opt[Spin.up][0, 0, 0] == approx(-6.1522)
+        # Check the projected eigenvalues were read correctly
+        assert vasp_run.projected_eigenvalues[Spin.up].shape == (10, 128, 8, 9)
+        assert vasp_run.projected_eigenvalues_kpoints_opt[Spin.up].shape == (100, 128, 8, 9)
+        assert vasp_run.projected_eigenvalues[Spin.up][0, 1, 0, 0] == approx(0.0704)
+        assert vasp_run.projected_eigenvalues_kpoints_opt[Spin.up][0, 1, 0, 0] == approx(0.0000)
+        # I think these zeroes are a bug in VASP (maybe my VASP) transcribing from PROCAR_OPT to vasprun.xml
+        # Test as_dict
+        d = vasp_run.as_dict()
+        assert d["input"]["nkpoints_opt"] == 100
+        assert d["input"]["nkpoints"] == 10
+        assert d["output"]["eigenvalues_kpoints_opt"]["1"][0][0][0] == approx(-6.1522)
+
+    def test_kpoints_opt_band_structure(self):
+        vasp_run = Vasprun(
+            f"{TEST_FILES_DIR}/kpoints_opt/vasprun.xml.gz", parse_potcar_file=False, parse_projected_eigen=True
+        )
+        bs = vasp_run.get_band_structure(f"{TEST_FILES_DIR}/kpoints_opt/KPOINTS_OPT")
+        assert isinstance(bs, BandStructureSymmLine)
+        cbm = bs.get_cbm()
+        vbm = bs.get_vbm()
+        assert cbm["kpoint_index"] == [38], "wrong cbm kpoint index"
+        assert cbm["energy"] == approx(6.4363), "wrong cbm energy"
+        assert cbm["band_index"] == {Spin.up: [16], Spin.down: []}, "wrong cbm bands"
+        # Strangely, when I call with parse_projected_eigen, it gives empty Spin.down,
+        # but without parse_projected_eigen it does not give it.
+        # So at one point it called the empty key.
+        assert vbm["kpoint_index"] == [0, 39, 40]
+        assert vbm["energy"] == approx(5.7655), "wrong vbm energy"
+        assert vbm["band_index"] == {Spin.down: [13, 14, 15], Spin.up: []}, "wrong vbm bands"
+        assert vbm["kpoint"].label == "\\Gamma", "wrong vbm label"
+        assert cbm["kpoint"].label is None, "wrong cbm label"
+        # Test projection
+        projected = bs.get_projection_on_elements()
+        assert projected[Spin.up][0][0]["Si"] == approx(0.2126)
+
 
 class TestOutcar(PymatgenTest):
     def test_init(self):
@@ -1304,6 +1353,32 @@ def test_get_band_structure(self):
         d = vasprun.as_dict()
         assert "eigenvalues" in d["output"]
 
+    def test_kpoints_opt(self):
+        vasp_run = BSVasprun(
+            f"{TEST_FILES_DIR}/kpoints_opt/vasprun.xml.gz", parse_potcar_file=False, parse_projected_eigen=True
+        )
+        bs = vasp_run.get_band_structure(f"{TEST_FILES_DIR}/kpoints_opt/KPOINTS_OPT")
+        assert isinstance(bs, BandStructureSymmLine)
+        cbm = bs.get_cbm()
+        vbm = bs.get_vbm()
+        assert cbm["kpoint_index"] == [38], "wrong cbm kpoint index"
+        assert cbm["energy"] == approx(6.4363), "wrong cbm energy"
+        assert cbm["band_index"] == {Spin.up: [16], Spin.down: []}, "wrong cbm bands"
+        # Strangely, when I call with parse_projected_eigen, it gives empty Spin.down,
+        # but without parse_projected_eigen it does not give it.
+        # So at one point it called the empty key.
+        assert vbm["kpoint_index"] == [0, 39, 40]
+        assert vbm["energy"] == approx(5.7655), "wrong vbm energy"
+        assert vbm["band_index"] == {Spin.down: [13, 14, 15], Spin.up: []}, "wrong vbm bands"
+        assert vbm["kpoint"].label == "\\Gamma", "wrong vbm label"
+        assert cbm["kpoint"].label is None, "wrong cbm label"
+        # Test projection
+        projected = bs.get_projection_on_elements()
+        assert projected[Spin.up][0][0]["Si"] == approx(0.2126)
+        d = vasp_run.as_dict()
+        assert "eigenvalues" in d["output"]
+        assert "eigenvalues_kpoints_opt" in d["output"]
+
 
 class TestOszicar(PymatgenTest):
     def test_init(self):