[](https://www.aiida.net/)
[](https://aiida-kkr.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/JuDFTteam/aiida-kkr/actions)
[](https://codecov.io/gh/JuDFTteam/aiida-kkr)
[](http://opensource.org/licenses/MIT)
[](https://badge.fury.io/gh/JuDFTteam%2Faiida-kkr)
[](https://badge.fury.io/py/aiida-kkr)
[](https://doi.org/10.5281/zenodo.3628251)
# aiida-kkr
[AiiDA](https://aiida.net) plugin for the [Jülich KKR codes](https://jukkr.fz-juelich.de) 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](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)](https://arxiv.org/abs/2003.08315)
# Installation
```shell
$ 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 `[]`)
```shell
$ 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
* see http://aiida-kkr.readthedocs.io for user's guide and API reference.
* check out http://judft.de and https://jukkr.fz-juelich.de for information of the KKR codes used by the plugin
# Contributing
Thank you for your interest in contributing to aiida-kkr.
Check out our [contributing guide](CONTRIBUTING.md) for some information.
Raw data
{
"_id": null,
"home_page": null,
"name": "aiida-kkr",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "material science,aiida,dft,all-electron,kkr",
"author": null,
"author_email": "Philipp Ruessmann <p.ruessmann@fz-juelich.de>, Jens Broeder <j.broeder@fz-juelich.de>, Fabian Bertoldo <f.bertoldo@fz-juelich.de>",
"download_url": "https://files.pythonhosted.org/packages/d0/9d/b9b53b833700034687e1f4eaef0011d234e6511e9191f11568102a0c188f/aiida_kkr-2.1.0.tar.gz",
"platform": null,
"description": "[](https://www.aiida.net/)\n[](https://aiida-kkr.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/JuDFTteam/aiida-kkr/actions)\n[](https://codecov.io/gh/JuDFTteam/aiida-kkr)\n[](http://opensource.org/licenses/MIT)\n[](https://badge.fury.io/gh/JuDFTteam%2Faiida-kkr)\n[](https://badge.fury.io/py/aiida-kkr)\n[](https://doi.org/10.5281/zenodo.3628251)\n\n\n\n# aiida-kkr\n\n[AiiDA](https://aiida.net) plugin for the [J\u00fclich KKR codes](https://jukkr.fz-juelich.de) plus workflows and utility.\n\n## Features\n\n* KKR calculations for bulk and interfaces\n* treatment of alloys using VCA or CPA\n* self-consistency, DOS and bandstructure calculations\n* extraction of magnetic exchange coupling parameters (*J_ij*, *D_ij*)\n* impurity embedding solving the Dyson equation\n\n\n## How to cite\n\nIf you use this plugin please cite:\n> [R\u00fc\u00dfmann, P., Bertoldo, F. & Bl\u00fcgel, 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](https://doi.org/10.1038/s41524-020-00482-5)\n\nThe ArXiv preprint can be found here:\n> [Philipp R\u00fc\u00dfmann, Fabian Bertoldo and Stefan Bl\u00fcgel, *The AiiDA-KKR plugin and its application to high-throughput impurity embedding into a topological insulator*, arXiv:2003.08315 [cond-mat.mtrl-sci] (2020)](https://arxiv.org/abs/2003.08315)\n\n\n# Installation\n\n```shell\n$ pip install aiida-kkr # install latest version of aiida-kkr (published on pypi.org)\n$ reentry scan -r aiida # update entry points, needed in order to find kkr.* entrypoints in aiida\n\n# setupt aiida if this was not done already:\n$ verdi quicksetup # better to set up a new profile\n$ verdi calculation plugins # should now show kkr.* entrypoints\n```\n\nTo 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 `[]`)\n\n```shell\n$ git clone https://github.com/JuDFTteam/aiida-kkr.git\n$ pip install -e aiida-kkr[testing,devtools,docs]\n$ reentry scan -r aiida\n```\n\n## Remarks about dependencies and extras\n\n- The `aiida-kkr` plugin uses the `ase` and `pymatgen` packages for structure conversions.\n- 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).\n- Other extras that can be optionally installed with `aiida-kkr` are\n * `pre-commit` which installes the pre-commit hooks that allow style (`yapf`) and static code checking (`pylint`)\n * `testing` which installs `pytest` and all extension used in the tests\n * `docs` which installs `Sphinx` to build the documentation\n * `devtools` which installs tools that might be helpful during development\n\n\n# Usage and Documentation\n\n* see http://aiida-kkr.readthedocs.io for user's guide and API reference.\n* check out http://judft.de and https://jukkr.fz-juelich.de for information of the KKR codes used by the plugin\n\n# Contributing\n\nThank you for your interest in contributing to aiida-kkr.\nCheck out our [contributing guide](CONTRIBUTING.md) for some information.\n",
"bugtrack_url": null,
"license": null,
"summary": "AiiDA plugin for the JuKKR codes",
"version": "2.1.0",
"project_urls": {
"Documentation": "https://aiida-kkr.readthedocs.io",
"Download": "https://github.com/JuDFTteam/aiida-kkr",
"Homepage": "https://github.com/JuDFTteam/aiida-kkr"
},
"split_keywords": [
"material science",
"aiida",
"dft",
"all-electron",
"kkr"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "36fa3f73189e30a52be0ce3e995ded1f26e0738a446ebb36c416a81585614d1a",
"md5": "cbdfa1137a5672b9f88e6a2d539da89c",
"sha256": "f2bbe1bfcd7ebab396d63b10eaaacf9f66f05dc29b61c57e4f5e75e13d78d25d"
},
"downloads": -1,
"filename": "aiida_kkr-2.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "cbdfa1137a5672b9f88e6a2d539da89c",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 275826,
"upload_time": "2023-11-13T12:37:34",
"upload_time_iso_8601": "2023-11-13T12:37:34.713539Z",
"url": "https://files.pythonhosted.org/packages/36/fa/3f73189e30a52be0ce3e995ded1f26e0738a446ebb36c416a81585614d1a/aiida_kkr-2.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d09db9b53b833700034687e1f4eaef0011d234e6511e9191f11568102a0c188f",
"md5": "01863a42b22673bb7e908400df8cc3df",
"sha256": "166b3717dfcdb89ec224e2a06b569527b5030f57fc81c526e2425d92f978e60b"
},
"downloads": -1,
"filename": "aiida_kkr-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "01863a42b22673bb7e908400df8cc3df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 81697709,
"upload_time": "2023-11-13T12:37:38",
"upload_time_iso_8601": "2023-11-13T12:37:38.278969Z",
"url": "https://files.pythonhosted.org/packages/d0/9d/b9b53b833700034687e1f4eaef0011d234e6511e9191f11568102a0c188f/aiida_kkr-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-13 12:37:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JuDFTteam",
"github_project": "aiida-kkr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aiida-kkr"
}
JSON
