Skip to content

Commit 8326777

Browse files
committed
Update installation.rst
1 parent 1a50518 commit 8326777

File tree

1 file changed

+44
-27
lines changed

1 file changed

+44
-27
lines changed

docs/getting_started/installation.rst

Lines changed: 44 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,11 @@
11
Installation
22
============
33

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+
----------------------
116

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.
299

3010
All components of LMAS are executed in docker containers, which means that you’ll need to have a container engine
3111
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:
3717
If you already have any one of these installed, you are good to go as the provided docker containers are compatible
3818
with all engines available. If not, you’ll need to install one.
3919

40-
4120
Singularity
4221
:::::::::::
4322

@@ -61,8 +40,46 @@ https://www.docker.com/community-edition#/download.
6140
To run docker as a non-root user, you'll need to follow the instructions
6241
on the website: https://docs.docker.com/install/linux/linux-postinstall/#manage-docker-as-a-non-root-user
6342

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>`_
80+
81+
Step 2. Clone LMAS
82+
^^^^^^^^^^^^^^^^^^^^^^^^
6683

6784
You can clone this repository with git.
6885

0 commit comments

Comments
 (0)