Skip to content

Commit a95f254

Browse files
authored
Refactor usage instructions in thermal_electronic.py
Removed redundant bullet points from usage instructions.
1 parent 140abb8 commit a95f254

1 file changed

Lines changed: 6 additions & 8 deletions

File tree

dfttk/thermal_electronic/thermal_electronic.py

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,12 @@ class ThermalElectronic:
3030
A class for reading or setting electronic density-of-states (DOS) data,
3131
calculating thermal electronic properties, and generating plots.
3232
33-
Typical usage:
34-
35-
1. Load electronic DOS data from VASP calculations for multiple volumes
36-
using `read_total_electron_dos()`, or provide DOS data directly with
37-
`set_total_electron_dos()`.\n
38-
2. Compute thermal electronic contributions (Helmholtz free energy,
39-
internal energy, entropy, and heat capacity) using `process()` and `fit()`.\n
40-
3. Visualize results with the provided plotting methods.
33+
Typical usage: (1) Load electronic DOS data from VASP calculations for
34+
multiple volumes using `read_total_electron_dos()`, or provide DOS data
35+
directly with `set_total_electron_dos()`; (2) Compute thermal electronic
36+
contributions (Helmholtz free energy, internal energy, entropy, and heat
37+
capacity) using `process()` and `fit()`; (3) Visualize results with the
38+
provided plotting methods.
4139
4240
Additional intermediate methods are available for calculating the chemical
4341
potential, fitting the DOS, computing the Fermi-Dirac distribution, and

0 commit comments

Comments
 (0)