Skip to content

Commit

Permalink
update:readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wdingx committed Jun 12, 2018
1 parent aead203 commit eaf5b03
Showing 1 changed file with 12 additions and 17 deletions.
29 changes: 12 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,28 +23,14 @@ git clone https://github.com/neherlab/pan-genome-analysis.git
cd pan-genome-analysis
```

Install dependencies and then run the test:
Install dependencies via Conda and then run the test:
`sh run-TestSet.sh`

The results can be explored via our interactive [**pan-genome-visualization**](https://github.com/neherlab/pan-genome-visualization) application.

### Dependencies
#### Manual installation
Install these dependencies:
- Required software:
`sudo apt-get install mcl mafft fasttree raxml`
* [MCL](http://micans.org/mcl/)
* [mafft](http://mafft.cbrc.jp/alignment/software/)
* [fasttree](http://www.microbesonline.org/fasttree/)
* [raxml](https://github.com/stamatak/standard-RAxML)
* [DIAMOND](https://github.com/bbuchfink/diamond) (move diamond binary file to a directory included in the executable search path or specify diamond path by the parameter `-dmp`)
- Required python packages:
- `pip install -r requirements.txt`
- [treetime](http://github.com/neherlab/treetime):
`git submodule update --init`

### Installing dependencies
#### Conda
The required software and python packages can be installed via Conda.
The required software and python packages can be easily installed via Conda.
How to download and set up Conda:
```
wget https://repo.continuum.io/miniconda/Miniconda2-latest-Linux-x86_64.sh
Expand All @@ -54,6 +40,15 @@ conda env create -f panX-environment.yml
source activate panX
```

#### Overview of dependencies:
Required software/packages:
* [MCL](http://micans.org/mcl/)
* [mafft](http://mafft.cbrc.jp/alignment/software/)
* [fasttree](http://www.microbesonline.org/fasttree/)
* [raxml](https://github.com/stamatak/standard-RAxML)
* [DIAMOND](https://github.com/bbuchfink/diamond) (move diamond binary file to a directory included in the executable search path or specify diamond path by the parameter `-dmp`)
* [treetime](http://github.com/neherlab/treetime)

### How to run
To run the test set: ` sh run-TestSet.sh `

Expand Down

0 comments on commit eaf5b03

Please sign in to comment.