Skip to content

Commit

Permalink
DOC Update install versions
Browse files Browse the repository at this point in the history
  • Loading branch information
luispedro committed May 24, 2022
1 parent 2d73f23 commit 959b4d2
Showing 1 changed file with 13 additions and 57 deletions.
70 changes: 13 additions & 57 deletions docs/sources/install.md
Original file line number Diff line number Diff line change
@@ -1,67 +1,39 @@
# Installation


## Bioconda (binary)

The recommended way to install NGLess is through
[bioconda](http://bioconda.github.io):

conda install -c bioconda ngless

This will install the most recent released version

### Docker

Alternatively, a docker container with NGLess is available at
[biocontainers](https://quay.io/repository/biocontainers/ngless):
[docker hub](https://hub.docker.com/r/nglesstoolkit/ngless):

docker run -v $PWD:/workdir -w /workdir -it quay.io/biocontainers/ngless:0.6.1--py35_0 ngless --version
docker run -v $PWD:/workdir -w /workdir -it nglesstoolkit/ngless:1.4.0-beta1 ngless --version

Adapt the mount flags (``-v``) as needed.
Adapt the mount flags (``-v``) as needed. You can use the `latest` tag to get a
more up to date version as well.


## Linux (binary)

You can get a [statically linked version of NGless
1.1.1](https://github.com/ngless-toolkit/ngless/releases/download/v1.1.1/NGLess-1.1.1-static-Linux64)
or a [nighly build of the latest development
code](https://gitlab.com/ngless/ngless/builds/artifacts/master/raw/bin/ngless?job=build-and-test-ubuntu).
You can download a [statically linked version of NGless
1.4.0-beta](https://github.com/ngless-toolkit/ngless/releases/download/v1.4.0-beta1/ngless-v1.4.0-beta1-static)

This should work across a wide range of Linux versions (please
[report](https://github.com/ngless-toolkit/ngless/issues) any issues you encounter):

curl -L -O https://github.com/ngless-toolkit/ngless/releases/download/v1.1.1/NGLess-1.1.1-static-Linux64
chmod +x NGLess-1.1.1-static-Linux64
./NGLess-1.1.1-static-Linux64

This download bundles bwa, samtools and megahit (also statically linked).

If you want to try one of ngless' builtin modules (motus, specI, ...) you can
download [the full nighly build zip
file](https://gitlab.com/ngless/ngless/builds/artifacts/master/download?job=build-and-test-ubuntu)
which includes them.


## Windows

NGLess [cannot currently compile on
Windows](https://github.com/ngless-toolkit/ngless/issues/39).
curl -L -O https://github.com/ngless-toolkit/ngless/releases/download/v1.4.0-beta1/ngless-v1.4.0-beta1-static
chmod +x ngless-v1.4.0-beta1-static
./ngless-v1.4.0-beta1-static

<!--
This downloaded file bundles bwa, samtools and megahit (also statically linked).

Download and run the [Windows
Installer](https://ngless.embl.de/releases/ngless-0.5.1-Windows.exe)
The result is a command line utility, so you need to run it on the command
line. After running the installer, typing `ngless` on the terminal should work
as the installer will add the right directories to the path variable; you may
have to start a new terminal, though. It should also work under Cygwin (but
Cygwin is **not** a dependency).
The Windows package includes [bwa](http://bio-bwa.sourceforge.net/) and
[samtools](http://www.htslib.org/). The bwa and samtools executables are
available as `ngless-0.5.1-bwa` and `ngless-0.5.1-samtools`, respectively. It
has been tested on Windows 10, but this has not had as intensitive testing as
the Linux/Mac OS X versions so any [bug
reports](https://github.com/ngless-toolkit/ngless/issues) are appreciated.
-->

## From source

Expand All @@ -79,22 +51,6 @@ The following sequence of commands should download and build the software
The first time you run this, it will take a while as it will download all
dependencies. After this ngless is ready to use!

## With Nix

If you use [nix](https://nixos.org), you can easily build and install ngless
using it (these scripts also install all necessary dependencies):

nix-env -i -f https://github.com/luispedro/ngless-nix/archive/master.tar.gz

This should download the nix scripts and build ngless.

If you prefer, you can also first clone the repository:

git clone https://github.com/luispedro/ngless-nix
cd ngless-nix
# inspect the default.nix & ngless.nix files if you wish
nix-env -i -f .

## Make targets

The following are targets in the Makefile.
Expand Down

0 comments on commit 959b4d2

Please sign in to comment.