Merge pull request #5 from jiaboli007/main

# PyMOL ChatGPT Plugin

<!-- ![img](./assets/img.png) -->

## Overview

The PyMOL ChatGPT Plugin is a simple yet powerful tool that integrates OpenAI's GPT-3.5-turbo model into PyMOL, allowing users to interact with the model and get relevant suggestions, explanations, and guidance on various PyMOL-related topics.

The PyMOL ChatGPT Plugin seamlessly integrates OpenAI's GPT-3.5-turbo model into PyMOL, enabling users to interact with PyMOL through natural language instructions. This powerful tool simplifies PyMOL tasks and provides suggestions, explanations, and guidance on various PyMOL-related topics.

## Requirements

- PyMOL

- OpenAI Python package: `pip install openai`

- OpenAI Python package: To install, enter `pip install openai` in the PyMOL command line.

## Installation

1. Download the plugin script `chatgpt_plugin.py` and save it to a convenient location on your computer.

1. Download the plugin script `chatgpt.py` and save it to a convenient location on your computer.

2. Open PyMOL.

3. In the PyMOL command line, enter `run /path/to/chatgpt_plugin.py` (replace `/path/to` with the actual path to the script).

3. In the PyMOL command line, enter `run /path/to/chatgpt.py` (replace `/path/to` with the actual path to the script).

4. The plugin is now installed and ready to use.

Or:

Alternatively, you can use the following command to load the plugin directly:

```

load https://raw.githubusercontent.com/JinyuanSun/ChatMol/main/chatmol.py

## Usage

1. Set your OpenAI API key by entering the following command in the PyMOL command line: `set_api_key your_api_key_here` (replace `your_api_key_here` with your actual API key). The API key will be saved in the same directory as the plugin script for future use.

2. To interact with ChatGPT, simply use the `chatgpt` command followed by your question or message in the PyMOL command line, e.g., `chatgpt "How do I align two proteins?"`.

2. Ask ChatGPT about how to perform PyMOL tasks. Use the `chatgpt` command followed by your question or message in the PyMOL command line, e.g., `chatgpt "How do I align two proteins?”`. You will receive a helpful response such as:

```text

ChatGPT: To align two proteins in PyMOL, you can use the `align` command. Here's an example: 

In this example, we use the `name` selection operator to select only the alpha-carbon atoms (`ca`) of both structures for the alignment.

```

3. You can let `ChatMol` to automatically run the code following your command, e.g., `chatgpt How do I color a protein by secondary structure?, True`.

3. Execute PyMOL commands automatically with the ChatGPT Plugin by adding a command execution flag “True” at the end of the prompt, like `chatgpt How do I color a protein by secondary structure?, True`.

![img](./assets/img2.png)

## Features

- Simple integration with PyMOL.

- Convenient command-line interface.

- Persistent API key storage, ensuring you only need to set the API key once.

- Seamless integration with PyMOL.

- User-friendly command-line interface.

- Persistent API key storage for convenient one-time setup.

- Utilizes OpenAI's GPT-3.5-turbo model for powerful, context-aware suggestions and guidance.

## Limitations

- The plugin relies on the OpenAI API, so an internet connection and API key are required for usage.

- The ChatGPT model's knowledge is based on the training data available up to September 2021.

- The ChatGPT model's knowledge is based on the training data available up to September 

## Support

For any questions or issues related to the PyMOL ChatGPT Plugin, please refer to the official PyMOL mailing list or OpenAI's documentation and support resources.