You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://www.docker.com/)
10
13
[](https://sylabs.io/docs/)
11
14
[](https://github.com/NERSC/shifter/)
@@ -32,19 +35,7 @@ The *de novo* assembly of raw sequence data is a key process when analysing data
32
35
33
36
## Instalation
34
37
35
-
Before installing LMAS, a few dependencies must be installed in your system:
36
-
37
-
38
-
### Nextflow
39
-
40
-
Nextflow (version 20.01.0 or higher) can be used on any POSIX compatible system (Linux, OS X, etc). It requires BASH and
41
-
Java 8 (or higher) to be installed. More instructions are available [here](https://www.nextflow.io/docs/latest/getstarted.html).
42
-
43
-
44
-
### Container Engine
45
-
46
-
All components of LMAS are executed in docker containers, which means that you’ll need to have a container engine
47
-
installed. The container engines available are the ones supported by Nextflow:
38
+
All components of LMAS are executed in docker containers, which means that you’ll need to have a container engine installed. The container engines available are the ones supported by Nextflow:
@@ -53,23 +44,37 @@ installed. The container engines available are the ones supported by Nextflow:
53
44
If you already have any one of these installed, you are good to go as the provided docker containers are compatible
54
45
with all engines available. If not, you’ll need to install one.
55
46
47
+
### Conda
56
48
57
-
### Clone LMAS
49
+
LMAS can be easily installed through [Conda](https://conda.io/en/latest/), an open source package management system and environment management system that runs on Windows, macOS and Linux. After its installation, LMAS is available on [Bioconda](https://anaconda.org/bioconda/LMAS) and can be easily installed with:
58
50
59
-
You can clone this repository with `git clone [email protected]:cimendes/LMAS.git`, and all files will be in your local machine.
51
+
```bash
52
+
conda install -c bioconda lmas
53
+
```
54
+
55
+
### Manual installation
56
+
57
+
To install LMAS manually you'll first have to install nextflow.
58
+
#### Nextflow
59
+
60
+
Nextflow (version 20.01.0 or higher) can be used on any POSIX compatible system (Linux, OS X, etc). It requires BASH and
61
+
Java 8 (or higher) to be installed. More instructions are available [here](https://www.nextflow.io/docs/latest/getstarted.html).
60
62
63
+
#### Clone LMAS
64
+
65
+
You can clone this repository with `git clone [email protected]:cimendes/LMAS.git`, and all files will be in your local machine.
61
66
62
67
## Running LMAS
63
68
64
69
To run LMAS you can simply call it with:
65
70
66
-
./LMAS <options>
71
+
LMAS <options>
67
72
68
73
If no option or `--help` is provided, LMAS will display its help message. Otherwise, the `--fastq` and `--reference` options are mandatory. By default they are set to `'data/fastq/*_{1,2}.*'` and `'data/reference/*.fasta'` respectively.
69
74
70
75
Alternatively you can call LMAS directly with Nextflow:
71
76
72
-
nextflow run main.nf <options>
77
+
nextflow run main.nf <options>
73
78
74
79
To use LMAS the following options are available:
75
80
@@ -245,11 +250,11 @@ Simulated samples of the evenly and log distributed reads, with and without erro
245
250
246
251
After downloading the data you can simply run LMAS, with default parameters, with the following command:
Copy file name to clipboardExpand all lines: docs/getting_started/installation.rst
+44-27
Original file line number
Diff line number
Diff line change
@@ -1,31 +1,11 @@
1
1
Installation
2
2
============
3
3
4
-
LMAS can be installed through Github (https://github.com/cimendes/LMAS).
5
-
It requires a `Nextflow <https://www.nextflow.io/>`_ installation (version ≥ 21.04.1)
6
-
and can be used on any POSIX compatible system (Linux, OS X, etc). All components of LMAS are executed in `Docker containers <https://www.docker.com/>`_,
7
-
being a container engine required.
8
-
9
-
Nextflow allows integration with multiple alternatives, such as `Shifter <https://github.com/NERSC/shifter/>`_ or
10
-
`Singularity <https://singularity.hpcng.org/>`_, so a particular one isn’t required.
4
+
Container engine
5
+
----------------------
11
6
12
-
To ensure the robustness of LMAS workflow and the custom python code for the quality assessment of assemblies, **continuous integration** of both the main workflow
13
-
and the python templates is performed with `GitHub Actions <https://github.com/features/actions>`_ and `pytest <https://docs.pytest.org/en/6.2.x/>`_.
14
-
15
-
Below it's a step by step guide on how to install LMAS and all its dependencies.
16
-
17
-
Step 1. Nextflow
18
-
-----------------
19
-
20
-
`Nextflow <https://www.nextflow.io/>`_ (version 20.01.0 or higher) can be used on any POSIX compatible system (Linux, OS X, etc).
21
-
It requires BASH and Java 8 (or higher) to be installed.
22
-
23
-
.. important::
24
-
25
-
Instructions on how to install Nextflow are available `here <https://www.nextflow.io/docs/latest/getstarted.html>`_
26
-
27
-
Step 2. Container engine
28
-
-------------------------
7
+
All components of LMAS are executed in docker containers, which means that you’ll need to have a container engine installed.
8
+
The container engines available are the ones supported by Nextflow.
29
9
30
10
All components of LMAS are executed in docker containers, which means that you’ll need to have a container engine
31
11
installed. The container engines available are the ones supported by Nextflow:
@@ -37,7 +17,6 @@ installed. The container engines available are the ones supported by Nextflow:
37
17
If you already have any one of these installed, you are good to go as the provided docker containers are compatible
38
18
with all engines available. If not, you’ll need to install one.
To run docker as a non-root user, you'll need to follow the instructions
62
41
on the website: https://docs.docker.com/install/linux/linux-postinstall/#manage-docker-as-a-non-root-user
63
42
64
-
Step 3. Clone LMAS
65
-
-------------------
43
+
44
+
Installation through conda
45
+
----------------------------
46
+
47
+
LMAS can be easily installed through `Conda<https://conda.io/en/latest/>`_, an open source package management
48
+
system and environment management system that runs on Windows, macOS and Linux.
49
+
After its installation, LMAS is available on `Bioconda<https://anaconda.org/bioconda/LMAS>`_ and can be easily installed with:
50
+
51
+
.. code-block:: bash
52
+
53
+
conda install -c bioconda lmas
54
+
55
+
Manual installation
56
+
--------------------------
57
+
58
+
LMAS can be installed through Github (https://github.com/cimendes/LMAS).
59
+
It requires a `Nextflow <https://www.nextflow.io/>`_ installation (version ≥ 21.04.1)
60
+
and can be used on any POSIX compatible system (Linux, OS X, etc). All components of LMAS are executed in `Docker containers <https://www.docker.com/>`_,
61
+
being a container engine required.
62
+
63
+
Nextflow allows integration with multiple alternatives, such as `Shifter <https://github.com/NERSC/shifter/>`_ or
64
+
`Singularity <https://singularity.hpcng.org/>`_, so a particular one isn’t required.
65
+
66
+
To ensure the robustness of LMAS workflow and the custom python code for the quality assessment of assemblies, **continuous integration** of both the main workflow
67
+
and the python templates is performed with `GitHub Actions <https://github.com/features/actions>`_ and `pytest <https://docs.pytest.org/en/6.2.x/>`_.
68
+
69
+
Below it's a step by step guide on how to install LMAS and all its dependencies.
70
+
71
+
Step 1. Nextflow
72
+
^^^^^^^^^^^^^^^^^
73
+
74
+
`Nextflow <https://www.nextflow.io/>`_ (version 20.01.0 or higher) can be used on any POSIX compatible system (Linux, OS X, etc).
75
+
It requires BASH and Java 8 (or higher) to be installed.
76
+
77
+
.. important::
78
+
79
+
Instructions on how to install Nextflow are available `here <https://www.nextflow.io/docs/latest/getstarted.html>`_
0 commit comments