<!--
SPDX-FileCopyrightText: 2021 The eminus developers
SPDX-License-Identifier: Apache-2.0
-->
# eminus
[](https://pypi.org/project/eminus)
[](https://wangenau.gitlab.io/eminus/installation.html)
[](https://wangenau.gitlab.io/eminus/license.html)
[](https://wangenau.gitlab.io/eminus/htmlcov)
[](https://discord.gg/k2XwdMtVec)
eminus is a pythonic electronic structure theory code.
It implements plane wave density functional theory (DFT) with self-interaction correction (SIC) functionalities.
The goal is to create a simple code that is easy to read and easy to extend while using minimal dependencies.
It is built upon the [DFT++](https://arxiv.org/abs/cond-mat/9909130) pragmas proposed by Tomas Arias et al. that aim to let programming languages and theory coincide.
This can be shown by, e.g., solving the Poisson equation. In the operator notation of DFT++ the equation reads
$$
\phi(\boldsymbol r) = -4\pi\mathcal L^{-1}\mathcal O\mathcal J n(\boldsymbol r).
$$
The corresponding Python code (implying that the operators have been implemented properly) reads
```python
def get_phi(atoms, n):
return -4 * np.pi * atoms.Linv(atoms.O(atoms.J(n)))
```
## Installation
The [package](https://pypi.org/project/eminus) and all necessary dependencies can be installed with
```terminal
pip install eminus
```
More information about installing eminus can be found [here](https://wangenau.gitlab.io/eminus/installation.html).
## Documentation
To learn more about the features, usage, or implementation of eminus, take a look inside the [documentation](https://wangenau.gitlab.io/eminus).
## Citation
A supplementary paper is available on [arXiv](https://arxiv.org/abs/2410.19438). The following BibTeX key can be used
```terminal
@Misc{Schulze2021,
author = {Schulze, Wanja T. and Schwalbe, Sebastian and Trepte, Kai and Gr{\"a}fe, Stefanie},
title = {eminus -- Pythonic electronic structure theory},
year = {2024},
doi = {10.48550/arXiv.2410.19438},
publisher = {arXiv},
}
```
To cite a specific version one can select and cite it with [Zenodo](https://doi.org/10.5281/zenodo.5720635).
## License
This project is licensed under the Apache 2.0 License. See the [license page](https://wangenau.gitlab.io/eminus/license.html) for more details.
Raw data
{
"_id": null,
"home_page": null,
"name": "eminus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "density-functional-theory, electronic-structure, education, python",
"author": null,
"author_email": "Wanja Timm Schulze <wangenau@protonmail.com>",
"download_url": "https://files.pythonhosted.org/packages/0f/a9/1bf1b47c64b4856e39ddac37c28fbdef82163022c4b1c7766a564f854a31/eminus-3.0.1.tar.gz",
"platform": null,
"description": "<!--\nSPDX-FileCopyrightText: 2021 The eminus developers\nSPDX-License-Identifier: Apache-2.0\n-->\n\n\n# eminus\n[](https://pypi.org/project/eminus)\n[](https://wangenau.gitlab.io/eminus/installation.html)\n[](https://wangenau.gitlab.io/eminus/license.html)\n[](https://wangenau.gitlab.io/eminus/htmlcov)\n[](https://discord.gg/k2XwdMtVec)\n\neminus is a pythonic electronic structure theory code.\nIt implements plane wave density functional theory (DFT) with self-interaction correction (SIC) functionalities.\nThe goal is to create a simple code that is easy to read and easy to extend while using minimal dependencies.\nIt is built upon the [DFT++](https://arxiv.org/abs/cond-mat/9909130) pragmas proposed by Tomas Arias et al. that aim to let programming languages and theory coincide.\nThis can be shown by, e.g., solving the Poisson equation. In the operator notation of DFT++ the equation reads\n\n$$\n\\phi(\\boldsymbol r) = -4\\pi\\mathcal L^{-1}\\mathcal O\\mathcal J n(\\boldsymbol r).\n$$\n\nThe corresponding Python code (implying that the operators have been implemented properly) reads\n\n```python\ndef get_phi(atoms, n):\n return -4 * np.pi * atoms.Linv(atoms.O(atoms.J(n)))\n```\n\n## Installation\n\nThe [package](https://pypi.org/project/eminus) and all necessary dependencies can be installed with\n\n```terminal\npip install eminus\n```\n\nMore information about installing eminus can be found [here](https://wangenau.gitlab.io/eminus/installation.html).\n\n## Documentation\n\nTo learn more about the features, usage, or implementation of eminus, take a look inside the [documentation](https://wangenau.gitlab.io/eminus).\n\n## Citation\n\nA supplementary paper is available on [arXiv](https://arxiv.org/abs/2410.19438). The following BibTeX key can be used\n\n```terminal\n@Misc{Schulze2021,\n author = {Schulze, Wanja T. and Schwalbe, Sebastian and Trepte, Kai and Gr{\\\"a}fe, Stefanie},\n title = {eminus -- Pythonic electronic structure theory},\n year = {2024},\n doi = {10.48550/arXiv.2410.19438},\n publisher = {arXiv},\n}\n```\n\nTo cite a specific version one can select and cite it with [Zenodo](https://doi.org/10.5281/zenodo.5720635).\n\n## License\n\nThis project is licensed under the Apache 2.0 License. See the [license page](https://wangenau.gitlab.io/eminus/license.html) for more details.\n",
"bugtrack_url": null,
"license": null,
"summary": "Pythonic electronic structure theory.",
"version": "3.0.1",
"project_urls": {
"Changelog": "https://wangenau.gitlab.io/eminus/changelog.html",
"Documentation": "https://wangenau.gitlab.io/eminus",
"Issues": "https://gitlab.com/wangenau/eminus/-/issues",
"Repository": "https://gitlab.com/wangenau/eminus"
},
"split_keywords": [
"density-functional-theory",
" electronic-structure",
" education",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a81687de95aca6fece34a11135c2f9f81037c881b294df8d04426a8f88633683",
"md5": "0ecb46493c9c29fcdda3130a2d1a7576",
"sha256": "116162cce7d9e87eb4b904e553cab083a6445b48549e34c0913f7e6e6213fe6a"
},
"downloads": -1,
"filename": "eminus-3.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ecb46493c9c29fcdda3130a2d1a7576",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 251310,
"upload_time": "2024-12-18T08:59:06",
"upload_time_iso_8601": "2024-12-18T08:59:06.879934Z",
"url": "https://files.pythonhosted.org/packages/a8/16/87de95aca6fece34a11135c2f9f81037c881b294df8d04426a8f88633683/eminus-3.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0fa91bf1b47c64b4856e39ddac37c28fbdef82163022c4b1c7766a564f854a31",
"md5": "5bb4a03f9551479e808ca2f555fcf596",
"sha256": "ed0fa06d22c657a95c69b2f03aeba9ab376372bdb0494bf814e82102ca7fc18b"
},
"downloads": -1,
"filename": "eminus-3.0.1.tar.gz",
"has_sig": false,
"md5_digest": "5bb4a03f9551479e808ca2f555fcf596",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 180805,
"upload_time": "2024-12-18T08:59:09",
"upload_time_iso_8601": "2024-12-18T08:59:09.794592Z",
"url": "https://files.pythonhosted.org/packages/0f/a9/1bf1b47c64b4856e39ddac37c28fbdef82163022c4b1c7766a564f854a31/eminus-3.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 08:59:09",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "wangenau",
"gitlab_project": "eminus",
"lcname": "eminus"
}
JSON