Skip to content

Commit 15a4023

Browse files
authored
Update README.md
1 parent 4c1b70b commit 15a4023

1 file changed

Lines changed: 47 additions & 9 deletions

File tree

README.md

Lines changed: 47 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,63 @@ Virasign has been validated to classify the diversity of human pathogens well. H
1313

1414
## Installation
1515

16-
### 1. Create Conda Environment with Required Tools
16+
### Prerequisites
17+
First, install conda if you haven't already:
18+
```bash
19+
wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
20+
bash Miniconda3-latest-Linux-x86_64.sh
21+
```
1722

18-
Create a new conda environment with all required tools:
23+
Then, ensure you have the required channels:
24+
```bash
25+
conda config --add channels defaults
26+
conda config --add channels bioconda
27+
conda config --add channels conda-forge
28+
```
1929

30+
### Option 1: Using Conda (Recommended)
31+
Install [virasign via Conda](https://anaconda.org/bioconda/virasign):
2032
```bash
21-
conda create -n virasign python=3.9 -y
33+
conda create -n virasign -c bioconda virasign -y
2234
conda activate virasign
23-
conda install -c bioconda -c conda-forge minimap2=2.24 seqtk=1.3 curl=7.88 samtools=1.17 mmseqs2=15.6f452 -y
2435
```
2536

26-
### 2. Install Virasign
37+
### Option 2: From Source Code
38+
1. Create and activate a new conda environment:
39+
```bash
40+
conda create -n virasign python=3.9 -y
41+
conda activate virasign
42+
conda install -c bioconda -c conda-forge minimap2=2.24 seqtk=1.3 curl=7.88 samtools=1.17 mmseqs2=15.6f452 -y
43+
```
44+
45+
2. Install virasign:
46+
```bash
47+
git clone https://github.com/DaanJansen94/virasign.git
48+
cd virasign
49+
pip install .
50+
```
51+
52+
3. Re-installation (when updates are available):
53+
```bash
54+
conda activate virasign # Make sure you're in the right environment
55+
cd virasign
56+
git pull # Get the latest updates from GitHub
57+
pip uninstall virasign
58+
pip install .
59+
```
60+
Note: Any time you modify the code or pull updates from GitHub, you need to reinstall the package using these commands for the changes to take effect.
61+
62+
## Usage
2763

64+
First, make sure your conda environment is activated:
2865
```bash
29-
git clone https://github.com/DaanJansen94/virasign.git
30-
cd virasign
31-
pip install .
66+
conda activate virasign
3267
```
3368

34-
## Usage
69+
To see all available options:
70+
```bash
71+
virasign --help
72+
```
3573

3674
### Basic Usage
3775

0 commit comments

Comments
 (0)