Skip to content

Commit 9e9d45d

Browse files
committed
README updated
1 parent 7c8c22d commit 9e9d45d

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

+28-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,29 @@
11
# RandomStringAssembly
2-
A final project from the course, Algorithm, requires to rebuild a string with its substrings.
2+
A final project from the course, Algorithm, requires to rebuild a string with its substrings. This implementation of sequence assembly is based on **De Bruijn Graph**.
3+
## Prerequisite
4+
- MPICH 3.3.1
5+
- PTHREAD
6+
- C++ 11 supported
7+
## Build this project
8+
1. `mkdir build; cd build`
9+
2. `cmake ../`
10+
3. `make`
11+
12+
## Run the program
13+
After executing the command above, a program named `RandomStringAssembly` is generated in the current directory. It should be run by the command of below:
14+
```
15+
mpiexec -np {the number of processes/hosts} ./RandomStringAssembly {the value of k of k-mer} {input folder} {the filename of the file of reads in the input folder}
16+
```
17+
. Multiple filenames can be splitted by white space following the argument of `{input folder}`.
18+
19+
For example:
20+
21+
- Command for running the program with 6 processes, k-mer with 79 characters, and input file named "reads" in the folder of "input".
22+
```
23+
mpiexec -np 6 ./RandomStringAssembly 79 "input" "reads"
24+
```
25+
26+
- Command for running the program with 6 processes, k-mer with 79 characters, and input files named "reads1" and "reads2" in the folder of "input".
27+
```
28+
mpiexec -np 6 ./RandomStringAssembly 79 "input" "reads1" "reads2"
29+
```

0 commit comments

Comments
 (0)