# LabMateAI
**LabMateAI** is an AI-powered recommendation system designed to help researchers discover relevant laboratory tools and software for their scientific needs. Whether you're involved in bioinformatics, genomics, data visualization, or any other scientific domain, LabMateAI makes it easy to find the right resources with simple commands.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [1. Tool Similarity Recommendations](#1-tool-similarity-recommendations)
- [2. Category-Based Recommendations](#2-category-based-recommendations)
- [3. Keyword-Based Search](#3-keyword-based-search)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
---
## Features
- **Tool Similarity Recommendations**: Find tools similar to a specific tool you already use.
- **Category-Based Recommendations**: Discover tools within a specific scientific category.
- **Keyword-Based Search**: Search for tools based on keywords related to your research.
---
## Installation
You can install LabMateAI using `pip`:
```bash
pip install labmateai
```
LabMateAI requires Python 3.8 or higher.
---
## Usage
After installation, you can start using LabMateAI through the command line:
```bash
labmateai
```
This will launch the interactive command-line interface (CLI), where you can choose from the following options:
### 1. Tool Similarity Recommendations
Get recommendations for tools similar to a specific tool.
**Steps**:
1. Select **Recommend tools similar to a specific tool**.
2. Enter the name of the tool (e.g., `BLAST`).
3. Specify the number of recommendations you want.
### 2. Category-Based Recommendations
Discover tools within a specific scientific category.
**Steps**:
1. Select **Recommend tools in a specific category**.
2. Enter the category name (e.g., `Genomics`).
### 3. Keyword-Based Search
Search for tools based on a keyword related to your research.
**Steps**:
1. Select **Search for tools by keyword**.
2. Enter your keyword (e.g., `RNA`).
---
## Contributing
Contributions are welcome!
If you'd like to contribute to LabMateAI, please follow these steps:
1. **Fork the repository** on GitHub.
2. **Create a new branch** for your feature or bug fix:
```bash
git checkout -b feature/your-feature-name
```
3. **Commit your changes** with clear messages:
```bash
git commit -m "Add your clear and descriptive commit message"
```
4. **Push to your branch**:
```bash
git push origin feature/your-feature-name
```
5. **Create a Pull Request** on GitHub, detailing your changes.
Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for more detailed guidelines.
---
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
## Contact
For questions or support, please [contact us.](mailto:tnoblin@health.ucsd.edu).
---
**Disclaimer**: LabMateAI is an open-source project aimed at assisting researchers. While we strive to provide accurate and helpful recommendations, we do not endorse any specific tools or guarantee the suitability of tools for your specific needs.
---
## Acknowledgments
We would like to thank all contributors and the open-source community for their support and valuable contributions to LabMateAI.
Raw data
{
"_id": null,
"home_page": "https://github.com/RLTree/LabMateAI",
"name": "labmateai",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "AI, Recommendation System, Laboratory Tools, Scientific Software, Bioinformatics",
"author": "Terry Noblin",
"author_email": "Terry Noblin <tnoblin@health.ucsd.edu>",
"download_url": "https://files.pythonhosted.org/packages/18/61/9c249ef5b15ee214535fc5fccc6158fe15faea65e1fada904d9be09bb0b7/labmateai-2.0.5.tar.gz",
"platform": null,
"description": "\n# LabMateAI\n\n**LabMateAI** is an AI-powered recommendation system designed to help researchers discover relevant laboratory tools and software for their scientific needs. Whether you're involved in bioinformatics, genomics, data visualization, or any other scientific domain, LabMateAI makes it easy to find the right resources with simple commands.\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n - [1. Tool Similarity Recommendations](#1-tool-similarity-recommendations)\n - [2. Category-Based Recommendations](#2-category-based-recommendations)\n - [3. Keyword-Based Search](#3-keyword-based-search)\n- [Contributing](#contributing)\n- [License](#license)\n- [Contact](#contact)\n\n---\n\n## Features\n\n- **Tool Similarity Recommendations**: Find tools similar to a specific tool you already use.\n- **Category-Based Recommendations**: Discover tools within a specific scientific category.\n- **Keyword-Based Search**: Search for tools based on keywords related to your research.\n\n---\n\n## Installation\n\nYou can install LabMateAI using `pip`:\n\n```bash\npip install labmateai\n```\n\nLabMateAI requires Python 3.8 or higher.\n\n---\n\n## Usage\n\nAfter installation, you can start using LabMateAI through the command line:\n\n```bash\nlabmateai\n```\n\nThis will launch the interactive command-line interface (CLI), where you can choose from the following options:\n\n### 1. Tool Similarity Recommendations\n\nGet recommendations for tools similar to a specific tool.\n\n**Steps**:\n\n1. Select **Recommend tools similar to a specific tool**.\n2. Enter the name of the tool (e.g., `BLAST`).\n3. Specify the number of recommendations you want.\n\n### 2. Category-Based Recommendations\n\nDiscover tools within a specific scientific category.\n\n**Steps**:\n\n1. Select **Recommend tools in a specific category**.\n2. Enter the category name (e.g., `Genomics`).\n\n### 3. Keyword-Based Search\n\nSearch for tools based on a keyword related to your research.\n\n**Steps**:\n\n1. Select **Search for tools by keyword**.\n2. Enter your keyword (e.g., `RNA`).\n\n---\n\n## Contributing\n\nContributions are welcome!\n\nIf you'd like to contribute to LabMateAI, please follow these steps:\n\n1. **Fork the repository** on GitHub.\n2. **Create a new branch** for your feature or bug fix:\n ```bash\n git checkout -b feature/your-feature-name\n ```\n3. **Commit your changes** with clear messages:\n ```bash\n git commit -m \"Add your clear and descriptive commit message\"\n ```\n4. **Push to your branch**:\n ```bash\n git push origin feature/your-feature-name\n ```\n5. **Create a Pull Request** on GitHub, detailing your changes.\n\nPlease refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for more detailed guidelines.\n\n---\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n---\n\n## Contact\n\nFor questions or support, please [contact us.](mailto:tnoblin@health.ucsd.edu).\n\n---\n\n**Disclaimer**: LabMateAI is an open-source project aimed at assisting researchers. While we strive to provide accurate and helpful recommendations, we do not endorse any specific tools or guarantee the suitability of tools for your specific needs.\n\n---\n\n## Acknowledgments\n\nWe would like to thank all contributors and the open-source community for their support and valuable contributions to LabMateAI.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An AI-powered recommendation system for laboratory tools and software.",
"version": "2.0.5",
"project_urls": {
"Bug Reports": "https://github.com/RLTree/LabMateAI/issues",
"Homepage": "https://github.com/RLTree/LabMateAI",
"Source": "https://github.com/RLTree/LabMateAI"
},
"split_keywords": [
"ai",
" recommendation system",
" laboratory tools",
" scientific software",
" bioinformatics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4e9392b5b3d9913b8fade54c710cfa9d2b540a05866934b5eeb34d0460c6c765",
"md5": "64598c7181dbca11140523e081535c5c",
"sha256": "7269ca6ec44bcd4a7a3312ae97f0cdb60fa1cf70fbb416c81e926258b239fab0"
},
"downloads": -1,
"filename": "labmateai-2.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "64598c7181dbca11140523e081535c5c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 58151,
"upload_time": "2024-10-31T20:47:10",
"upload_time_iso_8601": "2024-10-31T20:47:10.669127Z",
"url": "https://files.pythonhosted.org/packages/4e/93/92b5b3d9913b8fade54c710cfa9d2b540a05866934b5eeb34d0460c6c765/labmateai-2.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "18619c249ef5b15ee214535fc5fccc6158fe15faea65e1fada904d9be09bb0b7",
"md5": "4c32fcd6ece63cf9fd727146ee70a87b",
"sha256": "1d16a47c3cd43f1118a0d92845ec2bca39f44d2e2ef7968ca2edfa5fb11b4507"
},
"downloads": -1,
"filename": "labmateai-2.0.5.tar.gz",
"has_sig": false,
"md5_digest": "4c32fcd6ece63cf9fd727146ee70a87b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 48334,
"upload_time": "2024-10-31T20:47:12",
"upload_time_iso_8601": "2024-10-31T20:47:12.179182Z",
"url": "https://files.pythonhosted.org/packages/18/61/9c249ef5b15ee214535fc5fccc6158fe15faea65e1fada904d9be09bb0b7/labmateai-2.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-31 20:47:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RLTree",
"github_project": "LabMateAI",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "labmateai"
}
JSON
