Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve types for electronic_structure.{bandstructure/cohp} #3873

Merged
merged 63 commits into from
Aug 3, 2024
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
63 commits
Select commit Hold shift + click to select a range
2a55e45
add types for bandstructure
DanielYang59 Jun 10, 2024
6444064
Merge branch 'master' into type-elec-struct
DanielYang59 Jun 10, 2024
1cd0037
relocate magic methods to top
DanielYang59 Jun 10, 2024
79e8868
add some types
DanielYang59 Jun 10, 2024
d00912c
Merge branch 'type-elec-struct' of https://github.com/DanielYang59/py…
DanielYang59 Jun 10, 2024
8a4c4b5
fix type errors in bandstructure
DanielYang59 Jun 10, 2024
51ffc18
temp save
DanielYang59 Jun 11, 2024
0298442
Merge branch 'master' into type-elec-struct
DanielYang59 Jun 11, 2024
09d62ad
Merge branch 'master' into type-elec-struct
DanielYang59 Jun 12, 2024
0d0615c
first run of cohp, mypy errors to fix
DanielYang59 Jun 12, 2024
319dfa8
fix collection generation
DanielYang59 Jun 12, 2024
a29ef98
add type `SpinLike` and case tweaks
DanielYang59 Jun 12, 2024
d47008c
reduce repetition for `__str__` of `IcohpValue`
DanielYang59 Jun 12, 2024
0407f52
simplify condition
DanielYang59 Jun 12, 2024
3dd5d7c
reduce indentation level
DanielYang59 Jun 12, 2024
0e75e0d
clarify `translation`
DanielYang59 Jun 12, 2024
b7c03da
clarify `list_num` and other docstrings
DanielYang59 Jun 12, 2024
7732736
clarify `label` as str
DanielYang59 Jun 12, 2024
aaf9f29
more type and docstring improvements
DanielYang59 Jun 12, 2024
950eb10
fix unit test
DanielYang59 Jun 12, 2024
5a2ec9f
fix most mypy errors
DanielYang59 Jun 12, 2024
0afb7c2
fix remaining mypy errors
DanielYang59 Jun 12, 2024
5fcf236
add DEBUG tag
DanielYang59 Jun 12, 2024
796c379
reduce code repetition
DanielYang59 Jun 12, 2024
9551db2
Need Confirm: set `translation` as tuple
DanielYang59 Jun 12, 2024
c188030
pre-commit auto-fixes
pre-commit-ci[bot] Jun 12, 2024
e21c5ed
more type clarify
DanielYang59 Jun 12, 2024
3ae88d0
Merge branch 'master' into type-elec-struct
DanielYang59 Jun 13, 2024
5b81360
clarify `num` argument
DanielYang59 Jun 13, 2024
5f760df
clarify docstring of `bandstructure`
DanielYang59 Jun 13, 2024
e558ac7
more minor tweaks
DanielYang59 Jun 13, 2024
4c0bb04
clarify type of labels_dict
DanielYang59 Jun 13, 2024
8e25238
replace unnecessary single-item list extend with append
DanielYang59 Jun 13, 2024
00b7134
fix typo
DanielYang59 Jun 13, 2024
952e206
relocate magic method
DanielYang59 Jun 13, 2024
4ee908d
clarify type of `list_icohp`
DanielYang59 Jun 13, 2024
3aef211
remove unused type alias
DanielYang59 Jun 13, 2024
61379c1
revert undesired rename
DanielYang59 Jun 14, 2024
92e7df8
replace more single item extend with append
DanielYang59 Jun 14, 2024
c397e1c
simplify dict generation
DanielYang59 Jun 14, 2024
8cfaa33
fix downstream lobsterpy error
DanielYang59 Jun 14, 2024
4641d88
Merge branch 'master' into type-elec-struct
DanielYang59 Jun 15, 2024
60f9aa6
Merge branch 'master' into type-elec-struct
DanielYang59 Jun 15, 2024
5eefb53
tweak module docstring
DanielYang59 Jun 16, 2024
132b9bb
Merge branch 'master' into type-elec-struct
DanielYang59 Jun 16, 2024
bbfbaa2
Merge branch 'master' into type-elec-struct
DanielYang59 Jun 17, 2024
629b480
Merge branch 'master' into type-elec-struct
DanielYang59 Jun 18, 2024
9cd7df8
Merge branch 'master' into type-elec-struct
DanielYang59 Jun 19, 2024
7200a3a
Merge branch 'master' into type-elec-struct
DanielYang59 Jun 19, 2024
c3fe9c6
merge master
DanielYang59 Jun 22, 2024
eb36650
need confirm: allow efermi to be None
DanielYang59 Jun 22, 2024
61bc066
Merge branch 'master' into type-elec-struct
DanielYang59 Jun 26, 2024
94ea368
Merge branch 'master' into type-elec-struct
DanielYang59 Jun 26, 2024
1da7359
Merge branch 'master' into type-elec-struct
DanielYang59 Jul 2, 2024
220a398
pre-commit auto-fixes
pre-commit-ci[bot] Jul 2, 2024
6a8abba
Merge branch 'master' into type-elec-struct
DanielYang59 Jul 12, 2024
db89e19
Merge branch 'master' into type-elec-struct
DanielYang59 Jul 15, 2024
217144a
Merge branch 'master' into type-elec-struct
DanielYang59 Jul 17, 2024
84b7313
Merge branch 'master' into type-elec-struct
DanielYang59 Jul 18, 2024
480699b
Merge branch 'master' into type-elec-struct
DanielYang59 Jul 24, 2024
662f653
Merge branch 'master' into type-elec-struct
DanielYang59 Jul 28, 2024
3e59252
Merge branch 'master' into type-elec-struct
DanielYang59 Jul 31, 2024
03c0612
Merge branch 'master' into type-elec-struct
DanielYang59 Aug 3, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
261 changes: 151 additions & 110 deletions pymatgen/electronic_structure/bandstructure.py

Large diffs are not rendered by default.

15 changes: 7 additions & 8 deletions pymatgen/electronic_structure/boltztrap2.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
"""BoltzTraP2 is a python software interpolating band structures and
computing materials properties from dft band structure using Boltzmann
semi-classical transport theory.
This module provides a pymatgen interface to BoltzTraP2.
"""This module provides a pymatgen interface to BoltzTraP2.
Some of the code is written following the examples provided in BoltzTraP2.

BoltzTraP2 has been developed by Georg Madsen, Jesús Carrete, Matthieu J. Verstraete.
BoltzTraP2 is a Python software interpolating band structures and
computing materials properties from dft band structure using Boltzmann
semi-classical transport theory, developed by Georg Madsen, Jesús Carrete,
Matthieu J. Verstraete.

https://gitlab.com/sousaw/BoltzTraP2
https://www.sciencedirect.com/science/article/pii/S0010465518301632
Expand All @@ -21,9 +21,8 @@
Computer Physics Communications, 175, 67-71

Todo:
- DONE: spin polarized bands
- read first derivative of the eigenvalues from vasprun.xml (mommat)
- handle magnetic moments (magmom)
- Read first derivative of the eigenvalues from vasprun.xml (mommat)
- Handle magnetic moments (MAGMOM)
"""

from __future__ import annotations
Expand Down
Loading
Loading