# `aiida-wannier90-workflows`
| | |
|-----|----------------------------------------------------------------------------|
|Latest release| [](https://badge.fury.io/py/aiida-wannier90-workflows) [](https://pypi.python.org/pypi/aiida-wannier90-workflows/) |
|Getting help| [](http://aiida-wannier90-workflows.readthedocs.io/) [](https://groups.google.com/forum/#!forum/aiidausers)
|Build status| [](https://github.com/aiidateam/aiida-wannier90-workflows/actions) [](https://codecov.io/gh/aiidateam/aiida-wannier90-workflows/tree/main) |
|Activity| [](https://pypistats.org/packages/aiida-wannier90-workflows) [](https://github.com/aiidateam/aiida-wannier90-workflows/pulse)
Advanced AiiDA workflows for automated Wannierisation.
The protocol for automating the construction of Wannier functions is discussed
in the articles listed in the [Support and citations](#support-and-citations).
## Installation
1. Install latest release by
```bash
pip install aiida-wannier90-workflows
```
2. Or install the development version by
```bash
git clone https://github.com/aiidateam/aiida-wannier90-workflows.git
cd aiida-wannier90-workflows/
pip install -e .
```
## Examples
See the [examples](examples/) folder on how to use the workflows.
## Support and citations
If you find this package useful, please cite the following articles
* Junfeng Qiao, Giovanni Pizzi, Nicola Marzari,
*Projectability disentanglement for accurate and automated electronic-structure Hamiltonians*, npj Computational Materials 9, 208 (2023)
* <https://arxiv.org/abs/2303.07877>
* <https://www.nature.com/articles/s41524-023-01146-w>
* <https://archive.materialscloud.org/record/2023.117>
* Junfeng Qiao, Giovanni Pizzi, Nicola Marzari,
*Automated mixing of maximally localized Wannier functions into target manifolds*, npj Computational Materials 9, 206 (2023)
* <https://arxiv.org/abs/2306.00678>
* <https://www.nature.com/articles/s41524-023-01147-9>
* <https://archive.materialscloud.org/record/2023.86>
* Valerio Vitale, Giovanni Pizzi, Antimo Marrazzo, Jonathan Yates, Nicola Marzari, Arash Mostofi,
*Automated high-throughput Wannierisation*, npj Computational Materials 6, 66 (2020)
* <https://arxiv.org/abs/1909.00433>
* <https://www.nature.com/articles/s41524-020-0312-y>
* <https://doi.org/10.24435/materialscloud:2019.0044/v2>
Raw data
{
"_id": null,
"home_page": null,
"name": "aiida-wannier90-workflows",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "aiida, plugin, wannier90",
"author": null,
"author_email": "The AiiDA team <developers@aiida.net>",
"download_url": "https://files.pythonhosted.org/packages/05/a7/8639faf3b75294f9294d680420c0b5db3415bc656fd202ac4db7226ae6ca/aiida_wannier90_workflows-2.5.0.tar.gz",
"platform": null,
"description": "# `aiida-wannier90-workflows`\n\n| | |\n|-----|----------------------------------------------------------------------------|\n|Latest release| [](https://badge.fury.io/py/aiida-wannier90-workflows) [](https://pypi.python.org/pypi/aiida-wannier90-workflows/) |\n|Getting help| [](http://aiida-wannier90-workflows.readthedocs.io/) [](https://groups.google.com/forum/#!forum/aiidausers)\n|Build status| [](https://github.com/aiidateam/aiida-wannier90-workflows/actions) [](https://codecov.io/gh/aiidateam/aiida-wannier90-workflows/tree/main) |\n|Activity| [](https://pypistats.org/packages/aiida-wannier90-workflows) [](https://github.com/aiidateam/aiida-wannier90-workflows/pulse)\n\nAdvanced AiiDA workflows for automated Wannierisation.\n\nThe protocol for automating the construction of Wannier functions is discussed\nin the articles listed in the [Support and citations](#support-and-citations).\n\n## Installation\n\n1. Install latest release by\n\n ```bash\n pip install aiida-wannier90-workflows\n ```\n\n2. Or install the development version by\n\n ```bash\n git clone https://github.com/aiidateam/aiida-wannier90-workflows.git\n cd aiida-wannier90-workflows/\n pip install -e .\n ```\n\n## Examples\n\nSee the [examples](examples/) folder on how to use the workflows.\n\n## Support and citations\n\nIf you find this package useful, please cite the following articles\n\n* Junfeng Qiao, Giovanni Pizzi, Nicola Marzari,\n *Projectability disentanglement for accurate and automated electronic-structure Hamiltonians*, npj Computational Materials 9, 208 (2023)\n * <https://arxiv.org/abs/2303.07877>\n * <https://www.nature.com/articles/s41524-023-01146-w>\n * <https://archive.materialscloud.org/record/2023.117>\n* Junfeng Qiao, Giovanni Pizzi, Nicola Marzari,\n *Automated mixing of maximally localized Wannier functions into target manifolds*, npj Computational Materials 9, 206 (2023)\n * <https://arxiv.org/abs/2306.00678>\n * <https://www.nature.com/articles/s41524-023-01147-9>\n * <https://archive.materialscloud.org/record/2023.86>\n* Valerio Vitale, Giovanni Pizzi, Antimo Marrazzo, Jonathan Yates, Nicola Marzari, Arash Mostofi,\n *Automated high-throughput Wannierisation*, npj Computational Materials 6, 66 (2020)\n * <https://arxiv.org/abs/1909.00433>\n * <https://www.nature.com/articles/s41524-020-0312-y>\n * <https://doi.org/10.24435/materialscloud:2019.0044/v2>\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Advanced AiiDA workflows for Wannier90",
"version": "2.5.0",
"project_urls": {
"Documentation": "https://aiida-wannier90-workflows.readthedocs.io",
"Source": "https://github.com/aiidateam/aiida-wannier90-workflows"
},
"split_keywords": [
"aiida",
" plugin",
" wannier90"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d1233129c99f71f039baadfcfc0c3a9b8e571cd9a90e525712584357dd59a14c",
"md5": "f6e24f30b1cfe87960e0b3ccbaf9a3cc",
"sha256": "af4d13d7630cab609c6ba0ffe6699f4e025863c70364ac283de2f96be7e9af39"
},
"downloads": -1,
"filename": "aiida_wannier90_workflows-2.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f6e24f30b1cfe87960e0b3ccbaf9a3cc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 192037,
"upload_time": "2025-07-09T08:54:38",
"upload_time_iso_8601": "2025-07-09T08:54:38.022022Z",
"url": "https://files.pythonhosted.org/packages/d1/23/3129c99f71f039baadfcfc0c3a9b8e571cd9a90e525712584357dd59a14c/aiida_wannier90_workflows-2.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "05a78639faf3b75294f9294d680420c0b5db3415bc656fd202ac4db7226ae6ca",
"md5": "96a9768820daef42d737f841d3fe188b",
"sha256": "02ae490d2cad26cbed041372952c02b714e3eb98e6ef10d507315c54ba9c209a"
},
"downloads": -1,
"filename": "aiida_wannier90_workflows-2.5.0.tar.gz",
"has_sig": false,
"md5_digest": "96a9768820daef42d737f841d3fe188b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 151265,
"upload_time": "2025-07-09T08:54:40",
"upload_time_iso_8601": "2025-07-09T08:54:40.019805Z",
"url": "https://files.pythonhosted.org/packages/05/a7/8639faf3b75294f9294d680420c0b5db3415bc656fd202ac4db7226ae6ca/aiida_wannier90_workflows-2.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-09 08:54:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aiidateam",
"github_project": "aiida-wannier90-workflows",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aiida-wannier90-workflows"
}
JSON
