Skip to content

Commit e84dcc0

Browse files
try to fix mystery unicode errors
1 parent 2762399 commit e84dcc0

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Rationale
4444

4545
| **Parameter** | **Reason** |
4646
| ---- | ---- |
47-
| ADDGRID | ADDGRID must be set to False. MP uses ADDGRID = False, as the VASP manual states please do not use this tag [ADDGRID] as default in all your calculations!. ADDGRID can affect the outputted forces, hence all calculations are thus required to have ADDGRID = False for compatibility. |
47+
| ADDGRID | ADDGRID must be set to False. MP uses ADDGRID = False, as the VASP manual states "please do not use this tag [ADDGRID] as default in all your calculations!". ADDGRID can affect the outputted forces, hence all calculations are thus required to have ADDGRID = False for compatibility. |
4848
| AEXX / AMGGAX / AMGGAC / AGGAX / ALDAC / ALDAX | These parameters should be the VASP defaults unless otherwise specified in a given MP input set, as changing them is effectively a change to the level of theory. |
4949
| ALGO / IALGO | ALGO must be one of: "Normal", "Conjugate", "All", "Fast", "Exact". (This corresponds to an IALGO of 38, 58, 58, 68, 90, respectively). |
5050
| DEPER / EBREAK / WEIMIN | DEPER, EBREAK, and WEIMIN should not be changed according to the VASP wiki, hence MP requires them to remain as their default values. |
@@ -89,15 +89,15 @@ Rationale
8989
| LHYPERFINE | LHYPERFINE must be set to False (the VASP default). |
9090
| LKPROJ | LKPROJ must be set to False (the VASP default). |
9191
| LKPOINTS_OPT | LKPOINTS_OPT must be set to False. |
92-
| LMAXPAW | LMAXPAW must remain unspecified, as the VASP wiki states that Energies should be evaluated with the default setting for LMAXPAW. |
93-
| LMAXMIX | LMAXMIX must be set to 6. This is based on tests from Aaron Kaplan (@esoteric-ephemera) — see the bench_vasp_pars.docx document in https://github.com/materialsproject/pymatgen/issues/3322. |
92+
| LMAXPAW | LMAXPAW must remain unspecified, as the VASP wiki states that "Energies should be evaluated with the default setting for LMAXPAW". |
93+
| LMAXMIX | LMAXMIX must be set to 6. This is based on tests from Aaron Kaplan (@esoteric-ephemera) — see the "bench_vasp_pars.docx" document in https://github.com/materialsproject/pymatgen/issues/3322. |
9494
| LMAXTAU | LMAXTAU must be set to 6 (the VASP default when using LASPH = True). |
9595
| LMP2LT / LSMP2LT | Both must be set to False (VASP defaults) |
9696
| LNONCOLLINEAR / LSORBIT | Both must be set to False (VASP defaults) |
9797
| LOCPROJ | LOCPROJ must be set to None (the VASP default). |
9898
| LOPTICS | LOPTICS must be set to False (the VASP default), unless explicitly specified by the relevant MP input set. |
9999
| LORBIT | LORBIT must **<u>*not*</u>** be None if the user also sets ISPIN=2, otherwise all values of LORBIT are acceptable. This is due to magnetization values not being output when ISPIN=2 and LORBIT = None are set together. |
100-
| LREAL | If the LREAL in the relevant MP input set is Auto, then the user must be one of: "Auto", False. Otherwise, if the LREAL in the relevant MP input set is False, then the user must use False. |
100+
| LREAL | If the LREAL in the relevant MP input set is "Auto", then the user must be one of: "Auto", False. Otherwise, if the LREAL in the relevant MP input set is False, then the user must use False. |
101101
| LRPA | LRPA must be set to False (the VASP default). MP does not currently support random phase approximation (RPA) calculations. |
102102
| LSPECTRAL | LSPECTRAL must be set to False (the VASP default for most calculations). |
103103
| LSUBROT | LSUBROT must be set to False (the VASP default). |

pymatgen/io/validation/settings.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ def load_default_settings(cls, values):
125125
if config_file_path.startswith("http"):
126126
new_values = requests.get(config_file_path).json()
127127
elif Path(config_file_path).exists():
128-
with open(config_file_path) as f:
128+
with open(config_file_path, encoding="utf8") as f:
129129
new_values = json.load(f)
130130

131131
new_values.update(values)

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
url="https://github.com/materialsproject/pymatgen-io-validation",
3030
license="BSD",
3131
description="A comprehensive I/O validator for electronic structure calculations",
32-
long_description=open("README.md").read(),
32+
long_description=open("README.md", encoding="utf8").read(),
3333
long_description_content_type="text/markdown",
3434
keywords=["pymatgen"],
3535
classifiers=[

0 commit comments

Comments
 (0)