Skip to content

Commit 44b8c6e

Browse files
authored
Replace expired BoltzTraP link (#3929)
* update BoltzTraP link * correct BoltzTraP case in docstring * remove unused gitignore items
1 parent 8e39294 commit 44b8c6e

File tree

2 files changed

+17
-24
lines changed

2 files changed

+17
-24
lines changed

Diff for: .gitignore

-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
__pycache__/
22
.DS_Store
33
pymatgen.egg-info
4-
dependencies/PyCifRW-3.3/PyCifRW.egg-info
5-
dependencies/spglib*/pyspglib.egg-info
6-
dependencies/spglib*/build
74
*.o
85
*.so
96
*.pyc
@@ -26,7 +23,6 @@ setuptools*
2623
.cache
2724
.tox
2825
.eggs/
29-
gulptmp_4_1
3026
.coverage
3127
.*_cache
3228
# VS Code

Diff for: src/pymatgen/electronic_structure/boltztrap.py

+17-20
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
1-
"""This module provides classes to run and analyze boltztrap on pymatgen band
2-
structure objects. Boltztrap is a software interpolating band structures and
3-
computing materials properties from this band structure using Boltzmann
4-
semi-classical transport theory.
1+
"""This module provides classes to run and analyze BoltzTraP on pymatgen band
2+
structure objects. BoltzTraP is a software developed by Georg Madsen to
3+
interpolate band structures and compute materials properties from this
4+
band structure using Boltzmann semi-classical transport theory.
55
6-
Boltztrap has been developed by Georg Madsen.
7-
8-
http://www.icams.de/content/research/software-development/boltztrap/
6+
https://www.tuwien.at/en/tch/tc/theoretical-materials-chemistry/boltztrap
97
108
You need version 1.2.3 or higher
119
12-
References are:
13-
10+
References:
1411
Madsen, G. K. H., and Singh, D. J. (2006).
1512
BoltzTraP. A code for calculating band-structure dependent quantities.
1613
Computer Physics Communications, 175, 67-71
@@ -60,13 +57,13 @@
6057

6158

6259
class BoltztrapRunner(MSONable):
63-
"""This class is used to run Boltztrap on a band structure object."""
60+
"""This class is used to run BoltzTraP on a band structure object."""
6461

6562
@requires(
6663
which("x_trans"),
6764
"BoltztrapRunner requires the executables 'x_trans' to be in PATH. Please download "
68-
"Boltztrap at http://www.icams.de/content/research/software-development/boltztrap/ "
69-
"and follow the instructions in the README to compile Bolztrap accordingly. "
65+
"BoltzTraP at https://www.tuwien.at/en/tch/tc/theoretical-materials-chemistry/boltztrap "
66+
"and follow the instructions in the README to compile BoltzTraP accordingly. "
7067
"Then add x_trans to your path",
7168
)
7269
def __init__(
@@ -144,7 +141,7 @@ def __init__(
144141
electron occupations. If the band structure comes from a soc
145142
computation, you should set soc to True (default False)
146143
doping:
147-
the fixed doping levels you want to compute. Boltztrap provides
144+
the fixed doping levels you want to compute. BoltzTraP provides
148145
both transport values depending on electron chemical potential
149146
(fermi energy) and for a series of fixed carrier
150147
concentrations. By default, this is set to 1e16 to 1e22 in
@@ -734,7 +731,7 @@ def __init__(
734731
bz_kpoints=None,
735732
fermi_surface_data=None,
736733
) -> None:
737-
"""Constructor taking directly all the data generated by Boltztrap. You
734+
"""Constructor taking directly all the data generated by BoltzTraP. You
738735
won't probably use it directly but instead use the from_files and
739736
from_dict methods.
740737
@@ -760,7 +757,7 @@ def __init__(
760757
each Fermi level in mu_steps]}
761758
The units are m^3/C
762759
doping: The different doping levels that have been given to
763-
Boltztrap. The format is {'p':[],'n':[]} with an array of
760+
BoltzTraP. The format is {'p':[],'n':[]} with an array of
764761
doping levels. The units are cm^-3
765762
mu_doping: Gives the electron chemical potential (or Fermi level)
766763
for a given set of doping.
@@ -802,7 +799,7 @@ def __init__(
802799
intrans: a dictionary of inputs e.g. {"scissor": 0.0}
803800
carrier_conc: The concentration of carriers in electron (or hole)
804801
per unit cell
805-
dos: The dos computed by Boltztrap given as a pymatgen Dos object
802+
dos: The dos computed by BoltzTraP given as a pymatgen Dos object
806803
dos_partial: Data for the partial DOS projected on sites and
807804
orbitals
808805
vol: Volume of the unit cell in angstrom cube (A^3)
@@ -837,13 +834,13 @@ def __init__(
837834
self.fermi_surface_data = fermi_surface_data
838835

839836
def get_symm_bands(self, structure: Structure, efermi, kpt_line=None, labels_dict=None):
840-
"""Useful to read bands from Boltztrap output and get a BandStructureSymmLine object
837+
"""Useful to read bands from BoltzTraP output and get a BandStructureSymmLine object
841838
comparable with that one from a DFT calculation (if the same kpt_line is
842839
provided). Default kpt_line and labels_dict is the standard path of high symmetry
843840
k-point for the specified structure. They could be extracted from the
844841
BandStructureSymmLine object that you want to compare with. efermi variable must
845842
be specified to create the BandStructureSymmLine object (usually it comes from DFT
846-
or Boltztrap calc).
843+
or BoltzTraP calc).
847844
"""
848845
try:
849846
if kpt_line is None:
@@ -1640,7 +1637,7 @@ def get_carrier_concentration(self):
16401637

16411638
def get_hall_carrier_concentration(self):
16421639
"""Get the Hall carrier concentration (in cm^-3). This is the trace of
1643-
the Hall tensor (see Boltztrap source code) Hall carrier concentration
1640+
the Hall tensor (see BoltzTraP source code) Hall carrier concentration
16441641
are not always exactly the same than carrier concentration.
16451642
16461643
Returns:
@@ -1770,7 +1767,7 @@ def parse_intrans(path_dir):
17701767
path_dir: (str) dir containing the boltztrap.intrans file
17711768
17721769
Returns:
1773-
dict: various inputs that had been used in the Boltztrap run.
1770+
dict: various inputs that had been used in the BoltzTraP run.
17741771
"""
17751772
intrans = {}
17761773
with open(f"{path_dir}/boltztrap.intrans") as file:

0 commit comments

Comments
 (0)