Skip to main content

Python modules for electron-phonon models

Project description

DOI

Python modules for electron-phonon models

elphmod logo

  • el - tight-binding models from Wannier90
  • ph - mass-spring models from Quantum ESPRESSO
  • elph - electron-phonon coupling from EPW
  • elel - Coulomb interaction from VASP
  • MPI - work distribution and shared memory
  • bravais - lattices, symmetries, and interpolation
  • dispersion - diagonalization on paths and meshes
  • dos - 2D tetrahedron methods
  • diagrams - susceptibilities, self-energies, etc.
  • occupations - step and delta smearing functions
  • eliashberg - parameters for McMillan's formula
  • plot - BZ plots, fatbands, etc.
  • misc - constants, status bars, parsing, etc.

Installation

To install the latest version of elphmod:

python3 -m pip install elphmod

Alternatively, to install the latest development version:

python3 -m pip install --upgrade pip setuptools wheel
python3 -m pip install git+https://github.com/janberges/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

If you plan to work on elphmod itself, we recommend to download the complete repository and also install the requirements of examples and documentation:

git clone https://github.com/janberges/elphmod
python3 -m pip install -r elphmod/requirements.txt

Also consider adding the absolute paths to elphmod/elphmod and elphmod/bin to the environment variables PYTHONPATH and PATH, respectively.

Documentation

The documentation can be found at https://janberges.github.io/elphmod. It has been automatically generated from the NumPy-style docstrings in the source code using Sphinx:

cd doc
make html
firefox html/index.html

Please also have a look at the examples:

cd examples
mpirun python3 electrons.py

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-2022 elphmod Developers

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

elphmod-0.16.tar.gz (109.6 kB view details)

Uploaded Source

Built Distribution

elphmod-0.16-py3-none-any.whl (108.8 kB view details)

Uploaded Python 3

File details

Details for the file elphmod-0.16.tar.gz.

File metadata

  • Download URL: elphmod-0.16.tar.gz
  • Upload date:
  • Size: 109.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.2

File hashes

Hashes for elphmod-0.16.tar.gz
Algorithm Hash digest
SHA256 6f76ee0a96c0fba1c6a7551b674cbff69a6bb57418a02976bacd1c57ed0d6fe1
MD5 846c66a33fd40163a0758f200c37684e
BLAKE2b-256 e9e73ca86fdc3548d6d5acc4d369cb1dd2443c5c51ed6d33137f186f9814a8d0

See more details on using hashes here.

Provenance

File details

Details for the file elphmod-0.16-py3-none-any.whl.

File metadata

  • Download URL: elphmod-0.16-py3-none-any.whl
  • Upload date:
  • Size: 108.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.2

File hashes

Hashes for elphmod-0.16-py3-none-any.whl
Algorithm Hash digest
SHA256 84977d66769c08eb4694a83f5f22988661e161f34128aa4d9e807113cc490a01
MD5 819fe19d62be991f7b546844cdb416ce
BLAKE2b-256 9e08386355efbe0cbc74740626a3db57f09cfabde211429d7237fd8149f450b6

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page