Python modules for electron-phonon models
elphmod is a collection of Python modules to handle coupled tight-binding and mass-spring models derived from first principles. It provides interfaces with popular simulation software such as Quantum ESPRESSO, Wannier90, EPW, RESPACK, and i-PI. It helps calculate dispersions, spectra, and response functions and can be used to build and study distorted structures on supercells.
el- tight-binding models from Wannier90ph- mass-spring models from Quantum ESPRESSOelph- electron-phonon coupling from EPWelel- Coulomb interaction from RESPACKMPI- work distribution and shared memorybravais- lattices, symmetries, and interpolationdispersion- diagonalization on paths and meshesdos- 2D tetrahedron methodsdiagrams- susceptibilities, self-energies, etc.occupations- step and delta smearing functionsmd- charge-density-wave dynamics using i-PIeliashberg- parameters for McMillan's formulaplot- BZ plots, fatbands, etc.misc- constants, status bars, parsing, etc.models- nearest-neighbor models for testing
Installation
You can install the latest version of elphmod from PyPI:
python3 -m pip install --upgrade elphmod
Or from the conda-forge channel on Anaconda Cloud:
conda install conda-forge::elphmod
elphmod can optionally be run in parallel via MPI (with shared-memory support). Using APT and pip, you can install the corresponding dependencies as follows:
sudo apt install libopenmpi-dev
python3 -m pip install mpi4py --no-binary=mpi4py
You can also download the complete repository, perform an editable installation, and install the requirements of examples and documentation:
git clone https://github.com/janberges/elphmod
python3 -m pip install -e elphmod
python3 -m pip install -r elphmod/examples/requirements.txt
python3 -m pip install -r elphmod/doc/requirements.txt
Documentation
The documentation can be found at https://io.janberges.de/elphmod.
Please also have a look at the examples directory.
Reference
elphmod is stored on Zenodo: https://doi.org/10.5281/zenodo.5919991.
Licence
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.
Copyright (C) 2017-2026 elphmod Developers
1 maintainer
Release files for elphmod 0.35
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| elphmod-0.35.tar.gz | 134.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| elphmod-0.35-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 280.5 kB
Release files / elphmod-0.35.tar.gz
| Download URL | elphmod-0.35.tar.gz |
|---|---|
| Size | 134.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9b29941ac5971ebba54ab2fb3e56f7591d9f09de48cd4ceb4f9106c07c678080
|
|
BLAKE2b-256 checksum How to use checksums |
7944efe7b32f203d823d9666a90440de8d6b7bb693092e8bf9bd2970daeff3b5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.2
|
Release files / elphmod-0.35-py3-none-any.whl
| Download URL | elphmod-0.35-py3-none-any.whl |
|---|---|
| Size | 146.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9d7737747011b196fc74c364c526c5f2858587ae39853eaf39f13c723c14306c
|
|
BLAKE2b-256 checksum How to use checksums |
fb164a06946983a4f89068660f5953748ba051546ec4ddc33d52e53801281d99
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.2
|
