# ChatMol Python Package
ChatMol is a Python package that provides a seamless integration of large language models into PyMOL, enabling users to interact with PyMOL using natural language instructions. This robust tool simplifies PyMOL tasks and offers suggestions, explanations, and guidance on a wide range of PyMOL-related topics. ChatMol provides various interaction modes with PyMOL, including the PyMOL command line, Python, miniGUI chatbot, and web browsers.
## Installation
```bash
pip install chatmol
```
## Usage
Here are some examples of how to use the package:
```python
import chatmol as cm
output_chatmol_llm = cm.chatlite("download chain A of 3wzm and color it by secondary structure") # use the chatmol llm, free and no API key required
print(output_chatmol_llm)
```
```python
print(cm.defaul_client.gpt_model) # check the current ChatGPT model
output_chatgpt = cm.chat_with_gpt("download 4eb0 and highlight residue number 208") # use the GPT-3.5-turbo llm, API key required
print(output_chatgpt)
```
```python
print(cm.defaul_client.claude_model) # check the current Claude model
output_claude = cm.chat_with_claude("download 1pga from rcsb and show a transprant surface") # use the claude llm, API key required
print(output_claude)
```
You can send results to PyMOL:
```python
import chatmol as cm
ps = cm.start_pymol() # open a PyMOL session with XML-RPC server
ps.chatlite("download 1pga")
# send commands to PyMOL
ps.server.do("esmfold MTYKLILNGKTLKGETTTEAVDAATAEKVFKQYANDNGVDGEWTYDDATKTFTVTE, 1pga_esmfold") # make sure you have pymolfold plugin installed
```
enjoy!
Raw data
{
"_id": null,
"home_page": "https://github.com/JinyuanSun/ChatMol/chatmol_pkg",
"name": "chatmol",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "chatmol",
"author": "The ChatMol Team",
"author_email": "jinyuansun@chatmol.org",
"download_url": "https://files.pythonhosted.org/packages/24/8b/426380227c0ccc2e711ff9e87027be033e19f80d09efa80f54d3afe03b46/chatmol-0.2.3.tar.gz",
"platform": null,
"description": "# ChatMol Python Package\n\nChatMol is a Python package that provides a seamless integration of large language models into PyMOL, enabling users to interact with PyMOL using natural language instructions. This robust tool simplifies PyMOL tasks and offers suggestions, explanations, and guidance on a wide range of PyMOL-related topics. ChatMol provides various interaction modes with PyMOL, including the PyMOL command line, Python, miniGUI chatbot, and web browsers.\n\n## Installation\n\n```bash\npip install chatmol\n```\n\n## Usage\n\nHere are some examples of how to use the package:\n\n```python\nimport chatmol as cm\noutput_chatmol_llm = cm.chatlite(\"download chain A of 3wzm and color it by secondary structure\") # use the chatmol llm, free and no API key required\nprint(output_chatmol_llm)\n```\n\n```python\nprint(cm.defaul_client.gpt_model) # check the current ChatGPT model\noutput_chatgpt = cm.chat_with_gpt(\"download 4eb0 and highlight residue number 208\") # use the GPT-3.5-turbo llm, API key required\nprint(output_chatgpt)\n```\n\n```python\nprint(cm.defaul_client.claude_model) # check the current Claude model\noutput_claude = cm.chat_with_claude(\"download 1pga from rcsb and show a transprant surface\") # use the claude llm, API key required\nprint(output_claude)\n```\n\nYou can send results to PyMOL:\n\n```python\nimport chatmol as cm\nps = cm.start_pymol() # open a PyMOL session with XML-RPC server\nps.chatlite(\"download 1pga\")\n\n# send commands to PyMOL\nps.server.do(\"esmfold MTYKLILNGKTLKGETTTEAVDAATAEKVFKQYANDNGVDGEWTYDDATKTFTVTE, 1pga_esmfold\") # make sure you have pymolfold plugin installed\n```\n\nenjoy!\n",
"bugtrack_url": null,
"license": null,
"summary": "A package for ChatMol",
"version": "0.2.3",
"project_urls": {
"Homepage": "https://github.com/JinyuanSun/ChatMol/chatmol_pkg"
},
"split_keywords": [
"chatmol"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a681ec69519cd31a09f8608071c74d534a972bc8a84b74ec58d3d9c4dc49c3df",
"md5": "a3f0c26249e0e4e930867dfa15cf4018",
"sha256": "44b4b98f586df02a7a760c9f2a706c1f99d34a4c7e5cb3a6746cd7a4892e9eb9"
},
"downloads": -1,
"filename": "chatmol-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a3f0c26249e0e4e930867dfa15cf4018",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5948,
"upload_time": "2024-06-23T06:27:46",
"upload_time_iso_8601": "2024-06-23T06:27:46.794143Z",
"url": "https://files.pythonhosted.org/packages/a6/81/ec69519cd31a09f8608071c74d534a972bc8a84b74ec58d3d9c4dc49c3df/chatmol-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "248b426380227c0ccc2e711ff9e87027be033e19f80d09efa80f54d3afe03b46",
"md5": "b9da2612a15fb9436bb36d1b677b9a17",
"sha256": "5f20164000c9eef33e2351e3af2533cf7a622119978e9d483d795cf600d64c7f"
},
"downloads": -1,
"filename": "chatmol-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "b9da2612a15fb9436bb36d1b677b9a17",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5284,
"upload_time": "2024-06-23T06:27:50",
"upload_time_iso_8601": "2024-06-23T06:27:50.101285Z",
"url": "https://files.pythonhosted.org/packages/24/8b/426380227c0ccc2e711ff9e87027be033e19f80d09efa80f54d3afe03b46/chatmol-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-23 06:27:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JinyuanSun",
"github_project": "ChatMol",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "chatmol"
}
JSON
