Skip to content

Commit e84cd1d

Browse files
chagas98r1ckhdkjvsguerra
authored
Add TCRmodel2 to docs (#17)
* add tcrmodel2 module * fix some typos * adjust module commands and add some more tips * adjust text about tcrmodel2 usage * Change md to html text * Some fixes in doc --------- Co-authored-by: r1ckhdk <rick@riseup.net> Co-authored-by: jvsguerra <jvsguerra@gmail.com>
1 parent 664f802 commit e84cd1d

File tree

3 files changed

+72
-0
lines changed

3 files changed

+72
-0
lines changed

src/07-programas-e-aplicativos/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ Os programas e aplicativos relacionados à modelagem, dinâmica molecular, predi
5151

5252
- [AlphaFold](./alphafold/index.html)
5353
- [GROMACS](./gromacs/index.html)
54+
- [TCRmodel2](./tcrmodel2/index.html)
5455

5556
## Descoberta de fármacos (_Drug Discovery_)
5657

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# TCRmodel2
2+
3+
O [TCRmodel2](https://academic.oup.com/nar/article/51/W1/W569/7151345) é um programa de predição de estrutura de proteínas baseado em adaptações do AlphaFold2. Apresenta alta acurácia de predição do complexo TCR:pMHC, assim como, estruturas unbound de TCRs. O tempo de predição (~15 minutos por complexo para as regiões variáveis) também é reduzido em comparação a outros modelos. As predições já possuem resíduos renumerados para o esquema AHo e cadeias renomeadas para MHC (A), peptídeo (C), TCRalpha (D) e TCRbeta (E).
4+
5+
Para mais informações sobre TCRmodel2, acesse <https://github.com/piercelab/tcrmodel2>.
6+
7+
## Carregando o módulo
8+
9+
Para habilitar o TCRmodel2 no HPCC Marvin, você deve carregar o módulo `tcrmodel2`:
10+
11+
```bash
12+
module load tcrmodel2
13+
```
14+
15+
Para acessar a documentação do modulo, utilize:
16+
17+
```bash
18+
module help tcrmodel2
19+
```
20+
21+
## Executando o módulo
22+
23+
O TCRmodel2 oferece dois principais scripts:
24+
25+
- `run_tcrmodel2.py`: predição do complexo TCR:pMHC que pode ser chamado com `tcrmodel2`
26+
- `run_tcrmodel2_ub_tcr.py`: predição de estruturas unbound de TCRs que pode ser chamado com `tcrmodel2_ub_tcr`
27+
28+
Ambos scripts contém diferentes flags. Para obter informações sobre o uso de cada um, execute:
29+
30+
```
31+
tcrmodel2 --help #or
32+
tcrmodel2_ub_tcr --help
33+
```
34+
35+
<div class="warning">
36+
<br>O banco de dados e pesos do AF2 estão na pasta <code>/public</code> do HPC e são necessários para execução dos scripts.</br>
37+
</div>
38+
39+
40+
## Submetendo jobs
41+
42+
A execução do TCRmodel2 no HPCC Marvin é feita por meio de scripts de submissão no SLURM. Para modelar apenas o TCR unbound, crie um arquivo de script, por exemplo `tcrmodel2.sh`, com o seguinte conteúdo:
43+
44+
```bash
45+
#!/bin/bash
46+
#SBATCH --job-name=tcrmodel2
47+
#SBATCH --ntasks=1
48+
#SBATCH --cpus-per-task=6
49+
#SBATCH --partition=short-gpu-small
50+
#SBATCH --mem-per-cpu=8G
51+
#SBATCH --gres=gpu:1g.5gb:5
52+
#SBATCH --output=slurm.out
53+
#SBATCH --error=slurm.error
54+
55+
ml load tcrmodel2
56+
57+
OUTPUT_DIR="/output"
58+
TCRA="GQQVMQIPQYQHVQEGEDFTTYCNSSTTLSNIQWYKQRPGGHPVFLIQLVKSGEVKKQKRLTFQFGEAKKNSSLHITATQTTDVGTYFCAVSYGGSQGNLIFGKGTKLSVKP"
59+
TCRB="DGGITQSPKYLFRKEGQNVTLSCEQNLNHDAMYWYRQDPGQGLRLIYYSQIVNDFQKGDIAEGYSVSREKKESFPLTVTSAQKNPTAFYLCASSIRSTDTQYFGPGTRLTVLE"
60+
61+
tcrmodel2_ub_tcr --job_id=test --output_dir=$OUTPUT_DIR --tcra_seq=$TCRA --tcrb_seq=$TCRB --ori_db=/database/ --tp_db=/opt/tcrmodel2/data/databases --relax_structures=True --max_template_date=2100-01-01
62+
```
63+
Ao carregar o módulo tcrmodel2, ficarão disponíveis dois comandos (**tcrmodel2** e **tcrmodel2_ub_tcr**) para modelar, respectivamente, o complexo inteiro ou somente TCRab. Lembrando que, para modelar o complexo inteiro, siga as instruções do repositório do TCRmodel2 para configurar as flags e substitua o comando `tcrmodel2_ub_tcr` por `tcrmodel2` no script do slurm.
64+
65+
Para submeter o job, salve o script e utilize o comando `sbatch`:
66+
67+
```bash
68+
sbatch tcrmodel2.sh
69+
```
70+

src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@
5555
- [RELION](07-programas-e-aplicativos/relion/README.md)
5656
- [Scipion](07-programas-e-aplicativos/scipion/README.md)
5757
- [seqtk](07-programas-e-aplicativos/seqtk/README.md)
58+
- [TCRmodel2](07-programas-e-aplicativos/tcrmodel2/README.md)
5859
- [Trimmomatic](07-programas-e-aplicativos/trimmomatic/README.md)
5960
- [Sistemas](08-sistemas/README.md)
6061
- [OMERO](08-sistemas/omero/README.md)

0 commit comments

Comments
 (0)