Skip to content

Commit 9e61426

Browse files
Clarify instructions
1 parent 58b5b66 commit 9e61426

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ Singularity recipe for AlphaFold, with example Slurm job script.
44
This splits off my pull request https://github.com/deepmind/alphafold/pull/166
55

66
## Installation Instructions
7-
Check out this repo into the top of the alphafold source tree:
7+
Check out this repo into the top of the alphafold source tree to a directory called `singularity`:
88
```
99
$ cd alphafold-v2.x.x
10-
$ git clone https://github.com/prehensilecode/alphafold_singularity
10+
$ git clone https://github.com/prehensilecode/alphafold_singularity singularity
11+
1112
```
1213

1314
To use, first install the Python requirements:
@@ -22,3 +23,9 @@ sudo singularity build alphafold.sif alphafold_singularity/Singularity.def
2223

2324
If your `/tmp` directory is small, you may need to set the [`SINGULARITY_TMPDIR`
2425
environment variable](https://sylabs.io/guides/3.3/user-guide/build_env.html#temporary-folders) to a directory on a filesystem with more free space.
26+
27+
To run, modify the `$ALPHAFOLD_SRC/singularity/run_singularity.py` and change the
28+
section marked `USER CONFIGURATION`. At the least, you will need to modify the values
29+
of:
30+
- `DOWNLOAD_DIR` - location where AlphaFold databases are downloaded
31+
- `singularity_image` - absolute path to the `alphafold.sif` Singularity image

0 commit comments

Comments
 (0)