Skip to content

Commit 959b4d2

Browse files
committed
DOC Update install versions
1 parent 2d73f23 commit 959b4d2

File tree

1 file changed

+13
-57
lines changed

1 file changed

+13
-57
lines changed

docs/sources/install.md

Lines changed: 13 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,39 @@
11
# Installation
22

3-
43
## Bioconda (binary)
54

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

98
conda install -c bioconda ngless
109

10+
This will install the most recent released version
11+
1112
### Docker
1213

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

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

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

2022

2123
## Linux (binary)
2224

23-
You can get a [statically linked version of NGless
24-
1.1.1](https://github.com/ngless-toolkit/ngless/releases/download/v1.1.1/NGLess-1.1.1-static-Linux64)
25-
or a [nighly build of the latest development
26-
code](https://gitlab.com/ngless/ngless/builds/artifacts/master/raw/bin/ngless?job=build-and-test-ubuntu).
25+
You can download a [statically linked version of NGless
26+
1.4.0-beta](https://github.com/ngless-toolkit/ngless/releases/download/v1.4.0-beta1/ngless-v1.4.0-beta1-static)
27+
2728
This should work across a wide range of Linux versions (please
2829
[report](https://github.com/ngless-toolkit/ngless/issues) any issues you encounter):
2930

30-
curl -L -O https://github.com/ngless-toolkit/ngless/releases/download/v1.1.1/NGLess-1.1.1-static-Linux64
31-
chmod +x NGLess-1.1.1-static-Linux64
32-
./NGLess-1.1.1-static-Linux64
33-
34-
This download bundles bwa, samtools and megahit (also statically linked).
35-
36-
If you want to try one of ngless' builtin modules (motus, specI, ...) you can
37-
download [the full nighly build zip
38-
file](https://gitlab.com/ngless/ngless/builds/artifacts/master/download?job=build-and-test-ubuntu)
39-
which includes them.
40-
41-
42-
## Windows
43-
44-
NGLess [cannot currently compile on
45-
Windows](https://github.com/ngless-toolkit/ngless/issues/39).
31+
curl -L -O https://github.com/ngless-toolkit/ngless/releases/download/v1.4.0-beta1/ngless-v1.4.0-beta1-static
32+
chmod +x ngless-v1.4.0-beta1-static
33+
./ngless-v1.4.0-beta1-static
4634

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

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

6638
## From source
6739

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

82-
## With Nix
83-
84-
If you use [nix](https://nixos.org), you can easily build and install ngless
85-
using it (these scripts also install all necessary dependencies):
86-
87-
nix-env -i -f https://github.com/luispedro/ngless-nix/archive/master.tar.gz
88-
89-
This should download the nix scripts and build ngless.
90-
91-
If you prefer, you can also first clone the repository:
92-
93-
git clone https://github.com/luispedro/ngless-nix
94-
cd ngless-nix
95-
# inspect the default.nix & ngless.nix files if you wish
96-
nix-env -i -f .
97-
9854
## Make targets
9955

10056
The following are targets in the Makefile.

0 commit comments

Comments
 (0)