examples/alphapulldown_example.md
... ...
@@ -0,0 +1,78 @@
1
+
2
+## ALPHAPULLDOWN
3
+
4
+**CUDA SDK is required**
5
+
6
+Alphapulldown requires that the [CUDA Toolkit](https://developer.nvidia.com/cuda-toolkit) SDK be installed. We use version 11.1 and have had success with latest versions. The executables provided in this package are not redistributable so we do not include them with our CUDA libraries.
7
+
8
+**Required Databases and Parameters**
9
+AlphaPullDown requires the AlphaFold set of (large) genetic databases that must be downloaded separately. See https://github.com/deepmind/alphafold#genetic-databases for more information.
10
+
11
+These databases can be downloaded with the download script included in AlphaFold and the aria2c program, both of which are available in the SBGrid collection. Note that these databases are large in size (> 2Tb) and may require a significant amount of time to download.
12
+
13
+```
14
+/programs/x86_64-linux/alphafold/2.3.2/alphafold/scripts/download_all_data.sh <destination path>
15
+```
16
+
17
+### Examples
18
+
19
+**AlphaPullDown 0.37.0 **
20
+```
21
+#!/usr/bin/env bash
22
+
23
+## SBGrid AlphaPullDown 0.30.7 example
24
+## from https://github.com/KosinskiLab/AlphaPulldown/blob/main/example_1.md
25
+## Args: none
26
+##
27
+## June 27, 2023
28
+
29
+:<<ACKNOWLEDGE
30
+
31
+If your use of SBGrid compiled software was an important element in
32
+your publication, please include the following statement in your work:
33
+"Software used in the project was installed and configured by SBGrid
34
+(cite: eLife 2013;2:e01456, Collaboration gets the most out of software.)
35
+
36
+ACKNOWLEDGE
37
+
38
+
39
+# Set these to local requirements:
40
+module load cuda/11.2
41
+export LD_LIBRARY_PATH=/programs/x86_64-linux/cuda/11.2/lib64
42
+export MY_DATADIR=/programs/local/alphafold-2.3.2
43
+
44
+export SBGRID_ALLOW=true # sbgrid devs only
45
+source /programs/sbgrid.shrc
46
+
47
+export ALPHAPULLDOWN_X=0.30.7
48
+export MY_AP_DIR="./AlphaPulldown/example_data"
49
+export MY_OUTDIR=outdir
50
+mkdir -p ${MY_OUTDIR}
51
+
52
+# Clone github repo in order to get example data here:
53
+git clone https://github.com/KosinskiLab/AlphaPulldown.git
54
+
55
+# Step 1
56
+create_individual_features.py \
57
+ --fasta_paths=${MY_AP_DIR}/baits.fasta,${MY_AP_DIR}/example_1_sequences.fasta \
58
+ --data_dir=${MY_DATADIR} \
59
+ --save_msa_files=False \
60
+ --output_dir=${MY_OUTDIR} \
61
+ --use_precomputed_msas=False \
62
+ --max_template_date="2023-01-01" \
63
+ --skip_existing=False \
64
+
65
+ # Step 2
66
+run_multimer_jobs.py --mode=pulldown \
67
+ --num_cycle=1 \
68
+ --num_predictions_per_model=1 \
69
+ --output_path=${MY_OUTDIR} \
70
+ --data_dir=${MY_DATADIR} \
71
+ --protein_lists=${MY_AP_DIR}/baits.txt,${MY_AP_DIR}/candidates.txt \
72
+ --monomer_objects_dir=${MY_OUTDIR} \
73
+ --job_index=2
74
+
75
+
76
+```
77
+
78
+
... ...
\ No newline at end of file