Skip to content

Commit b8b7f2b

Browse files
Fixed the quick test example in README, added Pixi installation
1 parent 09a2dfa commit b8b7f2b

File tree

1 file changed

+34
-20
lines changed

1 file changed

+34
-20
lines changed

README.md

+34-20
Original file line numberDiff line numberDiff line change
@@ -26,31 +26,21 @@ conda config --set channel_priority strict
2626
mamba install ipk epik
2727
```
2828

29-
Rapid test:
30-
```
31-
# get some test alignment and tree
32-
wget https://github.com/phylo42/IPK/blob/main/tests/data/D652/reference.fasta
33-
wget https://github.com/phylo42/IPK/blob/main/tests/data/D652/tree.rooted.newick
34-
35-
# activate conda environment
36-
conda activate epik
37-
38-
# build database with IPK : using 1 CPU and default phylogenetic model parameters
39-
# a better approach would be to use appropriate parameters, see documentation
40-
ipk.py build --refalign reference.fasta --reftree tree.rooted.newick --states nucl --workdir . --model GTR
29+
## Installation via Pixi
4130

42-
# place with EPIK
43-
epik.py place -i DB.ipk -s nucl -o . reference.fasta
31+
If you find conda slow and clumsy, consider the wonderful [pixi](https://pixi.sh/) manager:
4432

45-
# jplace results
46-
cat placements_reference.fasta.jplace
47-
48-
# you can do post-analyses with the excellent 'gappa' package
49-
# (available in bioconda too, see https://github.com/lczech/gappa)
5033
```
34+
pixi init -c conda-forge -c bioconda
35+
pixi add epik ipk
36+
pixi shell
37+
```
38+
39+
And you're good to go.
5140

41+
## Installation from sources
5242

53-
## Installation via compilation
43+
If you want to get your hands dirty, follow these steps.
5444

5545
### Prerequisites
5646

@@ -67,6 +57,30 @@ sudo apt install build-essential cmake libboost-dev libboost-serialization-dev l
6757
pip3 install click
6858
```
6959

60+
## Quick test
61+
62+
Once you installed EPIK and activated your virtual environment with `conda activate epik` or `pixi shell`, run:
63+
64+
```
65+
# get some test alignment and tree
66+
wget https://github.com/phylo42/IPK/raw/refs/heads/main/tests/data/D652/reference.fasta
67+
wget https://github.com/phylo42/IPK/raw/refs/heads/main/tests/data/D652/tree.rooted.newick
68+
69+
# build database with IPK : using 1 CPU and default phylogenetic model parameters
70+
# a better approach would be to use appropriate parameters, see documentation
71+
ipk.py build --refalign reference.fasta --reftree tree.rooted.newick --states nucl --workdir . --model GTR
72+
73+
# place with EPIK
74+
epik.py place -i DB.ipk -s nucl -o . reference.fasta
75+
76+
# jplace results
77+
cat placements_reference.fasta.jplace
78+
79+
# you can do post-analyses with the excellent 'gappa' package
80+
# (available in bioconda too, see https://github.com/lczech/gappa)
81+
```
82+
83+
7084
### Clone and build
7185
```
7286
git clone --recursive https://github.com/phylo42/EPIK epik

0 commit comments

Comments
 (0)