<img src="https://github.com/GRONINGEN-MICROBIOME-CENTRE/MicrobeRX/blob/main/img/logo.png?raw=true" width="320" height="300">
[**Description**](#description) | [**Requirements**](#requirements) | [**Installation**](#installation) | [**Tutorials**](#tutorials) | [**Workflow**](#workflow) | [**Citation**](#citation) | [**License**](#license) | [**Information**](#information) | [**Disclaimer**](#disclaimer)
[](https://doi.org/10.5281/zenodo.8207745)
- [GitHub](https://github.com/GRONINGEN-MICROBIOME-CENTRE/MicrobeRX)
- [Read the Docs](https://microberx.readthedocs.io/)
## Description
**MicrobeRX is A tool for enzymatic reaction-based metabolite prediction in the gut microbiome.** <br><br>
> The main publication and details about the tool can be found in this publication:
[publication here]()
> The python library was developed to be integrated easily with any other bioinformatic or cheminformatic tool.
> This repository contains examples as Jupyter Notbooks showing the capabilities of this library.
Question about usage or troubleshooting? Please leave a comment in the discussion section of this repo
## Requirements
MicrobeRX is reliant on a variety of academic software. The following are some of the most noticeable:
- rdkit
- datamol
- pyopenms
- pubchempy
- pandas
- plotly
- mols2grid
- rxnMapper
- ReactionDecoder
## Installation
**1. Installing MicrobeRX from PIP:**
```
pip install MicrobeRX
```
**2. Installing MicrobeRX from source:**
```
git clone https://github.com/GRONINGEN-MICROBIOME-CENTRE/MicrobeRX.git
cd MicrobeRX
python setup.py install
```
**3. Using MicrobeRX in GoogleColab:**
[MicrobeRX Colab](https://shorturl.at/cpqu4)
## Tutorials
- [Generation of Reaction Rules](https://microberx.readthedocs.io/en/latest/tutorials/ReactionRules.html)
- [Prediction of Metabolites](https://microberx.readthedocs.io/en/latest/tutorials/PredictionMetabolites.html)
- [Omics Integrator](https://microberx.readthedocs.io/en/latest/tutorials/OmicsIntegrator.html)
- [MicrobeRX API](https://microberx.readthedocs.io/en/latest/autoapi/index.html)
## Workflow
<img src="https://github.com/GRONINGEN-MICROBIOME-CENTRE/MicrobeRX/blob/main/img/workflow.png?raw=true" width="600" height="800">
## Citation
If you use this software or its results in your research, publication, or project, please cite it as follows:
> Ruiz-Moreno AJ, Fu J. MicrobeRX: A tool for enzymatic reaction-based metabolite prediction in the gut microbiome [DOI: 10.5281/zenodo.10204312](https://zenodo.org/record/10204312)
## License
This tool is under GPL-3.0 license, see the LICENSE file for details.
## Information
- This release includes the functionalities to generate reaction rules
- This release includes the functionalities to predict, analyze and visualize metabolites.
- This release includes the functionalities to find microorganism and enzymes.
## Disclaimer
This software is still under development and may contain bugs or errors. The developers do not guarantee the accuracy, completeness, or reliability of the software or its results. Use it at your own risk and discretion. The software is provided "as is" without any warranty of any kind, either express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. The developers are not liable for any damages, losses, or costs arising from the use of the software or its results.
Raw data
{
"_id": null,
"home_page": "https://github.com/GRONINGEN-MICROBIOME-CENTRE/MicrobeRX",
"name": "MicrobeRX",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "python,metabolite,prediction,microbiome,cheminformatics,metabolism",
"author": "GRONINGEN-MICROBIOME-CENTRE (Angel J. Ruiz-Moreno)",
"author_email": "<angel.j.ruiz.moreno@gmail.com>",
"download_url": "https://github.com/GRONINGEN-MICROBIOME-CENTRE/MicrobeRX",
"platform": null,
"description": "\n<img src=\"https://github.com/GRONINGEN-MICROBIOME-CENTRE/MicrobeRX/blob/main/img/logo.png?raw=true\" width=\"320\" height=\"300\">\n\n[**Description**](#description) | [**Requirements**](#requirements) | [**Installation**](#installation) | [**Tutorials**](#tutorials) | [**Workflow**](#workflow) | [**Citation**](#citation) | [**License**](#license) | [**Information**](#information) | [**Disclaimer**](#disclaimer)\n\n[](https://doi.org/10.5281/zenodo.8207745)\n\n\n\n- [GitHub](https://github.com/GRONINGEN-MICROBIOME-CENTRE/MicrobeRX)\n\n- [Read the Docs](https://microberx.readthedocs.io/)\n\n## Description\n\n**MicrobeRX is A tool for enzymatic reaction-based metabolite prediction in the gut microbiome.** <br><br>\n\n> The main publication and details about the tool can be found in this publication:\n\n[publication here]()\n\n> The python library was developed to be integrated easily with any other bioinformatic or cheminformatic tool.\n\n> This repository contains examples as Jupyter Notbooks showing the capabilities of this library.\n\nQuestion about usage or troubleshooting? Please leave a comment in the discussion section of this repo\n\n## Requirements\n\nMicrobeRX is reliant on a variety of academic software. The following are some of the most noticeable:\n\n- rdkit\n- datamol\n- pyopenms\n- pubchempy\n- pandas\n- plotly\n- mols2grid\n- rxnMapper\n- ReactionDecoder\n\n## Installation \n\n**1. Installing MicrobeRX from PIP:**\n\n```\npip install MicrobeRX\n```\n\n**2. Installing MicrobeRX from source:**\n\n```\ngit clone https://github.com/GRONINGEN-MICROBIOME-CENTRE/MicrobeRX.git\ncd MicrobeRX\npython setup.py install\n```\n\n**3. Using MicrobeRX in GoogleColab:**\n\n[MicrobeRX Colab](https://shorturl.at/cpqu4)\n\n## Tutorials\n\n- [Generation of Reaction Rules](https://microberx.readthedocs.io/en/latest/tutorials/ReactionRules.html)\n- [Prediction of Metabolites](https://microberx.readthedocs.io/en/latest/tutorials/PredictionMetabolites.html)\n- [Omics Integrator](https://microberx.readthedocs.io/en/latest/tutorials/OmicsIntegrator.html)\n- [MicrobeRX API](https://microberx.readthedocs.io/en/latest/autoapi/index.html)\n\n## Workflow\n\n<img src=\"https://github.com/GRONINGEN-MICROBIOME-CENTRE/MicrobeRX/blob/main/img/workflow.png?raw=true\" width=\"600\" height=\"800\">\n\n## Citation\n\nIf you use this software or its results in your research, publication, or project, please cite it as follows:\n\n> Ruiz-Moreno AJ, Fu J. MicrobeRX: A tool for enzymatic reaction-based metabolite prediction in the gut microbiome [DOI: 10.5281/zenodo.10204312](https://zenodo.org/record/10204312)\n\n## License\nThis tool is under GPL-3.0 license, see the LICENSE file for details.\n\n## Information\n\n- This release includes the functionalities to generate reaction rules\n- This release includes the functionalities to predict, analyze and visualize metabolites.\n- This release includes the functionalities to find microorganism and enzymes.\n\n## Disclaimer \n\nThis software is still under development and may contain bugs or errors. The developers do not guarantee the accuracy, completeness, or reliability of the software or its results. Use it at your own risk and discretion. The software is provided \"as is\" without any warranty of any kind, either express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. The developers are not liable for any damages, losses, or costs arising from the use of the software or its results.\n",
"bugtrack_url": null,
"license": "",
"summary": "MicrobeRX is A tool for enzymatic reaction-based metabolite prediction in the gut microbiome.",
"version": "0.2.6",
"project_urls": {
"Download": "https://github.com/GRONINGEN-MICROBIOME-CENTRE/MicrobeRX",
"Homepage": "https://github.com/GRONINGEN-MICROBIOME-CENTRE/MicrobeRX"
},
"split_keywords": [
"python",
"metabolite",
"prediction",
"microbiome",
"cheminformatics",
"metabolism"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "011b55c01d9061db2fc0f5d2e514f1e1b7fc1fd76d81466e6795c666de5844a9",
"md5": "af6545862f0ba4d06c0fa6cfc266eb48",
"sha256": "aef02df3c96ab1c06a51a8bc9160fb5b1bba1769a999e5023ab4b161840e64d6"
},
"downloads": -1,
"filename": "MicrobeRX-0.2.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "af6545862f0ba4d06c0fa6cfc266eb48",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 50729954,
"upload_time": "2024-01-31T10:29:29",
"upload_time_iso_8601": "2024-01-31T10:29:29.133069Z",
"url": "https://files.pythonhosted.org/packages/01/1b/55c01d9061db2fc0f5d2e514f1e1b7fc1fd76d81466e6795c666de5844a9/MicrobeRX-0.2.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-31 10:29:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GRONINGEN-MICROBIOME-CENTRE",
"github_project": "MicrobeRX",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "microberx"
}
JSON
