Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/WGLab/NanoCaller
Browse files Browse the repository at this point in the history
removing unnecessary files
  • Loading branch information
umahsn committed Dec 7, 2020
2 parents 5c3925a + 6664e57 commit 60627cf
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/Install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Installation

NanoCaller has been developed and tested to work with Linux OS; we do not recommend using Windows or Mac OS. NanoCaller does not require a GPU or any other special hardware to run.
There are two ways to install and run NanoCaller, via docker or conda.
## Conda Installation
First, install Miniconda, a minimal installation of Anaconda, which is much smaller and has a faster installation.
Note that this version is meant for Linux below, macOS and Windows have a different script:

```
curl -O https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
bash Miniconda3-latest-Linux-x86_64.sh
```

Go through all the prompts (installation in `$HOME` is recommended). After Anaconda is installed successfully, simply run:

```
git clone https://github.com/WGLab/NanoCaller.git
cd NanoCaller
conda env create -f environment.yml
conda activate NanoCaller
```
The installation should take about 10 minutes, including the installation of Miniconda.

0 comments on commit 60627cf

Please sign in to comment.