# PyfodMC - Python Fermi-orbital descriptor Monte-Carlo
[![license](https://img.shields.io/badge/license-APACHE2-green)](https://www.apache.org/licenses/LICENSE-2.0)
[![language](https://img.shields.io/badge/language-Python3-blue)](https://www.python.org/)
[![version](https://img.shields.io/badge/version-1.0.0-lightgrey)](https://gitlab.com/opensic/PyfodMC/-/blob/main/README.md)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6459384.svg)](https://doi.org/10.5281/zenodo.6459384)
## Installation
Using pip
```bash
$ pip3 install PyfodMC
```
or install locally
```bash
$ git clone https://gitlab.com/opensic/PyfodMC.git
$ cd PyfodMC
$ pip3 install -e .
```
Examples can be found in the examples folder.
## Citation
For publications, please consider citing the following articles
- **Interpretation and automatic generation of Fermi-orbital descriptors**
[S. Schwalbe et al., J. Comput. Chem. 40, 2843-2857, 2019](https://onlinelibrary.wiley.com/doi/full/10.1002/jcc.26062)
- **Chemical bonding theories as guides for self-interaction corrected solutions: multiple local minima and symmetry breaking**
K. Trepte, S. Schwalbe, S. Liebing, W. T. Schulze, J. Kortus, H. Myneni, A. V. Ivanov, and S. Lehtola
arXiv e-prints, Subject: Computational Physics (physics.comp-ph), 2021, [arXiv:2109.08199](https://arxiv.org/abs/2109.08199)
[J. Chem. Phys., vol. 155, no. 22, p. 224109, 2021](https://doi.org/10.1063/5.0071796)
- **Why the energy is sometimes not enough - A dive into self-interaction corrected density functional theory**
S. Liebing, K. Trepte, and S. Schwalbe
arXiv e-prints, Subject: Chemical Physics (physics.chem-ph); Computational Physics (physics.comp-ph), 2022, [arXiv:2201.11648](https://arxiv.org/abs/2201.11648)
# ATTENTION
While the PyfodMC can create FODs for
any system, we do not recommend using
guesses for systems containing transition metals.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/opensic/pyfodmc",
"name": "PyfodMC",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Python, FLO-SIC, FODs",
"author": "Kai Trepte",
"author_email": "kai.trepte1987@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a3/ed/14c8e714b2e46b619cd00afe7c10f60dbcf9363405d37840e8109ff0cd3b/pyfodmc-1.0.0.tar.gz",
"platform": null,
"description": "# PyfodMC - Python Fermi-orbital descriptor Monte-Carlo \n[![license](https://img.shields.io/badge/license-APACHE2-green)](https://www.apache.org/licenses/LICENSE-2.0)\n[![language](https://img.shields.io/badge/language-Python3-blue)](https://www.python.org/)\n[![version](https://img.shields.io/badge/version-1.0.0-lightgrey)](https://gitlab.com/opensic/PyfodMC/-/blob/main/README.md)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6459384.svg)](https://doi.org/10.5281/zenodo.6459384)\n\n\n## Installation\nUsing pip\n```bash \n$ pip3 install PyfodMC\n```\nor install locally\n```bash \n$ git clone https://gitlab.com/opensic/PyfodMC.git\n$ cd PyfodMC\n$ pip3 install -e .\n```\n\nExamples can be found in the examples folder.\n\n\n## Citation\nFor publications, please consider citing the following articles \n\n- **Interpretation and automatic generation of Fermi-orbital descriptors** \n [S. Schwalbe et al., J. Comput. Chem. 40, 2843-2857, 2019](https://onlinelibrary.wiley.com/doi/full/10.1002/jcc.26062)\n\n- **Chemical bonding theories as guides for self-interaction corrected solutions: multiple local minima and symmetry breaking** \n K. Trepte, S. Schwalbe, S. Liebing, W. T. Schulze, J. Kortus, H. Myneni, A. V. Ivanov, and S. Lehtola \n arXiv e-prints, Subject: Computational Physics (physics.comp-ph), 2021, [arXiv:2109.08199](https://arxiv.org/abs/2109.08199) \n [J. Chem. Phys., vol. 155, no. 22, p. 224109, 2021](https://doi.org/10.1063/5.0071796)\n\n- **Why the energy is sometimes not enough - A dive into self-interaction corrected density functional theory** \n S. Liebing, K. Trepte, and S. Schwalbe \n arXiv e-prints, Subject: Chemical Physics (physics.chem-ph); Computational Physics (physics.comp-ph), 2022, [arXiv:2201.11648](https://arxiv.org/abs/2201.11648) \n\n\n# ATTENTION\nWhile the PyfodMC can create FODs for \nany system, we do not recommend using \nguesses for systems containing transition metals.\n",
"bugtrack_url": null,
"license": "APACHE2.0",
"summary": "Python Fermi-orbital descriptor Monte-Carlo (PyfodMC)",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://gitlab.com/opensic/pyfodmc"
},
"split_keywords": [
"python",
" flo-sic",
" fods"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6dbd4413c0ef01f0fa44d4145ec77fa315f8297a84d9b20cc0ecd88d4d021b1d",
"md5": "1c3fda72a9df3f0b10281ccd8152acc6",
"sha256": "79d29d9c46ce0255fdc659c3433879d8a5fa8a14516f50d2c4b298843f0b3762"
},
"downloads": -1,
"filename": "PyfodMC-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c3fda72a9df3f0b10281ccd8152acc6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 32506,
"upload_time": "2024-07-10T23:28:59",
"upload_time_iso_8601": "2024-07-10T23:28:59.201099Z",
"url": "https://files.pythonhosted.org/packages/6d/bd/4413c0ef01f0fa44d4145ec77fa315f8297a84d9b20cc0ecd88d4d021b1d/PyfodMC-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a3ed14c8e714b2e46b619cd00afe7c10f60dbcf9363405d37840e8109ff0cd3b",
"md5": "69001230c6080098c323cc4d20c7f36c",
"sha256": "ee4eadf8c2d858c72636036503f15ff002433b5a55ea17833c788f8d809d54b3"
},
"downloads": -1,
"filename": "pyfodmc-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "69001230c6080098c323cc4d20c7f36c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 30702,
"upload_time": "2024-07-10T23:29:01",
"upload_time_iso_8601": "2024-07-10T23:29:01.444236Z",
"url": "https://files.pythonhosted.org/packages/a3/ed/14c8e714b2e46b619cd00afe7c10f60dbcf9363405d37840e8109ff0cd3b/pyfodmc-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-10 23:29:01",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "opensic",
"gitlab_project": "pyfodmc",
"lcname": "pyfodmc"
}