Skip to content

Commit

Permalink
docs mod
Browse files Browse the repository at this point in the history
  • Loading branch information
biocodz committed Nov 18, 2019
1 parent 94a8db5 commit 87a9b09
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 27 deletions.
45 changes: 22 additions & 23 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@
* [Building on Linux](#building-on-linux)
* [Install GCC 9](#install-gcc-9)
* [Install Devtoolset 9](#install-devtoolset-9)
* [Install Conda](#install-conda)
* [get Sortmerna sources](#get-sortmerna-sources)
* [Install Conda](#install-conda)
* [Install CMake](#install-cmake)
* [build](#build)
* [Building on Windows](#building-on-windows)
* [Install Visual Studio](#install-visual-studio)
Expand Down Expand Up @@ -63,20 +64,6 @@ TODO.

This section is for RHEL (Centos) distros. Waiting for Devtoolset-9 to become available.

### Install Conda

The following will install Conda in the User's Home directory.

```
pushd $HOME
wget http://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh
bash Miniconda3-latest-Linux-x86_64.sh -b
export PATH=$HOME/miniconda3/bin:$PATH
pip install -U pip
pip install pyyaml
pip install jinja2
```

### get Sortmerna sources

The sources can be placed in any directory, but here we use the user's Home directory
Expand All @@ -95,14 +82,29 @@ pushd sortmerna
git checkout v4.0.0
```

### install CMake
### Install Conda

Use the `build.py` python script provided with Sortmerna distro.
The following installs Conda, and the python packages `pyyaml`, and `jinja2` in the User's Home directory.

```
SMR_HOME=$HOME/sortmerna
python $SMR_HOME/scripts/build.py --name cmake
ls -lrt
drwxrwxr-x 15 biocodz biocodz 4096 Nov 18 09:43 miniconda3
# add Conda binaries to the PATH
export PATH=$HOME/miniconda3/bin:$PATH
```

### Install CMake

Use the Python script provided with the Sortmerna distro
The following installs CMake in user's home directory

```
#
SMR_HOME=$HOME/sortmerna
python $SMR_HOME/scripts/build.py --name cmake_install
python $SMR_HOME/scripts/build.py --name cmake
[cmake_install] Installed CMake /home/biocodz/cmake-3.15.5-Linux-x86_64/bin/cmake
# add cmake to PATH
Expand All @@ -111,15 +113,12 @@ export PATH=$HOME/cmake-3.15.5-Linux-x86_64/bin:$PATH

### build

Use python script provided with the Sortmerna distro.
By default the build is performed in the User directory.
All required third party libraries will be checked and installed automatically (in User directory by default)
The default build won't interfere with any existing system installation.

By default the build produces statically linked executable i.e. portable.

```
# navigate to the Sortmerna source directory SMR_HOME
SMR_HOME=$HOME/sortmerna
# modify configuration (optional)
Expand All @@ -137,7 +136,7 @@ Download and Install VS Community edition from [Visual Studio community website]

### Install Conda

TODO
Installer for Windows can be found [here](https://conda.io/en/latest/miniconda.html)

### get Sortmerna sources

Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ BLAST-like alignments.

# Getting Started

SortMeRNA can be run/built on Linux, and Windows (Mac coming soon).
SortMeRNA 4 can be run/built on Linux, and Windows (Mac coming soon).

## Using GitHub release binaries on Linux

Expand All @@ -38,8 +38,7 @@ Linux distribution is a Shell script with the embedded installation archive.
Issue the following bash commands:

```
pwd
/home/biocodz/
pushd ~
# get the distro
wget https://github.com/biocore/sortmerna/releases/download/v4.0.0/sortmerna-4.0.0-linux.sh
Expand All @@ -58,7 +57,7 @@ bash sortmerna-4.0.0-linux.sh --help
bash sortmerna-4.0.0-Linux.sh --skip-license
sortmerna Installer Version: 4.0.0, Copyright (c) Clarity Genomics
This is a self-extracting archive.
The archive will be extracted to: /home/biocodz/sortmerna
The archive will be extracted to: $HOME/sortmerna
Using target directory: /home/biocodz/sortmerna
Extracting, please wait...
Expand Down

0 comments on commit 87a9b09

Please sign in to comment.