Skip to content

Commit

Permalink
Add typing_extensions requirement to temporarily fix pymatgen iss…
Browse files Browse the repository at this point in the history
…ue until its next release (see materialsproject/pymatgen-analysis-defects#188)
  • Loading branch information
kavanase committed May 11, 2024
1 parent 5c7ebc2 commit 1abae08
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/Dev_ToDo.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@
there's any useful functionality we want to add!

## SK To-Do for next update:
- Remove `typing-extensions` requirement from `pyproject.toml`, once new `pymatgen-analysis-defects` released.
- `doped` repo/docs cleanup `TODO`s above
- Quick-start tutorial suggested by Alex G
- Add chempot grid plotting tool, shown in `JOSS_plots` using Alex's chemical potential grid, and test (and remove TODO from JOSS plots notebook).
Expand Down
2 changes: 1 addition & 1 deletion docs/Troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ message about the origin of the problem, it is likely to be an issue with your v

.. code:: bash
pip install pymatgen --upgrade
pip install pymatgen pymatgen-analysis-defects --upgrade
pip install doped --upgrade
If this does not solve your issue, please check the specific cases noted below. If your issue still isn't
Expand Down
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ dependencies = [
"vise>=0.9.0", # for eigenvalue analysis, >=0.9.0 required for SOC compatibility
"easyunfold>=0.3.6", # for efficient PROCAR parsing (and supporting SOC),
# if any dependency issues arise can make easyunfold an optional dependency
"typing-extensions" # to fix `pymatgen` typing issues
# (https://github.com/materialsproject/pymatgen-analysis-defects/pull/188)
# TODO: Remove once new pymatgen-analysis-defects released
]

[project.urls]
Expand Down
4 changes: 2 additions & 2 deletions tests/test_generation.py
Original file line number Diff line number Diff line change
Expand Up @@ -1975,7 +1975,7 @@ def CdTe_defect_gen_check(self, CdTe_defect_gen, generate_supercell=True):
atol=1e-3,
)

def test_defects_generator_cdte(self):
def test_defects_generator_CdTe(self):
CdTe_defect_gen, output = self._generate_and_test_no_warnings(self.prim_cdte)

assert self.CdTe_defect_gen_info in output # matches expected 4b & 4d Wyckoff letters for Td
Expand Down Expand Up @@ -2902,7 +2902,7 @@ def cd_i_CdTe_supercell_defect_gen_check(self, cd_i_defect_gen):
atol=1e-3,
)

def test_supercell_w_defect_cd_i_cdte(self):
def test_supercell_w_defect_cd_i_CdTe(self):
if not self.heavy_tests:
return

Expand Down

0 comments on commit 1abae08

Please sign in to comment.