Skip to main content

AiiDA plugin for the JuKKR codes

Project description

aiida-core Documentation Status Build status codecov MIT license GitHub version PyPI version DOI

aiida-kkr

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

Features

  • 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). https://doi.org/10.1038/s41524-020-00482-5

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)

Installation

$ pip install aiida-kkr  # install latest version of aiida-kkr (published on pypi.org)
$ 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 https://github.com/JuDFTteam/aiida-kkr.git
$ 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

Contributing

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

Releasing new versions

To create a new release follow these steps:

  • finish your development and merge it into the develop branch
  • update documentation
  • update / fix tests
  • bump version numbers (in files aiida_kkr/__init__.py, pyproject.toml, .bumpversion.cfg)
  • merge changes from develop back into master and create a tag for the new version number (this triggers publication to pypi)

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

aiida_kkr-2.3.1.tar.gz (255.3 kB view details)

Uploaded Source

Built Distribution

aiida_kkr-2.3.1-py2.py3-none-any.whl (295.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file aiida_kkr-2.3.1.tar.gz.

File metadata

  • Download URL: aiida_kkr-2.3.1.tar.gz
  • Upload date:
  • Size: 255.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for aiida_kkr-2.3.1.tar.gz
Algorithm Hash digest
SHA256 229afe35a298b3336a520e0c2436e2380eebd3ad27eb5066977a88e735d8e6be
MD5 37dacb7df9234db0003a6bc98020e38b
BLAKE2b-256 65ee43fb8e1ce18fa98891a03eac544187f6fee963e761e2927fbaa7ad22a64a

See more details on using hashes here.

File details

Details for the file aiida_kkr-2.3.1-py2.py3-none-any.whl.

File metadata

  • Download URL: aiida_kkr-2.3.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 295.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for aiida_kkr-2.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9cd93dc1a393782a7fa1d62d9d572a7722231b84b2a3add07bd68f1da4291578
MD5 e77a652ee9737f77b986e895ee8571ba
BLAKE2b-256 94f165bccae7872d2703868d1a00207d9c0c4f979931c30d899a9cc677204159

See more details on using hashes here.

Supported by

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