aiida-wannier90-workflows


Nameaiida-wannier90-workflows JSON
Version 2.2.0 PyPI version JSON
download
home_page
SummaryAdvanced AiiDA workflows for Wannier90
upload_time2023-11-23 18:05:42
maintainer
docs_urlNone
author
requires_python>=3.8
license
keywords aiida plugin wannier90
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # `aiida-wannier90-workflows`

|     | |
|-----|----------------------------------------------------------------------------|
|Latest release| [![PyPI version](https://badge.fury.io/py/aiida-wannier90-workflows.svg)](https://badge.fury.io/py/aiida-wannier90-workflows) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/aiida-wannier90-workflows.svg)](https://pypi.python.org/pypi/aiida-wannier90-workflows/) |
|Getting help| [![Docs status](https://readthedocs.org/projects/aiida-wannier90-workflows/badge)](http://aiida-wannier90-workflows.readthedocs.io/) [![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/aiidausers)
|Build status| [![Build Status](https://github.com/aiidateam/aiida-wannier90-workflows/actions/workflows/ci.yml/badge.svg)](https://github.com/aiidateam/aiida-wannier90-workflows/actions) [![Coverage Status](https://codecov.io/gh/aiidateam/aiida-wannier90-workflows/branch/main/graph/badge.svg)](https://codecov.io/gh/aiidateam/aiida-wannier90-workflows/tree/main) |
|Activity| [![PyPI-downloads](https://img.shields.io/pypi/dm/aiida-wannier90-workflows.svg?style=flat)](https://pypistats.org/packages/aiida-wannier90-workflows) [![Commit Activity](https://img.shields.io/github/commit-activity/m/aiidateam/aiida-wannier90-workflows.svg)](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": "",
    "name": "aiida-wannier90-workflows",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "aiida,plugin,wannier90",
    "author": "",
    "author_email": "The AiiDA team <developers@aiida.net>",
    "download_url": "https://files.pythonhosted.org/packages/ab/58/d0f1b38bb22f8d9ae1998b6ff2ea38636904232154ea57c8a0bd79e899b3/aiida_wannier90_workflows-2.2.0.tar.gz",
    "platform": null,
    "description": "# `aiida-wannier90-workflows`\n\n|     | |\n|-----|----------------------------------------------------------------------------|\n|Latest release| [![PyPI version](https://badge.fury.io/py/aiida-wannier90-workflows.svg)](https://badge.fury.io/py/aiida-wannier90-workflows) [![PyPI pyversions](https://img.shields.io/pypi/pyversions/aiida-wannier90-workflows.svg)](https://pypi.python.org/pypi/aiida-wannier90-workflows/) |\n|Getting help| [![Docs status](https://readthedocs.org/projects/aiida-wannier90-workflows/badge)](http://aiida-wannier90-workflows.readthedocs.io/) [![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/aiidausers)\n|Build status| [![Build Status](https://github.com/aiidateam/aiida-wannier90-workflows/actions/workflows/ci.yml/badge.svg)](https://github.com/aiidateam/aiida-wannier90-workflows/actions) [![Coverage Status](https://codecov.io/gh/aiidateam/aiida-wannier90-workflows/branch/main/graph/badge.svg)](https://codecov.io/gh/aiidateam/aiida-wannier90-workflows/tree/main) |\n|Activity| [![PyPI-downloads](https://img.shields.io/pypi/dm/aiida-wannier90-workflows.svg?style=flat)](https://pypistats.org/packages/aiida-wannier90-workflows) [![Commit Activity](https://img.shields.io/github/commit-activity/m/aiidateam/aiida-wannier90-workflows.svg)](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": "",
    "summary": "Advanced AiiDA workflows for Wannier90",
    "version": "2.2.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": "",
            "digests": {
                "blake2b_256": "dd559bfbe1eaa7b69f50812296b233c1ad80f1ed91ce3b2f4764e855648fc216",
                "md5": "a4cee48b0d6845d603d746b409ea2e62",
                "sha256": "aee53e34e8080d73afcb0ca240bdd9a2e30f2a3e3590f0c61a1d4d673898283d"
            },
            "downloads": -1,
            "filename": "aiida_wannier90_workflows-2.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a4cee48b0d6845d603d746b409ea2e62",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 163780,
            "upload_time": "2023-11-23T18:05:40",
            "upload_time_iso_8601": "2023-11-23T18:05:40.245482Z",
            "url": "https://files.pythonhosted.org/packages/dd/55/9bfbe1eaa7b69f50812296b233c1ad80f1ed91ce3b2f4764e855648fc216/aiida_wannier90_workflows-2.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ab58d0f1b38bb22f8d9ae1998b6ff2ea38636904232154ea57c8a0bd79e899b3",
                "md5": "708af6b2553664b98820354f4a5caeba",
                "sha256": "014ada7badb863537363e5a3449644f179c7f2909d6144312a1d6e76546580d6"
            },
            "downloads": -1,
            "filename": "aiida_wannier90_workflows-2.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "708af6b2553664b98820354f4a5caeba",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 122171,
            "upload_time": "2023-11-23T18:05:42",
            "upload_time_iso_8601": "2023-11-23T18:05:42.723729Z",
            "url": "https://files.pythonhosted.org/packages/ab/58/d0f1b38bb22f8d9ae1998b6ff2ea38636904232154ea57c8a0bd79e899b3/aiida_wannier90_workflows-2.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-23 18:05:42",
    "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"
}
        
Elapsed time: 0.31417s