<h1 align="center">
<br>
<a href="https://github.com/Kohulan/Smiles-TO-iUpac-Translator"><img src="https://github.com/Kohulan/Smiles-TO-iUpac-Translator/blob/development/docs/_static/STOUT.png?raw=true" alt="STOUT Logo" width="400"></a>
<br>
V2.0
<br>
</h1>
<h4 align="center">Smiles TO iUpac Translator: Advanced Chemical Nomenclature Translation</h4>
<p align="center">
<a href="https://opensource.org/licenses/MIt">
<img src="https://img.shields.io/badge/License-MIT%202.0-blue.svg" alt="License">
</a>
<a href="https://github.com/Kohulan/Smiles-TO-iUpac-Translator/graphs/commit-activity">
<img src="https://img.shields.io/badge/Maintained%3F-yes-blue.svg" alt="Maintenance">
</a>
<a href="https://github.com/Kohulan/Smiles-TO-iUpac-Translator/actions/workflows/Check_errors.yml">
<img src="https://github.com/Kohulan/Smiles-TO-iUpac-Translator/actions/workflows/Check_errors.yml/badge.svg" alt="Workflow">
</a>
<br>
<a href="https://GitHub.com/Kohulan/Smiles-TO-iUpac-Translator/issues/">
<img src="https://img.shields.io/github/issues/Kohulan/Smiles-TO-iUpac-Translator.svg" alt="GitHub issues">
</a>
<a href="https://GitHub.com/Kohulan/Smiles-TO-iUpac-Translator/graphs/contributors/">
<img src="https://img.shields.io/github/contributors/Kohulan/Smiles-TO-iUpac-Translator.svg" alt="GitHub contributors">
</a>
<a href="https://www.tensorflow.org">
<img src="https://img.shields.io/badge/TensorFlow-2.15.0-FF6F00.svg?style=flat&logo=tensorflow" alt="tensorflow">
</a>
<br>
<a href="https://GitHub.com/Kohulan/Smiles-TO-iUpac-Translator/releases/">
<img src="https://img.shields.io/github/release/Kohulan/Smiles-TO-iUpac-Translator.svg" alt="GitHub release">
</a>
<a href="https://pypi.org/project/STOUT-pypi/">
<img src="https://badge.fury.io/py/STOUT-pypi.svg" alt="PyPI version">
</a>
<a href="https://pypi.org/project/STOUT-pypi/">
<img src="https://img.shields.io/pypi/pyversions/STOUT-pypi.svg" alt="Python versions">
</a>
<a href="https://doi.org/10.5281/zenodo.13318286">
<img src="https://zenodo.org/badge/DOI/10.5281/zenodo.13318286.svg" alt="DOI">
</a>
</p>
<p align="center">
<a href="#key-features">Key Features</a> •
<a href="#installation">Installation</a> •
<a href="#how-to-use">How To Use</a> •
<a href="#acknowledgements">Acknowledgements</a> •
<a href="#citation">Citation</a>
</p>
<p align="center">
<img src="https://github.com/Kohulan/Smiles-TO-iUpac-Translator/raw/master/docs/_static/STOUT_demo.gif" alt="STOUT Demo">
</p>
## Key Features
<ul>
<li>🧪 Translate SMILES to IUPAC names</li>
<li>🔬 Convert IUPAC names back to valid SMILES strings</li>
<li>🤖 Powered by advanced transformer models</li>
<li>💻 Cross-platform support (Linux, macOS, Windows via Ubuntu shell)</li>
<li>🚀 High-performance chemical nomenclature translation</li>
</ul>
## Installation
<p>Choose your preferred installation method:</p>
<details>
<summary><b>📦 PyPI Installation</b></summary>
<pre><code>pip install STOUT-pypi</code></pre>
</details>
<details>
<summary><b>🐍 Conda Environment Setup</b></summary>
<pre><code>conda create --name STOUT python=3.10
conda activate STOUT
conda install -c decimer stout-pypi</code></pre>
</details>
<details>
<summary><b>📥 Direct Repository Installation</b></summary>
<pre><code>pip install git+https://github.com/Kohulan/Smiles-TO-iUpac-Translator.git</code></pre>
</details>
## How To Use
```python
from STOUT import translate_forward, translate_reverse
# SMILES to IUPAC name translation
SMILES = "CN1C=NC2=C1C(=O)N(C(=O)N2C)C"
IUPAC_name = translate_forward(SMILES)
print(f"🧪 IUPAC name of {SMILES} is: {IUPAC_name}")
# IUPAC name to SMILES translation
IUPAC_name = "1,3,7-trimethylpurine-2,6-dione"
SMILES = translate_reverse(IUPAC_name)
print(f"🔬 SMILES of {IUPAC_name} is: {SMILES}")
```
## Acknowledgements
<p align="center">
Research supported with Cloud TPUs from Google's TPU Research Cloud (TRC)
<br><br>
<img src="https://user-images.githubusercontent.com/30716951/220350828-913e6645-6a0a-403c-bcb8-160d061d4606.png" width="200">
</p>
<h2 align="center">Part of the DECIMER Project</h2>
<p align="center">
<a href="https://decimer.ai">
<img src="https://github.com/Kohulan/DECIMER-Image-to-SMILES/raw/master/assets/DECIMER.gif" alt="DECIMER Logo" width="400">
</a>
</p>
<h2 align="center">About Us</h2>
<p align="center">
<a href="https://cheminf.uni-jena.de">
<img src="https://github.com/Kohulan/DECIMER-Image-to-SMILES/blob/master/assets/CheminfGit.png?raw=true" alt="Cheminformatics and Computational Metabolomics Group" width="300">
</a>
</p>
## Citation
<blockquote>
Rajan, K., Zielesny, A. & Steinbeck, C. STOUT: SMILES to IUPAC names using neural machine translation. J Cheminform 13, 34 (2021). https://doi.org/10.1186/s13321-021-00512-4
</blockquote>
## Model Card
<blockquote>
Rajan, K., Steinbeck, C., & Zielesny, A. (2024). STOUT V2 - Model library. Zenodo. https://doi.org/10.5281/zenodo.13318286
</blockquote>
<h2 align="center">Repository Analytics</h2>
<p align="center">
<img src="https://repobeats.axiom.co/api/embed/c66cc0ff5bc3ae91ccc8a3f7ed20eb05c735d753.svg" alt="Repobeats analytics image">
</p>
<hr>
<p align="center">
Made with ❤️ by the <a href="https://cheminf.uni-jena.de">Steinbeck Group</a>
</p>
Raw data
{
"_id": null,
"home_page": "https://github.com/Kohulan/Smiles-TO-iUpac-Translator",
"name": "STOUT-pypi",
"maintainer": "Kohulan Rajan",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "kohulan.rajan@uni-jena.de",
"keywords": null,
"author": "Kohulan Rajan",
"author_email": "kohulan.rajan@uni-jena.de",
"download_url": "https://files.pythonhosted.org/packages/37/4c/c47a273a7ad74941c4f0791b6cd8d4d38a98b838e6bd55ba719c089ae677/stout_pypi-2.1.0.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n <br>\n <a href=\"https://github.com/Kohulan/Smiles-TO-iUpac-Translator\"><img src=\"https://github.com/Kohulan/Smiles-TO-iUpac-Translator/blob/development/docs/_static/STOUT.png?raw=true\" alt=\"STOUT Logo\" width=\"400\"></a>\n <br>\nV2.0\n <br>\n</h1>\n\n<h4 align=\"center\">Smiles TO iUpac Translator: Advanced Chemical Nomenclature Translation</h4>\n\n<p align=\"center\">\n <a href=\"https://opensource.org/licenses/MIt\">\n <img src=\"https://img.shields.io/badge/License-MIT%202.0-blue.svg\" alt=\"License\">\n </a>\n <a href=\"https://github.com/Kohulan/Smiles-TO-iUpac-Translator/graphs/commit-activity\">\n <img src=\"https://img.shields.io/badge/Maintained%3F-yes-blue.svg\" alt=\"Maintenance\">\n </a>\n <a href=\"https://github.com/Kohulan/Smiles-TO-iUpac-Translator/actions/workflows/Check_errors.yml\">\n <img src=\"https://github.com/Kohulan/Smiles-TO-iUpac-Translator/actions/workflows/Check_errors.yml/badge.svg\" alt=\"Workflow\">\n </a>\n <br>\n <a href=\"https://GitHub.com/Kohulan/Smiles-TO-iUpac-Translator/issues/\">\n <img src=\"https://img.shields.io/github/issues/Kohulan/Smiles-TO-iUpac-Translator.svg\" alt=\"GitHub issues\">\n </a>\n <a href=\"https://GitHub.com/Kohulan/Smiles-TO-iUpac-Translator/graphs/contributors/\">\n <img src=\"https://img.shields.io/github/contributors/Kohulan/Smiles-TO-iUpac-Translator.svg\" alt=\"GitHub contributors\">\n </a>\n <a href=\"https://www.tensorflow.org\">\n <img src=\"https://img.shields.io/badge/TensorFlow-2.15.0-FF6F00.svg?style=flat&logo=tensorflow\" alt=\"tensorflow\">\n </a>\n <br>\n <a href=\"https://GitHub.com/Kohulan/Smiles-TO-iUpac-Translator/releases/\">\n <img src=\"https://img.shields.io/github/release/Kohulan/Smiles-TO-iUpac-Translator.svg\" alt=\"GitHub release\">\n </a>\n <a href=\"https://pypi.org/project/STOUT-pypi/\">\n <img src=\"https://badge.fury.io/py/STOUT-pypi.svg\" alt=\"PyPI version\">\n </a>\n <a href=\"https://pypi.org/project/STOUT-pypi/\">\n <img src=\"https://img.shields.io/pypi/pyversions/STOUT-pypi.svg\" alt=\"Python versions\">\n </a>\n <a href=\"https://doi.org/10.5281/zenodo.13318286\">\n <img src=\"https://zenodo.org/badge/DOI/10.5281/zenodo.13318286.svg\" alt=\"DOI\">\n </a>\n</p>\n\n<p align=\"center\">\n <a href=\"#key-features\">Key Features</a> \u2022\n <a href=\"#installation\">Installation</a> \u2022\n <a href=\"#how-to-use\">How To Use</a> \u2022\n <a href=\"#acknowledgements\">Acknowledgements</a> \u2022\n <a href=\"#citation\">Citation</a>\n</p>\n\n<p align=\"center\">\n <img src=\"https://github.com/Kohulan/Smiles-TO-iUpac-Translator/raw/master/docs/_static/STOUT_demo.gif\" alt=\"STOUT Demo\">\n</p>\n\n## Key Features\n\n<ul>\n <li>\ud83e\uddea Translate SMILES to IUPAC names</li>\n <li>\ud83d\udd2c Convert IUPAC names back to valid SMILES strings</li>\n <li>\ud83e\udd16 Powered by advanced transformer models</li>\n <li>\ud83d\udcbb Cross-platform support (Linux, macOS, Windows via Ubuntu shell)</li>\n <li>\ud83d\ude80 High-performance chemical nomenclature translation</li>\n</ul>\n\n## Installation\n\n<p>Choose your preferred installation method:</p>\n\n<details>\n<summary><b>\ud83d\udce6 PyPI Installation</b></summary>\n<pre><code>pip install STOUT-pypi</code></pre>\n</details>\n\n<details>\n<summary><b>\ud83d\udc0d Conda Environment Setup</b></summary>\n<pre><code>conda create --name STOUT python=3.10 \nconda activate STOUT\nconda install -c decimer stout-pypi</code></pre>\n</details>\n\n<details>\n<summary><b>\ud83d\udce5 Direct Repository Installation</b></summary>\n<pre><code>pip install git+https://github.com/Kohulan/Smiles-TO-iUpac-Translator.git</code></pre>\n</details>\n\n## How To Use\n\n```python\nfrom STOUT import translate_forward, translate_reverse\n\n# SMILES to IUPAC name translation\nSMILES = \"CN1C=NC2=C1C(=O)N(C(=O)N2C)C\"\nIUPAC_name = translate_forward(SMILES)\nprint(f\"\ud83e\uddea IUPAC name of {SMILES} is: {IUPAC_name}\")\n\n# IUPAC name to SMILES translation\nIUPAC_name = \"1,3,7-trimethylpurine-2,6-dione\"\nSMILES = translate_reverse(IUPAC_name)\nprint(f\"\ud83d\udd2c SMILES of {IUPAC_name} is: {SMILES}\")\n```\n\n## Acknowledgements\n\n<p align=\"center\">\n Research supported with Cloud TPUs from Google's TPU Research Cloud (TRC)\n <br><br>\n <img src=\"https://user-images.githubusercontent.com/30716951/220350828-913e6645-6a0a-403c-bcb8-160d061d4606.png\" width=\"200\">\n</p>\n\n<h2 align=\"center\">Part of the DECIMER Project</h2>\n\n<p align=\"center\">\n <a href=\"https://decimer.ai\">\n <img src=\"https://github.com/Kohulan/DECIMER-Image-to-SMILES/raw/master/assets/DECIMER.gif\" alt=\"DECIMER Logo\" width=\"400\">\n </a>\n</p>\n\n<h2 align=\"center\">About Us</h2>\n\n<p align=\"center\">\n <a href=\"https://cheminf.uni-jena.de\">\n <img src=\"https://github.com/Kohulan/DECIMER-Image-to-SMILES/blob/master/assets/CheminfGit.png?raw=true\" alt=\"Cheminformatics and Computational Metabolomics Group\" width=\"300\">\n </a>\n</p>\n\n## Citation\n\n<blockquote>\nRajan, K., Zielesny, A. & Steinbeck, C. STOUT: SMILES to IUPAC names using neural machine translation. J Cheminform 13, 34 (2021). https://doi.org/10.1186/s13321-021-00512-4\n</blockquote>\n\n## Model Card\n\n<blockquote>\nRajan, K., Steinbeck, C., & Zielesny, A. (2024). STOUT V2 - Model library. Zenodo. https://doi.org/10.5281/zenodo.13318286\n</blockquote>\n\n<h2 align=\"center\">Repository Analytics</h2>\n\n<p align=\"center\">\n <img src=\"https://repobeats.axiom.co/api/embed/c66cc0ff5bc3ae91ccc8a3f7ed20eb05c735d753.svg\" alt=\"Repobeats analytics image\">\n</p>\n\n<hr>\n\n<p align=\"center\">\n Made with \u2764\ufe0f by the <a href=\"https://cheminf.uni-jena.de\">Steinbeck Group</a> \n</p>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "STOUT V2.0 - Smiles TO iUpac Translator Version 2.0",
"version": "2.1.0",
"project_urls": {
"Homepage": "https://github.com/Kohulan/Smiles-TO-iUpac-Translator"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9ba8037a0a5021c69f4683578de0eae02aa22898b91b88e2089563a30ac7236d",
"md5": "43f0cca4d0e482168bc506983e6d5fe1",
"sha256": "bc0de6e41fcef12b3a721427226f502cef4c55c1103e96039763e6bff8a5d136"
},
"downloads": -1,
"filename": "STOUT_pypi-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "43f0cca4d0e482168bc506983e6d5fe1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 21563,
"upload_time": "2024-08-14T09:04:31",
"upload_time_iso_8601": "2024-08-14T09:04:31.924808Z",
"url": "https://files.pythonhosted.org/packages/9b/a8/037a0a5021c69f4683578de0eae02aa22898b91b88e2089563a30ac7236d/STOUT_pypi-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "374cc47a273a7ad74941c4f0791b6cd8d4d38a98b838e6bd55ba719c089ae677",
"md5": "92f84a34b5a023731c79c78111bd9e70",
"sha256": "27aecb65b8be76c6f66580de46f223147e2cea4f2d37625d089076bed223f3e5"
},
"downloads": -1,
"filename": "stout_pypi-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "92f84a34b5a023731c79c78111bd9e70",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 21117,
"upload_time": "2024-08-14T09:04:34",
"upload_time_iso_8601": "2024-08-14T09:04:34.236801Z",
"url": "https://files.pythonhosted.org/packages/37/4c/c47a273a7ad74941c4f0791b6cd8d4d38a98b838e6bd55ba719c089ae677/stout_pypi-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-14 09:04:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Kohulan",
"github_project": "Smiles-TO-iUpac-Translator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "tensorflow",
"specs": [
[
"==",
"2.15.0"
]
]
},
{
"name": "pystow",
"specs": []
},
{
"name": "unicodedata2",
"specs": []
},
{
"name": "jpype1",
"specs": []
},
{
"name": "rdkit",
"specs": []
}
],
"tox": true,
"lcname": "stout-pypi"
}
JSON
