Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Magnushhoie committed Jun 6, 2024
1 parent f3ea7a5 commit cda0656
Showing 1 changed file with 26 additions and 26 deletions.
52 changes: 26 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,16 @@
# Overview

[DiscoTope-3.0](https://services.healthtech.dtu.dk/services/DiscoTope-3.0/) is a structure-based B-cell epitope prediction tool, exploiting inverse folding latent representations from the [ESM-IF1](https://github.com/facebookresearch/esm) model. The tool accepts input protein structures in the [PDB](https://en.wikipedia.org/wiki/Protein_Data_Bank_(file_format)) format (solved or predicted), and outputs per-residue epitope propensity scores in both a PDB and CSV format.
DiscoTope-3.0 predicts epitopes on input protein structures, using inverse folding representations from the [ESM-IF1](https://github.com/facebookresearch/esm) model.
The tool accepts both solved and predicted structures in the PDB format, and outputs per-residue epitope propensity scores in a CSV format.

DiscoTope-3.0 accepts both experimental and AlphaFold2 modeled structures, with similar performance for both. It has been trained and validated only on single chain structures.

- Paper: [10.1101/2023.02.05.527174](https://www.biorxiv.org/content/10.1101/2023.02.05.527174v1)
- Datasets: https://services.healthtech.dtu.dk/service.php?DiscoTope-3.0
- Web server DTU: https://services.healthtech.dtu.dk/service.php?DiscoTope-3.0
- Web server BioLib: https://biolib.com/DTU/DiscoTope-3/
- Paper: [10.3389/fimmu.2024.1322712](https://www.frontiersin.org/journals/immunology/articles/10.3389/fimmu.2024.1322712/full)
- Datasets: [https://services.healthtech.dtu.dk/service.php?DiscoTope-3.0](https://services.healthtech.dtu.dk/service.php?DiscoTope-3.0)
- Web server DTU: [https://services.healthtech.dtu.dk/service.php?DiscoTope-3.0](https://services.healthtech.dtu.dk/services/DiscoTope-3.0/)
- Mirror (BioLib): [https://biolib.com/DTU/DiscoTope-3/](https://biolib.com/DTU/DiscoTope-3/)

# Colab
To test the method out without installing it you can try this: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1sMmzzno5fAeGb-r0D7R6lqo9Tld9LYiq)

# Repo contents

- [data](./data): Example input files, including test set
- [discotope3](./discotope3): Source code
- [output](./output): DiscoTope-3.0 output examples

### Recommended system requirements
- GPU is optional. Recommended 16 GB ram, 2+ cores CPU.
- Linux operating system (e.g. Ubuntu 18.04), but works on MacOS
- [Python 3.9](https://www.python.org/downloads/)
- [Pytorch 1.11](https://pytorch.org/get-started/locally/)
- [cudatoolkit 11.3](https://anaconda.org/anaconda/cudatoolkit)
- [Pytorch geometric 2.0.4](https://github.com/pyg-team/pytorch_geometric)
- [Biopython](https://github.com/biopython/biopython)
- [Biotite](https://github.com/biotite-dev/biotite)
- [pandas](https://github.com/pandas-dev/pandas)
- [numpy](https://github.com/numpy/numpy)
- [py-xgboost-gpu](https://xgboost.readthedocs.io/en/stable/install.html)

# Quickstart guide

```bash
Expand All @@ -53,6 +33,12 @@ python discotope3/main.py --pdb_or_zip_file data/example_pdbs_solved/7c4s.pdb
python discotope3/main.py --cpu_only --pdb_or_zip_file data/example_pdbs_solved/7c4s.pdb
```

# Repo contents

- [data](./data): Example input files, including test set
- [discotope3](./discotope3): Source code
- [output](./output): DiscoTope-3.0 output examples

# Installation guide

We highly recommend using an Ubuntu OS and Conda ([miniconda](https://docs.conda.io/en/main/miniconda.html) or [anaconda](https://www.anaconda.com/products/distribution)) for installing required dependencies.
Expand Down Expand Up @@ -80,6 +66,20 @@ pip install -r requirements_recommended.txt
pip install .
```

### Recommended system requirements
- GPU is optional. Recommended 16 GB ram, 2+ cores CPU.
- Linux operating system (e.g. Ubuntu 18.04), but works on MacOS
- [Python 3.9](https://www.python.org/downloads/)
- [Pytorch 1.11](https://pytorch.org/get-started/locally/)
- [cudatoolkit 11.3](https://anaconda.org/anaconda/cudatoolkit)
- [Pytorch geometric 2.0.4](https://github.com/pyg-team/pytorch_geometric)
- [Biopython](https://github.com/biopython/biopython)
- [Biotite](https://github.com/biotite-dev/biotite)
- [pandas](https://github.com/pandas-dev/pandas)
- [numpy](https://github.com/numpy/numpy)
- [py-xgboost-gpu](https://xgboost.readthedocs.io/en/stable/install.html)


## Running DiscoTope-3.0

DiscoTope-3.0 can predict a single PDB, a folder or ZIP file of PDBs, or fetch PDBs using their IDs from RCSB or AlphafoldDB to predict them.
Expand Down

0 comments on commit cda0656

Please sign in to comment.