Skip to content

Commit 912897f

Browse files
committed
incorporate feedback from @rkingsbury
1 parent d1f6f92 commit 912897f

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

pymatgen/entries/compatibility.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -826,12 +826,13 @@ class MaterialsProject2020Compatibility(Compatibility):
826826
Materials Project input set parameters (see pymatgen.io.vasp.sets.MPRelaxSet). Using
827827
this compatibility scheme on calculations with different parameters is not valid.
828828
829-
Note: While the correction scheme is largely composition-based, corrections applied to
830-
ComputedEntry and ComputedStructureEntry differ in rare cases. This is because if
831-
entry.data['oxidation_states'] is not set explicitly, the atomic distance information
832-
in the structure will be used to classify O and S anions as superoxide/peroxide/oxide
833-
and sulfide/polysulfide, resp. If you want the most accurate corrections possible,
834-
always pass ComputedStructureEntries (unless you have pre-defined oxidation states).
829+
Note: While the correction scheme is largely composition-based, the energy corrections
830+
applied to ComputedEntry and ComputedStructureEntry can differ for O and S-containing
831+
structures if entry.data['oxidation_states'] is not populated or explicitly set. This
832+
occurs because pymatgen will use atomic distances to classify O and S anions as
833+
superoxide/peroxide/oxide and sulfide/polysulfide, resp. when oxidation states are not
834+
provided. If you want the most accurate corrections possible, supply pre-defined
835+
oxidation states to entry.data or pass ComputedStructureEntry.
835836
"""
836837

837838
def __init__(

0 commit comments

Comments
 (0)