Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chamiyeah authored Jan 18, 2024
1 parent a54e9ae commit ffcc4af
Showing 1 changed file with 45 additions and 3 deletions.
48 changes: 45 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,47 @@
# ESMFold - Evolutionary-scale prediction of atomic-level protein structure with a language model
# ESMFold - Evolutionary-scale Prediction of Atomic-level Protein Structure with a Language Model

This repository project is a python base application which utilize the ESMFold model to predict protein structures. ESMfold is an end-to-end single sequence protein structure predictor based on the ESM-2 language model. Data model and the application is based on works by metaAI ESM project.
## Overview

### Prerequisites
ESMFold is a Python-based application designed for predicting protein structures using the ESMFold model. This model is an end-to-end single sequence protein structure predictor built on the ESM-2 language model. The code in this repository is inspired by the works of the MetaAI ESM project.

## Prerequisites

Before using the ESMFold Protein Structure Predictor, make sure you have the following dependencies installed:

```bash
pip install streamlit stmol py3Dmol requests biotite
```
## Usage

1. Clone the repository:
```bash
git clone https://github.com/your-username/ESMFold.git
cd ESMFold
```

2. Install dependencies:
```bash
pip install -r requirements.txt
```

3. Run the application:
```bash
streamlit run esmfold_app.py
```
4. Open your browser and navigate to the provided URL.

## Features

Protein Sequence Input: Enter the protein sequence of interest using the sidebar text area.

Prediction: Click the "Predict" button to initiate the prediction of the protein structure.

3D Visualization: The predicted protein structure is visualized in 3D using the Py3Dmol library. Rotate and zoom functionalities are available.

Confidence Score: The per-residue confidence score (pLDDT) is displayed, indicating the confidence in the prediction.

Download PDB File: Download the predicted protein structure in PDB format.

## Additional Information

The ESMFold model is an end-to-end single sequence protein structure predictor based on the ESM-2 language model. The model and this app are inspired by the Meta AI ESMfold. For more information, refer to Meta AI's blog post.

0 comments on commit ffcc4af

Please sign in to comment.