# mkite_conformer
`mkite_conformer` is a plugin to generate molecular conformers using [RDKit](https://github.com/rdkit/rdkit/).
The plugin has only one recipe implemented: generating and deduplicating conformers.
## Documentation
General tutorial for `mkite` and its plugins are available in the [main documentation](https://mkite.org).
Complete API documentation is pending.
## Installation
To install `mkite_conformer`, use pip:
```bash
pip install mkite_conformer
```
Alternatively, for a development version, clone this repo and install it in editable form:
```bash
pip install -U git+https://github.com/mkite-group/mkite_conformer
```
## Contributions
Contributions to the entire mkite suite are welcomed.
You can send a pull request or open an issue for this plugin or either of the packages in mkite.
When doing so, please adhere to the [Code of Conduct](CODE_OF_CONDUCT.md) in the mkite suite.
The mkite package was created by Daniel Schwalbe-Koda <dskoda@ucla.edu>.
### Citing mkite
If you use mkite in a publication, please cite the following paper:
```bibtex
@article{mkite2023,
title = {mkite: A distributed computing platform for high-throughput materials simulations},
author = {Schwalbe-Koda, Daniel},
year = {2023},
journal = {arXiv:2301.08841},
doi = {10.48550/arXiv.2301.08841},
url = {https://doi.org/10.48550/arXiv.2301.08841},
arxiv={2301.08841},
}
```
## License
The mkite suite is distributed under the following license: Apache 2.0 WITH LLVM exception.
All new contributions must be made under this license.
SPDX: Apache-2.0, LLVM-exception
LLNL-CODE-848161
Raw data
{
"_id": null,
"home_page": null,
"name": "mkite-conformer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "workflow, materials-science, chemistry",
"author": null,
"author_email": "Daniel Schwalbe-Koda <dskoda@ucla.edu>",
"download_url": "https://files.pythonhosted.org/packages/ef/f1/c57aadf7b74968ba97b16b7cd71cda8ce7264498a2f1c47da4ab6715355f/mkite_conformer-24.9.5.tar.gz",
"platform": null,
"description": "# mkite_conformer\n\n`mkite_conformer` is a plugin to generate molecular conformers using [RDKit](https://github.com/rdkit/rdkit/).\nThe plugin has only one recipe implemented: generating and deduplicating conformers.\n\n## Documentation\n\nGeneral tutorial for `mkite` and its plugins are available in the [main documentation](https://mkite.org).\nComplete API documentation is pending.\n\n## Installation\n\nTo install `mkite_conformer`, use pip:\n\n```bash\npip install mkite_conformer\n```\n\nAlternatively, for a development version, clone this repo and install it in editable form:\n\n```bash\npip install -U git+https://github.com/mkite-group/mkite_conformer\n```\n\n## Contributions\n\nContributions to the entire mkite suite are welcomed.\nYou can send a pull request or open an issue for this plugin or either of the packages in mkite.\nWhen doing so, please adhere to the [Code of Conduct](CODE_OF_CONDUCT.md) in the mkite suite.\n\nThe mkite package was created by Daniel Schwalbe-Koda <dskoda@ucla.edu>.\n\n### Citing mkite\n\nIf you use mkite in a publication, please cite the following paper:\n\n```bibtex\n@article{mkite2023,\n title = {mkite: A distributed computing platform for high-throughput materials simulations},\n author = {Schwalbe-Koda, Daniel},\n year = {2023},\n journal = {arXiv:2301.08841},\n doi = {10.48550/arXiv.2301.08841},\n url = {https://doi.org/10.48550/arXiv.2301.08841},\n arxiv={2301.08841},\n}\n```\n\n## License\n\nThe mkite suite is distributed under the following license: Apache 2.0 WITH LLVM exception.\n\nAll new contributions must be made under this license.\n\nSPDX: Apache-2.0, LLVM-exception\n\nLLNL-CODE-848161\n",
"bugtrack_url": null,
"license": null,
"summary": "plugin to deal with conformer generation in mkite",
"version": "24.9.5",
"project_urls": null,
"split_keywords": [
"workflow",
" materials-science",
" chemistry"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "41f06a9cf8c4aa5399945bff253cb9788449c1cff2045a77f720e8feb2c72cc9",
"md5": "a7cd4ba5bbbc4924d61ec0665394d79a",
"sha256": "d82b9d5b4d8deb2cf29a3c232dfcedfef5aedb14d7da4a0a99a64504e6177857"
},
"downloads": -1,
"filename": "mkite_conformer-24.9.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a7cd4ba5bbbc4924d61ec0665394d79a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14796,
"upload_time": "2024-09-05T17:52:47",
"upload_time_iso_8601": "2024-09-05T17:52:47.985070Z",
"url": "https://files.pythonhosted.org/packages/41/f0/6a9cf8c4aa5399945bff253cb9788449c1cff2045a77f720e8feb2c72cc9/mkite_conformer-24.9.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eff1c57aadf7b74968ba97b16b7cd71cda8ce7264498a2f1c47da4ab6715355f",
"md5": "01052d13804f178cd2de945c660a9f1a",
"sha256": "5315710ce32de5f9ddb80ea3ffe19327b47ad4adb02232f48e4afea86b55da32"
},
"downloads": -1,
"filename": "mkite_conformer-24.9.5.tar.gz",
"has_sig": false,
"md5_digest": "01052d13804f178cd2de945c660a9f1a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 15615,
"upload_time": "2024-09-05T17:52:49",
"upload_time_iso_8601": "2024-09-05T17:52:49.636873Z",
"url": "https://files.pythonhosted.org/packages/ef/f1/c57aadf7b74968ba97b16b7cd71cda8ce7264498a2f1c47da4ab6715355f/mkite_conformer-24.9.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-05 17:52:49",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mkite-conformer"
}
JSON