Skip to content

Commit 2aa9aec

Browse files
authored
ENH update doc
1 parent 2143340 commit 2aa9aec

File tree

1 file changed

+39
-2
lines changed

1 file changed

+39
-2
lines changed

README.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,44 @@ GMSC-mapper can be used to
1313
## Installation
1414

1515
### Source
16+
#### Installation path 1
1617

18+
Clone GMSC-mapper repository
19+
20+
```bash
21+
git clone https://github.com/BigDataBiology/GMSC-mapper.git
22+
```
23+
24+
Create conda environment(only support python v3.8/v3.9)
25+
26+
```bash
27+
conda create -n gmscmapper python=3.8
28+
conda activate gmscmapper
29+
or
30+
conda create -n gmscmapper python=3.9
31+
conda activate gmscmapper
32+
```
33+
34+
You will need the following dependencies:
35+
36+
- [MMseqs2](https://github.com/soedinglab/MMseqs2)
37+
- [Diamond](https://github.com/bbuchfink/diamond)
38+
39+
The easiest way to install the dependencies is with [conda](https://conda.io):
40+
41+
```bash
42+
conda install -c conda-forge -c bioconda mmseqs2
43+
conda install -c bioconda -c conda-forge diamond
44+
```
45+
46+
Once the dependencies are installed, you can install GMSC-mapper by running:
47+
48+
```bash
49+
cd GMSC-mapper
50+
python setup.py install
51+
```
52+
53+
#### Installation path 2
1754
Clone GMSC-mapper repository and execute our installation script.
1855

1956
```bash
@@ -22,7 +59,7 @@ cd GMSC-mapper
2259
./install.sh
2360
```
2461

25-
It should create a conda environment (python vv3.9) called **gmscmapper**
62+
It should create a conda environment (python v3.9) called **gmscmapper**
2663
inserted in the folder `envs/` located in the GMSC-mapper main location.
2764
To call this environment:
2865

@@ -263,4 +300,4 @@ Subcommands: `gmsc-mapper createdb`
263300
* `--quiet`: Disable alignment console output. (default:False)
264301

265302
## Sensitivity choices considering time and memory usage
266-
To be done
303+
To be done

0 commit comments

Comments
 (0)