Skip to content

Commit

Permalink
Update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
misialq committed Jan 6, 2025
1 parent 85de260 commit 04428fd
Showing 1 changed file with 6 additions and 21 deletions.
27 changes: 6 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,19 @@

A [QIIME 2](https://qiime2.org) Plugin for detecting viral genomes and assessing their quality.

### Install development version of `q2-viromics`
Clone the repository:
```shell
git clone https://github.com/bokulich-lab/q2-viromics.git
cd q2-viromics
```

Then, run:

```shell
mamba create -n q2-viromics -c conda-forge -c bioconda -c https://packages.qiime2.org/qiime2/2024.10/metagenome/passed/ -c defaults q2cli q2-types checkv pyhmmer
```

### Activate q2-viromics environment
```shell
conda activate q2-viromics
```
## Installation
_q2-viromics_ is available as part of the QIIME 2 pathogenome distribution. For installation and usage instructions please consult the official [QIIME 2 documentation](https://docs.qiime2.org).


### Test it out!
#### Download sample input [datasets](https://polybox.ethz.ch/index.php/s/9jlQ4oyDWvWyvpB)
## Usage
Start by downloading sample input [datasets](https://polybox.ethz.ch/index.php/s/9jlQ4oyDWvWyvpB).

Fetch the checkV database.
Fetch the checkV database:
```bash
qiime viromics checkv-fetch-db --o-database checkV_db.qza --verbose
```

Run the CheckV analysis.
Run the CheckV analysis:
```bash
qiime viromics checkv-analysis --i-sequences genomad_output/viruses.qza --i-database checkV_db.qza --p-num-threads 4 --output-dir checkV_output --verbose
```

0 comments on commit 04428fd

Please sign in to comment.