@@ -15,6 +15,15 @@ DIAMOND can take quite a bit of memory, and if you need to adjust the DIAMOND pa
...
@@ -15,6 +15,15 @@ DIAMOND can take quite a bit of memory, and if you need to adjust the DIAMOND pa
## Installation
## Installation
### Conda installation
The easiest and most reliable way to install SeqScreen is via `conda`. SeqScreen is hosted on [Bioconda](https://bioconda.github.io/user/install.html) and users can install the software as well as dependencies via
```
conda install seqscreen
```
### Alternative installation methods
#### Install from source
The SeqScreen code can be installed and the most recent release checked out with the following command:
The SeqScreen code can be installed and the most recent release checked out with the following command:
In addition to Nextflow, users should also have Bash, Perl, Python 3, Java 8, Miniconda3, SciPy, and Jinja2 installed on their system, as described in the [SeqScreen Dependencies](https://gitlab.com/treangenlab/seqscreen/-/wikis/02.-SeqScreen-Dependencies) wiki page.
In addition to Nextflow, users should also have Bash, Perl, Python 3, Java 8, Miniconda3, SciPy, and Jinja2 installed on their system, as described in the [SeqScreen Dependencies](https://gitlab.com/treangenlab/seqscreen/-/wikis/02.-SeqScreen-Dependencies) wiki page.
### Courtesy Installation Script
#### Courtesy Installation Script
We have compiled and packaged all of the software and database dependencies into an archive that can be downloaded and installed by running the `install/install_seqscreen.py` script in the SeqScreen repository. If, for example, you want to download and extract the required databases and software to `/path/to/requirements`, you would run
We have compiled and packaged all of the software and database dependencies into an archive that can be downloaded and installed by running the `install/install_seqscreen.py` script in the SeqScreen repository. If, for example, you want to download and extract the required databases and software to `/path/to/requirements`, you would run
In the following instance, you would run the SeqScreen pipeline and have it submit jobs to execution nodes on a SLURM-supported grid, where each CPU-intense job will request 30 cores per node:
In the following instance, you would run the SeqScreen pipeline and have it submit jobs to execution nodes on a SLURM-supported grid, where each CPU-intense job will request 30 cores per node: