This AiiDA plugin provides high-throughput automation and FAIR data management for the Jülich KKR codes.


Cite this software

What AiiDA-KKR can do for you


AiiDA plugin for the Jülich KKR codes plus workflows and utility.


  • KKR calculations for bulk and interfaces
  • treatment of alloys using VCA or CPA
  • self-consistency, DOS and bandstructure calculations
  • extraction of magnetic exchange coupling parameters (J_ij, D_ij)
  • impurity embedding solving the Dyson equation

How to cite

If you use this plugin please cite:

Rüßmann, P., Bertoldo, F. & Blügel, S. The AiiDA-KKR plugin and its application to high-throughput impurity embedding into a topological insulator. npj Comput Mater 7, 13 (2021).

The ArXiv preprint can be found here:

Philipp Rüßmann, Fabian Bertoldo and Stefan Blügel, The AiiDA-KKR plugin and its application to high-throughput impurity embedding into a topological insulator, arXiv:2003.08315 [cond-mat.mtrl-sci] (2020)


$ pip install aiida-kkr  # install latest version of aiida-kkr (published on
$ reentry scan -r aiida  # update entry points, needed in order to find kkr.* entrypoints in aiida

# setupt aiida if this was not done already:
$ verdi quicksetup  # better to set up a new profile
$ verdi calculation plugins  # should now show kkr.* entrypoints

To install the developer version download the repository and install the downloaded version (see setup.json for a list of optional packages that are installed with the extras given in [])

$ git clone
$ pip install -e aiida-kkr[testing,devtools,docs]
$ reentry scan -r aiida

Remarks about dependencies and extras

  • The aiida-kkr plugin uses the ase and pymatgen packages for structure conversions.
  • For aiida-core>=1.5,<1.6 make sure to use the requirements specified in requirements_aiida-core_1.5.txt (use pip install -r requirements_aiida-core_1.5.txt aiida-kkr for the installation to overwrite the aiida-core dependency).
  • Other extras that can be optionally installed with aiida-kkr are
    • pre-commit which installes the pre-commit hooks that allow style (yapf) and static code checking (pylint)
    • testing which installs pytest and all extension used in the tests
    • docs which installs Sphinx to build the documentation
    • devtools which installs tools that might be helpful during development

Usage and Documentation


Thank you for your interest in contributing to aiida-kkr.
Check out our contributing guide for some information.

Programming languages
  • Python 98%
  • OpenEdge ABL 1%
  • Shell 1%
  • MIT
</>Source code

Participating organisations

Forschungszentrum Jülich
University of Würzburg