# [SymClosestWannier](https://cmt-mu.github.io/SymClosestWannier/)
- **Overview**:
A Python library to create Symmetry-adapted Closest Wannier (SymCW) tight-binding models based on the Symmetry-Adapted Multipole Basis (SAMB) [1] and the Closest Wannier formalism developed by Taisuke Ozaki [2].
> [1] Hiroaki Kusunose, Rikuto Oiwa, and Satoru Hayami, Symmetry-adapted modeling for molecules and crystals, Phys. Rev. B 107, 195118 (2023).
> DOI: https://doi.org/10.1103/PhysRevB.107.195118.<br>
> [2] Taisuke Ozaki, Closest Wannier functions to a given set of localized orbitals, arXiv:2306.15296, (2023).
> URL: https://arxiv.org/abs/2306.15296v2.
- **Authors**: Rikuto Oiwa
- **Installation**: SymClosestWannier can be installed from PyPI using pip on Python >= 3.9:
```
pip install symclosestwannier
```
You can also visit [PyPI](https://pypi.org/project/symclosestwannier/) or [GitHub](https://github.com/CMT-MU/SymClosestWannier/) to download the source.
- **Citing SymClosestWannier**: If you are using SymClosestWannier in your scientific research, please help our scientific visibility by citing our work:
> Rikuto Oiwa, Akane Inda, Satoru Hayami, Takuya Nomoto, Ryotaro Arita, and Hiroaki Kusunose, in preparation.<br>
> DOI: []()
- **Requirements**:
- Symmetry-Adapted Multipole Basis (SAMB) for molecular or crystal are optionally generated by [MultiPie](https://github.com/CMT-MU/MultiPie).
- MultiPie library optionally requires [TeXLive](https://www.tug.org/texlive/) environment to create LaTeX and PDF files.
- Molecular or crystal structure files are optionally generated by [QtDraw](https://github.com/CMT-MU/QtDraw).
- **To Do**:
- add function to read seedname.uHu, seedname.uIu files.
Raw data
{
"_id": null,
"home_page": "",
"name": "symclosestwannier",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "dft,wannier function,tight-binding model,symmetry,materials science",
"author": "",
"author_email": "Rikuto Oiwa <ro.qp.07@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/01/1a/1b9fc54648068659ea7d5722a0a0767a50fc5b6611735820767b9cdccad1/symclosestwannier-1.1.19.tar.gz",
"platform": null,
"description": "# [SymClosestWannier](https://cmt-mu.github.io/SymClosestWannier/)\n\n- **Overview**:\n A Python library to create Symmetry-adapted Closest Wannier (SymCW) tight-binding models based on the Symmetry-Adapted Multipole Basis (SAMB) [1] and the Closest Wannier formalism developed by Taisuke Ozaki [2].\n\n > [1] Hiroaki Kusunose, Rikuto Oiwa, and Satoru Hayami, Symmetry-adapted modeling for molecules and crystals, Phys. Rev. B 107, 195118 (2023).\n > DOI: https://doi.org/10.1103/PhysRevB.107.195118.<br>\n > [2] Taisuke Ozaki, Closest Wannier functions to a given set of localized orbitals, arXiv:2306.15296, (2023).\n > URL: https://arxiv.org/abs/2306.15296v2.\n\n- **Authors**: Rikuto Oiwa\n\n- **Installation**: SymClosestWannier can be installed from PyPI using pip on Python >= 3.9:\n ```\n pip install symclosestwannier\n ```\n You can also visit [PyPI](https://pypi.org/project/symclosestwannier/) or [GitHub](https://github.com/CMT-MU/SymClosestWannier/) to download the source.\n\n- **Citing SymClosestWannier**: If you are using SymClosestWannier in your scientific research, please help our scientific visibility by citing our work:\n\n > Rikuto Oiwa, Akane Inda, Satoru Hayami, Takuya Nomoto, Ryotaro Arita, and Hiroaki Kusunose, in preparation.<br>\n > DOI: []()\n\n- **Requirements**:\n - Symmetry-Adapted Multipole Basis (SAMB) for molecular or crystal are optionally generated by [MultiPie](https://github.com/CMT-MU/MultiPie).\n - MultiPie library optionally requires [TeXLive](https://www.tug.org/texlive/) environment to create LaTeX and PDF files.\n - Molecular or crystal structure files are optionally generated by [QtDraw](https://github.com/CMT-MU/QtDraw).\n\n- **To Do**:\n - add function to read seedname.uHu, seedname.uIu files.\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "A Python library for Symmetry-Adapted Closest Wannier (SymCW) Tight-Binding model based on Plane-Wave DFT calculation.",
"version": "1.1.19",
"project_urls": {
"Homepage": "https://github.com/CMT-MU/SymClosestWannier",
"Issues": "https://github.com/CMT-MU/SymClosestWannier/issues"
},
"split_keywords": [
"dft",
"wannier function",
"tight-binding model",
"symmetry",
"materials science"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "07ead983663253bc5e2ba0ccdac3747b1ff37c5ab6407de3806fb1f5a131aefb",
"md5": "45e1637af76c2f582e5258068342e35f",
"sha256": "eb6d34b34b2c1c6503d1b7f9c15ec16681e54ed97b01934005baaadbba018b0b"
},
"downloads": -1,
"filename": "symclosestwannier-1.1.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "45e1637af76c2f582e5258068342e35f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 77350,
"upload_time": "2024-03-05T09:23:34",
"upload_time_iso_8601": "2024-03-05T09:23:34.720214Z",
"url": "https://files.pythonhosted.org/packages/07/ea/d983663253bc5e2ba0ccdac3747b1ff37c5ab6407de3806fb1f5a131aefb/symclosestwannier-1.1.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "011a1b9fc54648068659ea7d5722a0a0767a50fc5b6611735820767b9cdccad1",
"md5": "0b0e4c266231c3ab19b644c84bac2102",
"sha256": "6a04ea6a530f9b14788395cbd3b8c9b1a513c8a158eedb8e6c6c0cf55fb51b62"
},
"downloads": -1,
"filename": "symclosestwannier-1.1.19.tar.gz",
"has_sig": false,
"md5_digest": "0b0e4c266231c3ab19b644c84bac2102",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 65088,
"upload_time": "2024-03-05T09:23:36",
"upload_time_iso_8601": "2024-03-05T09:23:36.231904Z",
"url": "https://files.pythonhosted.org/packages/01/1a/1b9fc54648068659ea7d5722a0a0767a50fc5b6611735820767b9cdccad1/symclosestwannier-1.1.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-05 09:23:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CMT-MU",
"github_project": "SymClosestWannier",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "symclosestwannier"
}
JSON
