# fodMC - Fermi-orbital descriptor Monte-Carlo
[](https://www.apache.org/licenses/LICENSE-2.0)
[](https://www.fortran90.org/)
[](https://www.python.org/)
[](https://gitlab.com/opensic/fodMC/-/blob/main/README.md)
[](https://doi.org/10.5281/zenodo.6459384)
## Installation
Using pip
```bash
$ pip3 install fodMC
```
or install locally
```bash
$ git clone https://gitlab.com/opensic/fodMC.git
$ cd fodMC
$ pip3 install -e .
```
The Python module is called fodmc.
## Example
Download the CH<sub>4</sub> molecule as [3D mol](http://www.chemspider.com/Chemical-Structure.291.html) file.
Afterwards, run the following Python script
```python
from fodMC.pyfodmc import pyfodmc
from fodMC.pyfodmc.mol2fodmc import mol2fodmc
mol2fodmc('CH4.mol')
pyfodmc.get_guess('PyFLOSIC','CH4.xyz')
```
More 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 fodMC 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/fodMC",
"name": "fodMC",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Kai Trepte",
"author_email": "kai.trepte1987@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9e/77/f456b48d7063e16058686b4a780e39370bfc57a26e9941293ab498f039fb/fodMC-1.2.1.tar.gz",
"platform": null,
"description": "# fodMC - Fermi-orbital descriptor Monte-Carlo \n[](https://www.apache.org/licenses/LICENSE-2.0)\n[](https://www.fortran90.org/)\n[](https://www.python.org/)\n[](https://gitlab.com/opensic/fodMC/-/blob/main/README.md)\n[](https://doi.org/10.5281/zenodo.6459384)\n\n\n## Installation\nUsing pip\n```bash \n$ pip3 install fodMC\n```\nor install locally\n```bash \n$ git clone https://gitlab.com/opensic/fodMC.git\n$ cd fodMC\n$ pip3 install -e .\n```\n\nThe Python module is called fodmc. \n\n## Example \nDownload the CH<sub>4</sub> molecule as [3D mol](http://www.chemspider.com/Chemical-Structure.291.html) file. \nAfterwards, run the following Python script \n```python\nfrom fodMC.pyfodmc import pyfodmc\nfrom fodMC.pyfodmc.mol2fodmc import mol2fodmc\n\nmol2fodmc('CH4.mol')\npyfodmc.get_guess('PyFLOSIC','CH4.xyz')\n```\n\nMore examples 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 fodMC can create FODs for \nany system, we do not recommend using \nguesses for systems containing transition metals.\n\n\n",
"bugtrack_url": null,
"license": "APACHE2.0",
"summary": "Fermi-orbital descriptor Monte-Carlo",
"version": "1.2.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9e77f456b48d7063e16058686b4a780e39370bfc57a26e9941293ab498f039fb",
"md5": "649b7285f91a29d66b013860fbf7f3a5",
"sha256": "bbd6a79aa9e921bebf5b73075e71949cfddc9b4a8a4f5eb3a8d3d28b65897738"
},
"downloads": -1,
"filename": "fodMC-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "649b7285f91a29d66b013860fbf7f3a5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 47338,
"upload_time": "2023-03-10T22:05:18",
"upload_time_iso_8601": "2023-03-10T22:05:18.030726Z",
"url": "https://files.pythonhosted.org/packages/9e/77/f456b48d7063e16058686b4a780e39370bfc57a26e9941293ab498f039fb/fodMC-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-10 22:05:18",
"github": false,
"gitlab": true,
"bitbucket": false,
"gitlab_user": "opensic",
"gitlab_project": "fodMC",
"lcname": "fodmc"
}
JSON