Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.93 KB

INSTALL.md

File metadata and controls

49 lines (34 loc) · 1.93 KB

BWASP Installation and Setup

Requirements

  • BWASP should run on any platform that supports Singularity (Linux, MacOS), although we have only tested on Linux.

  • BWASP can execute on a single processor machine, but realistically you would want to have 10-20 cores available.

  • BWASP requires a considerable amount of memory (>16 GB) and free disk space (~500 GB for temporary output files for a typical experimental data set).

Installation as a singularity container

Assuming git and singularity are installed on your system, you can get the BWASP code from GitHub and the container from our Singularity Hub as follows:

git clone https://github.com/brendelgroup/BWASP.git
cd BWASP
singularity pull http://BrendelGroup.org/SingularityHub/bwasp.sif
source bin/bwasp_env.sh

Sourcing bwasp_env.sh sets up the environment variables BWASP_ROOT, BWASP_DATA, and BWASP_EXEC. You may want to do this before every run to make sure these variables are in place. For a gentle introduction to singularity, see our group handbook article.

Optional: System-wide Installation

BWASP use via the singularity container is highly recommended, with no known drawbacks. However, if desired, you can of course install all the required software and packages individually on your computer system. The Singularity definition file in this repository should serve as a guide to perform such an installation. The bwasp.sif container was built on the current long-term supported Ubuntu 20.04 distribution and thus the instructions apply to that particular Linux version.

Finally

proceed to the HOWTO document, and we'll tell you how to execute sample workflows (or, equally easy, your very own data analyses).